JCClient类 参考

#import <JCClient.h>

构造函数
(bool)	- login:password:
(bool)	- login:password:loginParam:
(bool)	- logout
(bool)	- setConfig:value:
(void)	- setAppkey:
(NSString *__nullable)	- getConfig:
(int)	- sendOnlineMessage:userId:

类方法
(JCClient *__nullable)	+ create:callback:extraParams:
(void)	+ destroy

属性
NSString *__nonnull	userId
NSString *__nonnull	displayName
JCClientState	state

详细描述

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

函数文档

create:callback:extraParams:

+ (JCClient* __nullable) create:		(NSString *__nonnull)	appKey
callback:		(id< JCClientCallback > __nonnull)	callback
extraParams:		(NSDictionary *__nullable)	extraParams

创建 JCClient 对象

JCClient 的所有接口函数，如无特殊说明，都建议在主线程调用

注解

• 请确保在调用其他 API 前先调用该方法创建并初始化 JCClient 对象
• 调用此方法创建 JCClient 对象后，期间没有调用过 destroy 方法销毁对象，然后又重复调用此方法，会直接返回第一次创建的 JCClient 对象

参数

appKey	用户从 Juphoon Cloud 平台上申请的 AppKey 字符串
callback	JCClientCallback 对象，用于回调相关通知
extraParams	额外参数，没有则填null。传 null 则使用默认值

返回

JCClient 对象

异常

appKey、JCClientCallback 任意一个参数传空就会返回 nil

destroy

+ (void) destroy

销毁 JCClient 对象

注解

在调用此方法后不能马上调用 create 方法去重新创建 JCClient 对象

getConfig:

- (NSString* __nullable) getConfig:

(NSString *__nonnull)

key

获取配置相关参数

参数

key

参数关键字,

参见

JCClientConstants 中定义

返回

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

login:password:

- (bool) login:		(NSString *__nonnull)	userId
password:		(NSString *__nonnull)	password

登录 Juphoon Cloud 平台

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

参数

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

返回

调用是否成功

• true：正常执行调用流程，登录结果通过 onLogin 通知
• false：调用异常，不会收到 onLogin 通知

login:password:loginParam:

- (bool) login:		(NSString *__nonnull)	userId
password:		(NSString *__nonnull)	password
loginParam:		(JCClientLoginParam *__nullable)	loginParam

登录 Juphoon Cloud 平台

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

参数

userId	用户名，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 66 个字符）： 26 个小写英文字母 a-z 26 个大写英文字母 A-Z 10 个数字 0-9 '+'，'-'，'_'，'.'。另外 '-'，'_'，'.' 这三个字符不能处于用户名的第一位
password	密码，不能为 nil 或 ""，长度不能超过 128 字符
loginParam	登录参数，一般不需要设置，如需设置请询问客服，传 nil 则按默认值，详见 JCClientLoginParam

返回

调用是否成功

• true：正常执行调用流程，登录结果通过 onLogin 通知
• false：调用异常，不会收到 onLogin 通知

logout

- (bool) logout

登出 Juphoon Cloud 平台

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

返回

调用是否成功

• true：正常执行调用流程，登出结果通过 onLogout 通知
• false：调用失败，不会收到 onLogout 通知

sendOnlineMessage:userId:

- (int) sendOnlineMessage:		(NSString *__nonnull)	message
userId:		(NSString *__nonnull)	userId

发送在线消息

参数

message	消息内容
userId	对方的 id

返回

成功返回整型的相应的 消息 id，收到onOnlineMessageSendResult的通知 失败返回 -1 不会收到onOnlineMessageSendResult的通知

setAppkey:

- (void) setAppkey:

(NSString *__nonnull)

appKey

设置appkey

参数

appKey

appKey

setConfig:value:

- (bool) setConfig:		(NSString *__nonnull)	key
value:		(NSString *__nonnull)	value

设置配置相关参数 JCClientConfigServer, JCClientConfigHttpsProxy 均需要在 login 之前调用

参数

key

参数关键字,

参见

JCClientConstants 中定义

参数

value

参数值

返回

调用是否成功

• true：表示设置成功
• false：表示设置失败

属性说明

displayName

- (NSString* __nonnull) displayName

readwritenonatomiccopy

获取/设置自己的昵称

以下情况时，都会将自己的昵称发送给其他用户：

• 调用 call 发起呼叫时
• 调用 sendMessage 发送消息时
• 调用 sendMessage 发送消息时
• 调用 join 加入频道时

注解

每次调用 create 初始化 SDK 后都需要重新设置

state

- (JCClientState) state

readnonatomicassign

获取当前登录状态

• JCClientStateNotInit : 未初始化
• JCClientStateIdle : 未登录
• JCClientStateLogining : 登录中
• JCClientStateLogined : 登录成功
• JCClientStateLogouting : 登出中

userId

- (NSString *) userId

readnonatomiccopy

获取用户标识

返回的的用户标识就是用户在调用 login 方法时传入的 userId 参数
需要注意的是只有用户状态为登录中或已登录才能获取到值，其他状态将返回 nil