JCClient类 参考

构造函数
(bool)	- login:password:loginParam:
(bool)	- logout
(int)	- sendOnlineMessage:content:

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

属性
NSString *__nonnull	userId
NSString *__nonnull	displayName
JCClientState	state
JCClientCreateParam *__nullable	createParam
JCClientLoginParam *__nullable	loginParam
NSString *__nonnull	appkey
NSString *__nonnull	serverAddress

详细描述

全局基础类

主要负责登录登出管理及账户属性存储

函数文档

create:callback:createParam:

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

创建 JCClient 对象

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

注解

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

参数

appKey	用户从 Juphoon Cloud 平台上申请的 AppKey 字符串。详见 获取 appKey
callback	JCClientCallback 对象，用于回调相关通知
createParam	创建参数，传入 nil 则按默认值创建，详见 JCClientCreateParam

返回

JCClient 对象

异常

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

destroy

+ (void) destroy

销毁 JCClient 对象

该方法为同步调用，需要等待 JCClient 实例资源释放后才能执行其他操作，调用此方法后，你将无法再使用 SDK 的其它方法和回调。
此模块为基础模块，所以需要在销毁其他模块的对象后，再调用此方法来销毁 JCClient 对象。此外，我们 不建议 在 JCSDK 的回调中调用此方法销毁 JCClient 对象，否则会出现崩溃。
如需在销毁后再次创建 JCClient 实例，需要等待 destroy 方法执行结束后再创建实例。

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 字符。免鉴权模式密码可以随意输入，Token 鉴权模式密码需要输入外部生成的 Token
loginParam	登录参数，一般不需要设置，如需设置请询问客服，传 nil 则按默认值，详见 JCClientLoginParam

返回

调用是否成功

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

logout

- (bool) logout

登出 Juphoon Cloud 平台

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

返回

调用是否成功

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

sendOnlineMessage:content:

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

发送在线消息

消息发送结果通过 onOnlineMessageSendResult 通知

注解

• 当前对方只有在线才能收到此消息
• 此接口调用频次限制 100次/分钟

参数

userId	对方的 userId
content	要发送的消息内容

返回

• >0：成功返回操作id，与回调中的 operationId 一致
• -1：失败，不会触发消息发送结果回调

属性说明

appkey

- (NSString* __nonnull) appkey

readnonatomicassign

获取appkey

得到的appkey是由 create 方法传入的

createParam

- (JCClientCreateParam* __nullable) createParam

readnonatomicassign

获取创建参数

得到的创建参数就是用户在调用 create 方法时传入的 createParam 参数
若用户在调用 create 方法时，createParam 传入了 nil，则返回默认的 JCClientCreateParam 对象

displayName

- (NSString* __nonnull) displayName

readwritenonatomiccopy

获取/设置自己的昵称

在发起呼叫、加入频道时、发送消息时，都会将自己的昵称发送给其他用户

注解

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

loginParam

- (JCClientLoginParam* __nullable) loginParam

readnonatomicassign

获取登录参数

得到的登录参数就是用户在调用 login 方法时传入的 loginParam 参数
若用户在调用 login 方法时， loginParam 传入了 nil，则将返回默认的 JCClientLoginParam 对象
需要注意的是只有用户状态为登录中或已登录时才能获取到值，其他状态将返回 nil

serverAddress

- (NSString* __nonnull) serverAddress

readwritenonatomiccopy

获取/设置登录服务器地址

默认地址为 http:cn.router.justalkcloud.com:8080（国内环境）。如果是海外用户需要设置为 http:intl.router.justalkcloud.com:8080（国际环境）
该属性需要在调用登录方法 login 之前进行设置。

state

- (JCClientState) state

readnonatomicassign

获取当前登录状态

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

userId

- (NSString* __nonnull) userId

readnonatomiccopy

获取用户标识

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

---

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

• JCSDKOC/JCSDKOC/JCClient/JCClient.h