Class JRTCClient

登录登出管理

Methods

create destroy getUserId getState getDisplayName setDisplayName getServer setServer getAppKey setAppKey getAppName setAppName login logout sendOnlineMessage

Methods

Static create

  • create(callback, initParam?): undefined | JRTCClient

  • 创建 JRTCClient 实例

    Parameters

    Returns undefined | JRTCClient

    JRTCClient 对象

    Throws

    Error "初次创建时 JRTCClientCallback 参数传空就会创建失败"

Static destroy

  • destroy(): void

  • 销毁 JRTCClient 对象

    Returns void

    Note

    • 调用此方法后，你将无法再使用 JRTCClient 的其他方法和回调
    • 我们不建议在JRTCSDK的回调中调用此方法销毁 JRTCClient 对象，否则可能出现崩溃

getUserId

  • getUserId(): undefined | string

  • 获取用户ID

    Returns undefined | string

    用户ID

    Note

    当 state > IDLE 该值有效

getState

getDisplayName

  • getDisplayName(): undefined | string

  • 获取用户昵称，用于通话，消息等，可以更直观的表明身份, 默认为用户ID，即 userId

    Returns undefined | string

    当前昵称

setDisplayName

  • setDisplayName(displayName): void

  • 设置用户昵称，用于通话，消息等，可以更直观的表明身份，默认为用户ID，即 userId

    Parameters

    • displayName: undefined | string

    Returns void

getServer

  • getServer(): undefined | string

  • 获取接入服务器地址

    Returns undefined | string

setServer

  • setServer(server): void

  • 设置接入服务器地址

    Parameters

    • server: undefined | string

    Returns void

getAppKey

  • getAppKey(): undefined | string

  • 获取 AppKey，用户从 Juphoon RTC 平台上申请的 AppKey 字符串

    Returns undefined | string

setAppKey

  • setAppKey(appKey): void

  • 设置 AppKey，用户从 Juphoon RTC 平台上申请的 AppKey 字符串

    Parameters

    • appKey: undefined | string

    Returns void

getAppName

  • getAppName(): undefined | string

  • 获取应用名称

    Returns undefined | string

setAppName

  • setAppName(appName): void

  • 设置应用名称

    Parameters

    • appName: undefined | string

    Returns void

login

  • login(userId, password, clientLoginParam?): boolean

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

    登录结果通过 onLogin 回调通知

    Parameters

    • userId: string

      用户ID

    • password: string

      密码，不能为空

    • Optional clientLoginParam: JRTCClientLoginParam

      登录参数，一般不需要设置，不设置则按默认值

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

    Note

    目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号

    Note

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

logout

  • logout(): boolean

  • 登出 Juphoon RTC 平台，登出后不能进行平台上的各种业务

    登出结果通过 onLogout 回调通知

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用异常

sendOnlineMessage

  • sendOnlineMessage(message, userId): number

  • 发送在线消息

    Parameters

    • message: string

      消息内容

    • userId: string

      对端的用户名

    Returns number

    接口调用结果

    • 操作id: 接口调用成功，对应 onOnlineMessageSendResult 回调的 operatorId 参数
    • -1: 接口调用异常，不会收到回调

    Note

    消息大小不超过4k

设置

主题

Generated using TypeDoc