Class JRTCClientAbstract

基础模块管理

Methods

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

Methods

Staticcreate

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

  • 创建 JRTCClient 实例

    Parameters

    • applicationContext: ApplicationContext

      应用上下文对象

    • callback: JRTCClientCallback

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

    • OptionalinitParam: JRTCClientInitParam

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

    Returns JRTCClient

    JRTCClient 对象

    Throws

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

Staticdestroy

  • destroy(): void

  • 销毁 JRTCClient 对象

    Returns void

    Note

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

AbstractsetForeground

  • setForeground(foreground: boolean): void

  • 设置是否是前台

    Parameters

    • foreground: boolean

      是否是前台

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

    Returns void

AbstractgetUserId

  • getUserId(): string

  • 获取用户ID

    Returns string

    用户ID

    Note

    当 state > STATE_IDLE 该值有效

AbstractgetState

AbstractgetDisplayName

  • getDisplayName(): string

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

    Returns string

    当前用户昵称

AbstractsetDisplayName

  • setDisplayName(displayName: string): void

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

    Parameters

    • displayName: string

      用户昵称

    Returns void

AbstractgetServer

  • getServer(): string

  • 获取接入服务器地址

    Returns string

    接入服务器地址

AbstractsetServer

  • setServer(server: string): void

  • 设置接入服务器地址

    Parameters

    • server: string

      接入服务器地址

    Returns void

AbstractgetAppKey

  • getAppKey(): string

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

    Returns string

    AppKey

AbstractsetAppKey

  • setAppKey(appKey: string): void

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

    Parameters

    • appKey: string

    Returns void

AbstractgetAppName

  • getAppName(): string

  • 获取应用名称

    Returns string

    应用名称

AbstractsetAppName

  • setAppName(appName: string): void

  • 设置应用名称

    Parameters

    • appName: string

      应用名称

    Returns void

Abstractlogin

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

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

    登录结果通过 onLogin 回调通知

    Parameters

    • userId: string

      用户ID

    • password: string

      密码，不能为空

    • OptionalclientLoginParam: JRTCClientLoginParam

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

    Returns boolean

    接口调用结果

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

    Warning

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

    Warning

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

Abstractlogout

  • logout(): boolean

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

    登出结果通过 onLogout 回调通知

    Returns boolean

    接口调用结果

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

AbstractsendOnlineMessage

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

  • 发送在线消息

    Parameters

    • message: string

      消息内容

    • userId: string

      对端的用户名

    Returns number

    接口调用结果

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

    Note

    消息大小不超过4k

AbstractgetUploadUrl

  • getUploadUrl(fileUid?: string): boolean

  • 获取文件上传路径

    调用此接口，fileUid 非必须指定时可传空字符串
    调用成功后，文件上传路径等具体信息可通过 JRTCClientCallback.onGetUploadUrlResponse onGetUploadUrlResult 回调获取

    Parameters

    • OptionalfileUid: string

      文件 id

    Returns boolean

    接口调用结果

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

    Note

    文件 id 用于断点续传，第二次续传文件时需要传递前一次获取到的 fileUid 首次新文件上传，建议传空，fileUid 由服务器自动生成下发

AbstractrequestFileUploadInfo

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

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

    Parameters

    • serialId: string

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

    • requestFileUploadParam: JRTCRequestFileUploadParam

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

    Returns number

    接口调用结果

    Note

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

AbstractcompleteFileUpload

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

  • 文件上传完成确认

    Parameters

    • serialId: string

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

    • completeFileUploadParam: JRTCCompleteFileUploadParam

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

    Returns number

    接口调用结果

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

    Note

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

AbstractgetUploadFileInfo

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

  • 获取上传文件信息列表

    Parameters

    • serialId: string

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

    • extraInfo: HashMap<string, Object>

      随路参数

    Returns number

    接口调用结果

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

    Note

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

AbstractnotifySDKEvent

  • notifySDKEvent(event: JRTCSDKEvent): any

  • 事件上报

    Parameters

    Returns any

AbstractaddCallback

  • addCallback(callback: JRTCClientCallback): any

  • 添加回调

    Parameters

    Returns any

AbstractremoveCallback

  • removeCallback(callback: JRTCClientCallback): any

  • 删除回调

    Parameters

    Returns any

Settings

Member Visibility

On This Page

Methods