用于初始化sdk以及登录Juphoon Cloud平台更多...

Public 成员函数
bool	Login (string username, string password)
	登陆 Juphoon Cloud 平台只有登陆成功后才能进行平台上的各种业务更多...

bool	Login (string username, string password, JCClientLoginParam param)
	登陆 Juphoon Cloud 平台只有登陆成功后才能进行平台上的各种业务更多...

int	SendOnlineMessage (string message, string userId)
	发送在线消息更多...

bool	Logout ()
	登出 Juphoon Cloud 平台登出后不能进行平台上的各种业务更多...

bool	SetConfig (string key, string value)
	设置登录相关属性 CONFIG_KEY_SERVER_ADDRESS, CONFIG_KEY_HTTPS_PROXY 均需要在 login 之前调用更多...

string	GetConfig (string key)
	获取设置属性的值更多...

bool	IsSelf (string userId)
	是否为自己更多...

void	SetAppkey (string appkey)
	appkey动态设置更多...

void	OnNetChange (int newNetType, int oldNetType)

静态 Public 成员函数
static JCClient	Create (Application app, string appKey, JCClientCallback callback, Dictionary< string, string > extraParams)
	创建 JCClient 实例，OCX插件需初始化在主线程 JCClient 的所有接口函数，如无特殊说明，都建议在主线程调用更多...

static void	Destroy ()
	销毁 JCClient 实例该方法为同步调用，需要等待 JCClient 实例资源释放后才能执行其他方法，调用此方法后，你将无法再使用 JCClient 的其他方法和回调我们不建议在 JCSDK 的回调中调用此方法销毁 JCClient 对象，否则会引起崩溃如需在销毁后再次创建 JCClient 实例，需要等待Destroy 方法执行结束后再创建实例更多...

Public 属性
Action< string, string, int >	MtcNotify
	调用Mtc接口时，对应的通知。第一个参数通知name，第二个参数通知携带的信息，第三个cookie。更多...

属性
string	DisplayName `[get, set]`

string	UserId `[get]`

JCClientState	State `[get]`

Application	App `[get]`

详细描述

用于初始化sdk以及登录Juphoon Cloud平台

成员函数说明

◆ Create()

static JCClient JCSDK.JCClient.JCClient.Create	(	Application	app,
		string	appKey,
		JCClientCallback	callback,
		Dictionary< string, string >	extraParams
	)

static

创建 JCClient 实例，OCX插件需初始化在主线程 JCClient 的所有接口函数，如无特殊说明，都建议在主线程调用

- 请确保在调用其他 API 前先调用该方法创建并初始化 JCClient 对象

调用此方法创建 JCClient 对象后，期间没有调用过 Destroy 方法销毁对象，然后又重复调用此方法，会直接返回第一次创建的 JCClient 对象

参数

appKey	用户从 Juphoon Cloud 平台上创建应用获取的 AppKey 字符串
callback	JCClientCallback 对象，用于回调相关通知
extraParams	额外参数，没有则填null。key值参见 JCClientConstants 中 JCClientCreateExtra 相关定义。传 null 则使用默认值
app	创建实例依赖的程序APP

返回: 创建成功则返回创建的实例，否则返回null

context、appKey、JCClientCallback 任意参数传空就会抛出异常

◆ Destroy()

static void JCSDK.JCClient.JCClient.Destroy ( )

static

销毁 JCClient 实例该方法为同步调用，需要等待 JCClient 实例资源释放后才能执行其他方法，调用此方法后，你将无法再使用 JCClient 的其他方法和回调我们不建议在 JCSDK 的回调中调用此方法销毁 JCClient 对象，否则会引起崩溃如需在销毁后再次创建 JCClient 实例，需要等待Destroy 方法执行结束后再创建实例

◆ GetConfig()

string JCSDK.JCClient.JCClient.GetConfig ( string key )

获取设置属性的值

参数

key 参数关键字

返回: 成功返回字符串类型的相应参数关键字的具体值, 失败返回 NULL

◆ IsSelf()

bool JCSDK.JCClient.JCClient.IsSelf ( string userId )

是否为自己

参数

userId 用户标识

返回

是否为自己

true：为自己
false：不是自己

