Class JCClientAbstract

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

Methods

addCallback getAppkey getContext getCreateParam getDisplayName getLoginParam getServerAddress getServerUid getState getUserId login logout relogin removeCallback sendOnlineMessage setDisplayName setForeground setServerAddress create destroy

Methods

AbstractaddCallback

  • addCallback(callback): void

  • 添加回调

    Parameters

    Returns void

AbstractgetAppkey

  • getAppkey(): string

  • 获取Appkey

    返回的Appkey是由 create 方法传入的

    Returns string

    Appkey

AbstractgetContext

  • getContext(): Context

  • 获得上下文

    Returns Context

    返回 Context 对象

AbstractgetCreateParam

  • getCreateParam(): CreateParam

  • 获取创建参数

    返回的创建参数就是用户在调用 create 方法时传入的 CreateParam 参数，若用户在调用 create 方法时，CreateParam 传入了 undefined，则返回默认的 CreateParam 对象

    Returns CreateParam

    CreateParam 创建参数对象

AbstractgetDisplayName

  • getDisplayName(): string

  • 获取自己的昵称

    Returns string

    自己的昵称

AbstractgetLoginParam

  • getLoginParam(): LoginParam

  • 获取登录参数

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

    Returns LoginParam

    LoginParam 登录参数对象

AbstractgetServerAddress

  • getServerAddress(): string

  • 获取登录服务器地址

    返回的登录地址就是用户在调用 setServerAddress 方法时传入的 serverAddress 参数，若用户未调用 setServerAddress 方法，将返回默认国内地址 http:cn.router.justalkcloud.com:8080

    Returns string

    登录服务器地址

AbstractgetServerUid

  • getServerUid(): string

  • 获取自己在服务器上的 uid

    Returns string

    自己在服务器上的 uid

AbstractgetState

AbstractgetUserId

  • getUserId(): string

  • 获得用户标识

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

    Returns string

    用户标识

Abstractlogin

  • login(userId, password, loginParam): boolean

  • 登录 Juphoon Cloud 平台

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

    Parameters

    • userId: string

      用户名，长度在 64 字节以内的字符串。以下为支持的字符集范围（共 66 个字符）：

      • 26 个小写英文字母 a-z
      • 26 个大写英文字母 A-Z
      • 10 个数字 0-9
      • '+'，'-'，''，'.'。另外 '-'，''，'.' 这三个字符不能处于用户名的第一位
    • password: string

      密码，不能为 undefined 或 ""，长度不能超过 128 字符。免鉴权模式密码可以随意输入，Token 鉴权模式密码需要输入外部生成的 Token

    • loginParam: LoginParam

      登录参数，传 undefined 则按默认值。一般不需要设置，如需设置请询问客服，详细定义见 LoginParam

    Returns boolean

    调用是否成功

    Remarks

    • 用户名区分大小写

Abstractlogout

  • logout(): boolean

  • 登出 Juphoon Cloud 平台

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

    Returns boolean

    调用是否成功

Abstractrelogin

  • relogin(userId, password, loginParam): boolean

  • 重登录

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

    Parameters

    • userId: string

      用户名

    • password: string

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

    • loginParam: LoginParam

      登录参数，用于指定https代理地址、设备id、是否自动创建账号、终端类型，undefined 则按默认值。详见 LoginParam

    Returns boolean

    调用是否成功

    • true：正常执行调用流程
    • false：调用失败

    Remarks

    与 login 接口的区别：

    • 同一设备类型登录同一账号，使用“登录”接口后，后登录的账号会把前面的账号踢下线
    • 同一设备类型登录同一账号，使用“重登录”接口后，后登录的账号会登录失败，上报已有账号登录错误
    • 同一账号不同设备类型，使用“登录”和“重登录”都能正常登录
    • 用户名区分大小写

AbstractremoveCallback

  • removeCallback(callback): void

  • 删除回调

    Parameters

    Returns void

AbstractsendOnlineMessage

  • sendOnlineMessage(userId, content): number

  • 发送在线消息

    消息发送结果通过 JCClientCallback#onOnlineMessageSendResult 通知

    Parameters

    • userId: string

      对方的 userId

    • content: string

      要发送的消息内容

    Returns number

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

    Remarks

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

AbstractsetDisplayName

  • setDisplayName(displayName): any

  • 设置自己的昵称

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

    Parameters

    • displayName: string

      要设置的昵称

    Returns any

    Remarks

    • 每次调用 create 方法初始化 SDK 后都需要重新设置
    • 不支持 IOT 设备

AbstractsetForeground

  • setForeground(foreground): any

  • 是否设置为前台

    应用进入前台或进入后台都需要调用此方法进行设置。应用进入后台时调用此方法设置为后台，可以优化数据链路从而减少耗电量

    Parameters

    • foreground: boolean

      是否设置为前台

      • true: 设置为前台
      • false: 设置为后台

    Returns any

    Remarks

    如果设置为后台后收到通话或者消息内部会重置为前台,当通话结束或者消息收完后需要上层重新设置为后台

AbstractsetServerAddress

  • setServerAddress(serverAddress): any

  • 设置登录服务器地址

    Parameters

    Returns any

Staticcreate

  • create(context, appKey, callback, createParam): JCClient

  • 创建 JCClient 对象

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

    Parameters

    • context: Context

      上下文句柄

    • appKey: string

      用户从 Juphoon Cloud 平台上创建应用获取的 AppKey 字符串，详见获取 appKey

    • callback: JCClientCallback

      JCClientCallback 对象，用于回调相关通知

    • createParam: CreateParam

      创建参数，详细定义见 CreateParam。传 undefined 则使用默认值

    Returns JCClient

    JCClient 对象

    Remarks

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

    Throws

    "context、appKey、JCClientCallback 任意参数传空就会抛出异常"

Staticdestroy

  • destroy(): void

  • 销毁 JCClient 对象

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

    Returns void

Settings

Member Visibility

On This Page

Methods