JCClient类 参考

全局基础类，主要负责登陆登出管理及账户属性存储 更多...

构造函数
(bool)	- login:password:
	登陆 Juphoon Cloud 平台，只有登陆成功后才能进行平台上的各种业务 更多...
(bool)	- login:password:loginParam:
(bool)	- relogin:password:
	重登录，该接口在如果有其他同类型终端登录着则会登录失败，一般用于记住了账号后重启自动登录逻辑 更多...
(bool)	- logout
(void)	- setForeground:
	设置是否是前台，当应用进入前台标志为true，进入后台标志为false 更多...
(void)	- destroy
	销毁接口
(int)	- sendOnlineMessage:userId:

类方法
(JCClient *_Nullable)	+ create:extraParams:
	创建 JCClient 实例 更多...

属性
NSString *_Nullable	userId
	用户标识 更多...
NSString *_Nullable	displayName
	昵称，用于通话，消息等，可以更直观的表明身份
NSString *_Nullable	appKey
	用户从 Juphoon RTC 平台上申请的 AppKey 字符串
NSString *_Nullable	server
	接入服务器地址
NSString *_Nullable	appName
	设置应用名称
JCClientState	state
	当前状态 更多...

详细描述

全局基础类，主要负责登陆登出管理及账户属性存储

函数文档

create:extraParams:

+ (JCClient* _Nullable) create:		(id< JCClientCallback > _Nonnull)	callback
extraParams:		(JCClientInitParam *_Nonnull)	initParam

创建 JCClient 实例

参数

callback	回调接口，用于接收 JCClient 相关通知
initParam	初始化参数，没有则填null

返回

JCClient 对象

login:password:

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

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

服务器分为鉴权模式和非鉴权模式

- 鉴权模式: 服务器会检查用户名和密码

- 免鉴权模式: 只要用户保证用户标识唯一即可, 服务器不校验

登陆结果通过 JCCallCallback 通知

参数

userId	用户名
password	密码，免鉴权模式密码可以随意输入，但不能为空

返回

返回 true 表示正常执行调用流程，false 表示调用异常，异常错误通过 JCClientCallback 通知

警告

目前只支持免鉴权模式，免鉴权模式下当账号不存在时会自动去创建该账号

用户名为英文数字和'+' '-' '_' '.'，长度不要超过64字符，'-' '_' '.'不能作为第一个字符

login:password:loginParam:

- (bool) login:		(NSString *_Nonnull)	userId
password:		(NSString *_Nonnull)	password
loginParam:		(JCClientLoginParam *_Nullable)	loginParam

登录 Juphoon RTC 平台

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

参数

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 RTC 平台，登出后不能进行平台上的各种业务

返回

返回 true 表示正常执行调用流程，false 表示调用异常，异常错误通过 JCClientCallback 通知

relogin:password:

- (bool) relogin:		(NSString *_Nonnull)	userId
password:		(NSString *_Nonnull)	password

重登录，该接口在如果有其他同类型终端登录着则会登录失败，一般用于记住了账号后重启自动登录逻辑

参数

password

密码，免鉴权模式密码可以随意输入，但不能为空

返回

返回 true 表示正常执行调用流程，false 表示调用异常，异常错误通过 JCClientCallback 通知

sendOnlineMessage:userId:

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

发送在线消息

参数

message	消息内容
userId	对方的 id

返回

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

setForeground:

- (void) setForeground:

(bool)

foreground

设置是否是前台，当应用进入前台标志为true，进入后台标志为false

参数

foreground

true 是前台，false 是后台

属性说明

state

- (JCClientState) state

readnonatomicassign

当前状态

参见

JCClientState

userId

- (NSString* _Nullable) userId

readnonatomiccopy

用户标识

警告

当 state > JCClientStateIdle 该值有效