Class JRTCClientAbstract

基础模块管理 JRTCClient

Methods

create destroy setForeground getUserId getState getDisplayName setDisplayName getServer setServer getAppKey setAppKey getAppName setAppName login logout sendOnlineMessage requestFileUploadInfo completeFileUpload getUploadFileInfo

Methods

Staticcreate

  • create(
        applicationContext: ApplicationContext,
        callback: JRTCClientCallback,
        initParam?: JRTCClientInitParam,
    ): JRTCClient

    创建 JRTCClient 实例

    Parameters

    • applicationContext: ApplicationContext

      应用上下文对象

    • callback: JRTCClientCallback

      回调接口，用于接收 JRTCClient 相关通知

    • OptionalinitParam: JRTCClientInitParam

      初始化参数，不设置则用默认值

    Returns JRTCClient

    JRTCClient 对象

Staticdestroy

  • destroy(): void

    销毁 JRTCClient 对象

    Returns void

    Remarks

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

AbstractsetForeground

  • setForeground(foreground: boolean): void

    设置是否是前台

    Parameters

    • foreground: boolean

      是否是前台

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

    Returns void

AbstractgetUserId

  • getUserId(): undefined | string

    获取用户ID

    Returns undefined | string

    用户ID

    Remarks

    当 getState > IDLE 时，该值有效

AbstractgetState

AbstractgetDisplayName

  • getDisplayName(): undefined | string

    获取用户昵称

    Returns undefined | string

    当前用户昵称

    Remarks

    昵称用于通话、消息等场景，可以更直观地表明身份 默认为用户ID，即 getUserId 的返回值

AbstractsetDisplayName

  • setDisplayName(displayName: undefined | string): void

    设置用户昵称

    Parameters

    • displayName: undefined | string

      要设置的用户昵称

    Returns void

    Remarks

    昵称用于通话、消息等场景，可以更直观地表明身份 默认为用户ID，即 getUserId 的返回值

AbstractgetServer

  • getServer(): undefined | string

    获取接入服务器地址

    Returns undefined | string

    接入服务器地址

AbstractsetServer

  • setServer(server: undefined | string): void

    设置接入服务器地址

    Parameters

    • server: undefined | string

      接入服务器地址

    Returns void

AbstractgetAppKey

  • getAppKey(): undefined | string

    获取 AppKey

    Returns undefined | string

    当前设置的 AppKey

    Remarks

    AppKey 是用户从 Juphoon RTC 平台上申请的唯一标识字符串

AbstractsetAppKey

  • setAppKey(appKey: undefined | string): void

    设置 AppKey

    Parameters

    • appKey: undefined | string

      要设置的 AppKey

    Returns void

    Remarks

    AppKey 是用户从 Juphoon RTC 平台上申请的唯一标识字符串

AbstractgetAppName

  • getAppName(): undefined | string

    获取应用名称

    Returns undefined | string

    应用名称

AbstractsetAppName

  • setAppName(appName: undefined | string): void

    设置应用名称

    Parameters

    • appName: undefined | string

      应用名称

    Returns void

Abstractlogin

  • login(
        userId: string,
        passwordOrLoginParam?: string | JRTCClientLoginParam,
        clientLoginParam?: JRTCClientLoginParam,
    ): boolean

    登录 Juphoon RTC 平台

    Parameters

    • userId: string

      用户ID

    • OptionalpasswordOrLoginParam: string | JRTCClientLoginParam

      密码或者登录参数，可以为空

    • OptionalclientLoginParam: JRTCClientLoginParam

      登录参数，一般不需要设置，如需设置请询问客服，传 undefined 则按默认值

    Returns boolean

    接口调用结果

    • true：接口调用成功
    • false：接口调用异常 目前只支持免鉴权模式，服务器不校验账号密码，免鉴权模式下当账号不存在时会自动去创建该账号 用户名为英文数字和'+' '-' '' '.'，长度不要超过64字符，'-' '' '.'不能作为第一个字符

    Remarks

    只有登录成功后才能进行平台上的各种业务。 登录结果通过 onLogin 回调通知。

Abstractlogout

  • logout(): boolean

    登出 Juphoon RTC 平台

    Returns boolean

    接口调用结果

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

    Remarks

    登出后不能进行平台上的各种业务。 登出结果通过 onLogout 回调通知。

AbstractsendOnlineMessage

  • sendOnlineMessage(message: string, userId: string): number

    发送在线消息

    Parameters

    • message: string

      消息内容

    • userId: string

      对端的用户名

    Returns number

    接口调用结果

    • 大于0的操作ID：接口调用成功，对应 onOnlineMessageSendResult 回调的 operatorId 参数
    • -1：接口调用异常，不会收到回调

    Remarks

    消息大小不超过4k

AbstractrequestFileUploadInfo

  • requestFileUploadInfo(
        serialId: string,
        requestFileUploadParam: JRTCRequestFileUploadParam,
    ): number

    获取文件上传或断点续传信息

    Parameters

    • serialId: string

      业务id，必选，如果是通话业务相关文件，需要传通话唯一标识 callId

    • requestFileUploadParam: JRTCRequestFileUploadParam

      请求文件上传信息参数，必选

    Returns number

    接口调用结果

    • 大于0的操作ID：接口调用成功，对应 onRequestFileUploadInfoResponse 回调的 operatorId 参数
    • -1：接口调用异常，不会收到回调

    Remarks

    目前仅支持视频和图片类型文件上传，服务端会通过文件后缀名判断。

AbstractcompleteFileUpload

  • completeFileUpload(
        serialId: string,
        completeFileUploadParam: JRTCCompleteFileUploadParam,
    ): number

    文件上传完成确认

    Parameters

    • serialId: string

      业务id，必选，如果是通话业务相关文件，需要传通话唯一标识 callId

    • completeFileUploadParam: JRTCCompleteFileUploadParam

      文件上传完成确认参数，必选

    Returns number

    接口调用结果

    • 大于0的操作ID：接口调用成功，对应 onCompleteFileUploadResponse 回调的 operatorId 参数
    • -1：接口调用异常，不会收到回调

    Remarks

    通过 http 上传文件完成后，需要调用该接口确认完成，否则上传文件将无法在平台查询到。

AbstractgetUploadFileInfo

  • getUploadFileInfo(serialId: string, extraInfo: HashMap<string, Object>): number

    获取上传文件信息列表

    Parameters

    • serialId: string

      业务id，必选，如果是通话业务相关文件，需要传通话唯一标识 callId

    • extraInfo: HashMap<string, Object>

      随路参数

    Returns number

    接口调用结果

    • 大于0的操作ID：接口调用成功，对应 onGetUploadFileInfoResponse 回调的 operatorId 参数
    • -1：接口调用异常，不会收到回调

    Remarks

    查询返回所有和该业务唯一标识相关的文件信息列表。

设置

主题