◆ Login() [1/2]

bool JCSDK.JCClient.JCClient.Login	(	string	username,
		string	password
	)

登陆 Juphoon Cloud 平台只有登陆成功后才能进行平台上的各种业务

- 调用成功后登录结果通过 OnLogin 通知

当用户不存在时会自动创建该用户
注意:用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符, '-' '_' '.'不能作为首字符

参数

username	用户名，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 66 个字符）： 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 '+'，'-'，'_'，'.'。另外 '-'，'_'，'.' 这三个字符不能处于用户名的第一位
password	密码，不能为 null 或 ""，长度不能超过 128 字符

返回

调用是否成功

true：表示正常执行调用流程
false：表示调用异常

◆ Login() [2/2]

bool JCSDK.JCClient.JCClient.Login	(	string	username,
		string	password,
		JCClientLoginParam	param
	)

登陆 Juphoon Cloud 平台只有登陆成功后才能进行平台上的各种业务

- 调用成功后登录结果通过 OnLogin 通知

当用户不存在时会自动创建该用户
注意:用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符, '-' '_' '.'不能作为首字符

参数

username	用户名，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 66 个字符）： 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 '+'，'-'，'_'，'.'。另外 '-'，'_'，'.' 这三个字符不能处于用户名的第一位
password	密码，不能为 null 或 ""，长度不能超过 128 字符
param	登录校验参数

返回

调用是否成功

true：表示正常执行调用流程
false：表示调用异常

◆ Logout()

bool JCSDK.JCClient.JCClient.Logout ( )

登出 Juphoon Cloud 平台登出后不能进行平台上的各种业务

结果通过OnLogout 通知

返回

调用是否成功

true：表示正常执行调用流程
false：表示调用异常

◆ SendOnlineMessage()

int JCSDK.JCClient.JCClient.SendOnlineMessage	(	string	message,
		string	userId
	)

发送在线消息

调用成功后收到OnOnlineMessageSendResult 的通知

参数

userId	对端用户 id
message	消息内容，透传

返回

调用是否成功

成功返回整型的相应的消息id
失败返回 -1

◆ SetAppkey()

void JCSDK.JCClient.JCClient.SetAppkey ( string appkey )

appkey动态设置

参数

appkey APPKey内容

◆ SetConfig()

bool JCSDK.JCClient.JCClient.SetConfig	(	string	key,
		string	value
	)

设置登录相关属性 CONFIG_KEY_SERVER_ADDRESS, CONFIG_KEY_HTTPS_PROXY 均需要在 login 之前调用

参数

key	参数关键字
value	参数具体值

返回

设置是否成功

ture：表示设置成功
false：设置失败

类成员变量说明

◆ MtcNotify

Action<string, string, int> JCSDK.JCClient.JCClient.MtcNotify

调用Mtc接口时，对应的通知。第一个参数通知name，第二个参数通知携带的信息，第三个cookie。

属性说明

◆ App

Application JCSDK.JCClient.JCClient.App

get

Application实例

◆ DisplayName

string JCSDK.JCClient.JCClient.DisplayName

getset

昵称，用于通话，消息等，可以更直观的标明身份调用 Join 加入频道时，都会将自己的昵称发送给其他用户。以下是各场景获取对方昵称的方法：

通话场景获取对方昵称：getDisPlayName
会议频道场景获取对方昵称：getDisPlayName 每次调用 Create 方法初始化 SDK 后都需要重新设置

◆ State

JCClientState JCSDK.JCClient.JCClient.State

get

当前状态

◆ UserId

string JCSDK.JCClient.JCClient.UserId

get

用户标识，当 state > JCClientState.Idle 该值有效

该类的文档由以下文件生成:

JCClient/JCClient.cs

Public 成员函数

静态 Public 成员函数

Public 属性

属性

详细描述

成员函数说明

◆ Create()

◆ Destroy()

◆ GetConfig()

◆ IsSelf()

◆ Login() [1/2]

◆ Login() [2/2]

◆ Logout()

◆ SendOnlineMessage()

◆ SetAppkey()

◆ SetConfig()

类成员变量说明

◆ MtcNotify

属性说明

◆ App

◆ DisplayName

◆ State

◆ UserId