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

#import <JCClient.h>

类 JCClient 继承关系图:

构造函数

(bool) - login:password:
 ‪登陆 Juphoon Cloud 平台,只有登陆成功后才能进行平台上的各种业务 更多...
 
(bool) - login:accountType:account:password:
 ‪登陆 Juphoon Cloud 平台,只有登陆成功后才能进行平台上的各种业务 更多...
 
(bool) - relogin:password:
 ‪重登录,该接口在如果有其他同类型终端登录着则会登录失败,一般用于记住了账号后重启自动登录逻辑 更多...
 
(bool) - logout
 
(bool) - setConfig:value:
 ‪设置配置相关参数 JCClientConfigServer, JCClientConfigHttpsProxy 均需要在 login 之前调用 更多...
 
(NSString *) - getConfig:
 ‪获取配置相关参数 更多...
 
(void) - setForeground:
 ‪设置是否是前台,当应用进入前台标志为true,进入后台标志为false 更多...
 
(void) - addCallback:
 ‪设置回调 更多...
 
(void) - removeCallback:
 ‪删除回调 更多...
 
(void) - destroy
 ‪销毁接口 更多...
 

类方法

(JCClient *) + create:callback:extraParams:
 ‪创建 JCClient 实例 更多...
 

属性

NSString * userId
 ‪用户标识 更多...
 
NSString * displayName
 ‪昵称,用于通话,消息等,可以更直观的表明身份 更多...
 
JCClientState state
 ‪当前状态 更多...
 

详细描述

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

函数文档

◆ addCallback:

- (void) addCallback: (id< JCClientCallback >)  callback

‪设置回调

参数
callback‪回调接口,用于接收 JCClient 相关通知

◆ create:callback:extraParams:

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

‪创建 JCClient 实例

参数
appKey‪用户从 Juphoon Cloud 平台上申请的 AppKey 字符串
callback‪回调接口,用于接收 JCClient 相关通知
extraParams‪额外参数,没有则填nil,定义值参见 JCClientConstants 中 JCClientCreateExtra* 相关定义
返回
JCClient 对象

◆ destroy

- (void) destroy

‪销毁接口

◆ getConfig:

- (NSString*) getConfig: (NSString *)  key

‪获取配置相关参数

参数
key‪参数关键字, 参见 JCClientConstants 中定义
返回
‪成功返回字符串类型具体值, 失败返回 NULL

◆ login:accountType:account:password:

- (bool) login: (bool)  autologin
accountType: (NSString *)  accountType
account: (NSString *)  account
password: (NSString *)  password 

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

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

  • ‪鉴权模式: 服务器会检查用户名和密码
  • ‪免鉴权模式: 只要用户保证用户标识唯一即可, 服务器不校验

登陆结果通过 JCCallCallback 通知

参数
autologin‪是否自动登录
accountType‪账号类型,具体参考 JCAccountConstants.h 的定义(如 JCAccountTypePhone)
password‪密码,免鉴权模式密码可以随意输入,但不能为空
返回
‪返回 true 表示正常执行调用流程,false 表示调用异常,异常错误通过 JCClientCallback 通知
警告
‪用户名为英文数字和'+' '-' '_' '.',长度不要超过64字符,'-' '_' '.'不能作为第一个字符

◆ login:password:

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

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

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

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

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

登陆结果通过 JCCallCallback 通知

参数
userId‪用户名
password‪密码,免鉴权模式密码可以随意输入,但不能为空
返回
‪返回 true 表示正常执行调用流程,false 表示调用异常,异常错误通过 JCClientCallback 通知
警告
‪目前只支持免鉴权模式,免鉴权模式下当账号不存在时会自动去创建该账号
‪用户名为英文数字和'+' '-' '_' '.',长度不要超过64字符,'-' '_' '.'不能作为第一个字符

◆ logout

- (bool) logout

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

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

◆ relogin:password:

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

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

参数
password‪密码,免鉴权模式密码可以随意输入,但不能为空
返回
‪返回 true 表示正常执行调用流程,false 表示调用异常,异常错误通过 JCClientCallback 通知

◆ removeCallback:

- (void) removeCallback: (id< JCClientCallback >)  callback

‪删除回调

参数
callback‪回调接口,用于接收 JCClient 相关通知

◆ setConfig:value:

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

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

参数
key‪参数关键字, 参见 JCClientConstants 中定义
value‪参数值
返回
‪返回 true 表示设置成功,false 表示设置失败

◆ setForeground:

- (void) setForeground: (bool)  foreground

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

参数
foreground‪true 是前台,false 是后台

属性说明

◆ displayName

- (NSString*) displayName
readwritenonatomiccopy

‪昵称,用于通话,消息等,可以更直观的表明身份

◆ state

- (JCClientState) state
readnonatomicassign

‪当前状态

参见
JCClientState

◆ userId

- (NSString*) userId
readnonatomiccopy

‪用户标识

警告
‪当 state > JCClientStateIdle 该值有效

该类的文档由以下文件生成:
  • /Users/yangxiangkun/projects/JuphoonCloud/SDK/iOS/JMSDK/JMSDK/JCCommon/JCClient/JCClient.h