#include <JCClient.h>
◆ create:callback:createParam:
◆ 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 |
- 返回
- 调用是否成功
◆ logout
登出 Juphoon Cloud 平台
登出后不能进行平台上的各种业务
- 返回
- 调用是否成功
◆ relogin:password:loginParam:
- (bool) relogin: |
|
(NSString *__nonnull) |
userId |
password: |
|
(NSString *__nonnull) |
password |
loginParam: |
|
(JCClientLoginParam *__nullable) |
loginParam |
|
|
| |
重登录
该接口在如果有其他同类型终端登录着则会登录失败,一般用于记住了账号后重启自动登录逻辑,登录结果通过 onLogin
通知
- 注解
- 与 login 接口的区别:
- 同一设备类型登录同一账号,使用“登录”接口后,后登录的账号会把前面的账号踢下线
- 同一设备类型登录同一账号,使用“重登录”接口后,后登录的账号会登录失败,上报已有账号登录错误
- 同一账号不同设备类型,使用“登录”和“重登录”都能正常登录
- 参数
-
- 返回
- 调用是否成功
◆ 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
方法传入的
◆ arcChannel
◆ createParam
◆ displayName
- (NSString* __nullable) displayName |
|
readwritenonatomiccopy |
获取/设置自己的昵称
在发起呼叫、加入频道时、发送消息时,都会将自己的昵称发送给其他用户
- 注解
- 每次调用
create
初始化 SDK 后都需要重新设置
- 不支持 RTOS 设备
◆ loginParam
获取登录参数
得到的登录参数就是用户在调用 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
之前进行设置。
◆ serverUid
- (NSString* __nonnull) serverUid |
|
readnonatomicassign |
◆ state
◆ timeout
◆ userId
- (NSString* __nullable) userId |
|
readnonatomiccopy |
获取用户标识
得到的的用户标识就是用户在调用 login
方法时传入的 userId 参数
需要注意的是只有用户状态为登录中或已登录才能获取到值,其他状态将返回 nil
该类的文档由以下文件生成: