Class JRTCClientLoginParam

登录参数类

Remarks

用于配置 JRTCClient 登录时的各种参数

Accessors

terminalType deviceId token tokenType tokenExtraParam certificate acceptExpiredCertificate logFilter accelerateKey optimizeDataRouter accelerateKeySecret

Methods

toJSON toString

Accessors

terminalType

  • get terminalType(): undefined | string

    获取终端登录类型

    Returns undefined | string

    当前设置的终端登录类型

  • set terminalType(terminalType: undefined | string): void

    设置终端登录类型

    Parameters

    • terminalType: undefined | string

      终端登录类型，支持多终端登录，默认所有终端相同会导致互踢

    Returns void

deviceId

  • get deviceId(): undefined | string

    获取设备ID

    Returns undefined | string

    当前设置的设备ID

  • set deviceId(deviceId: undefined | string): void

    设置设备ID

    Parameters

    • deviceId: undefined | string

      要设置的设备ID

    Returns void

token

  • get token(): undefined | string

    获取 token

    Returns undefined | string

    当前设置的 token

  • set token(token: undefined | string): void

    设置 token

    Parameters

    • token: undefined | string

      要设置的 token

    Returns void

tokenType

  • set tokenType(tokenType: undefined | string): void

    设置 token 校验类型

    Parameters

    • tokenType: undefined | string

      要设置的 token 校验类型

    Returns void

tokenExtraParam

  • get tokenExtraParam(): undefined | string

    获取 token 校验拓展参数

    Returns undefined | string

    当前设置的 token 校验拓展参数

  • set tokenExtraParam(tokenExtraParam: undefined | string): void

    设置 token 校验拓展参数

    Parameters

    • tokenExtraParam: undefined | string

      要设置的 token 校验拓展参数，json字符串格式

    Returns void

certificate

  • get certificate(): undefined | string

    获取 S3 国密证书 Base64 编码内容

    Returns undefined | string

    当前设置的 S3 国密证书 Base64 编码内容

  • set certificate(certificate: undefined | string): void

    设置 S3 国密证书 Base64 编码内容

    Parameters

    • certificate: undefined | string

      要设置的 S3 国密证书 Base64 编码内容

    Returns void

acceptExpiredCertificate

  • get acceptExpiredCertificate(): boolean

    获取是否允许过期证书校验通过

    Returns boolean

    是否允许过期证书校验通过

  • set acceptExpiredCertificate(acceptExpiredCertificate: boolean): void

    设置是否允许过期证书校验通过

    Parameters

    • acceptExpiredCertificate: boolean

      是否允许过期证书校验通过，默认为 false

    Returns void

logFilter

  • get logFilter(): undefined | string

    获取日志过滤标签

    Returns undefined | string

    当前设置的日志过滤标签

    Remarks

    业务管理平台搜索日志时使用

  • set logFilter(logFilter: undefined | string): void

    设置日志过滤标签

    Parameters

    • logFilter: undefined | string

      要设置的日志过滤标签

    Returns void

accelerateKey

  • get accelerateKey(): undefined | string

    获取加速云KEY

    Returns undefined | string

    当前设置的加速云KEY

  • set accelerateKey(accelerateKey: undefined | string): void

    设置加速云KEY

    Parameters

    • accelerateKey: undefined | string

      要设置的加速云KEY

    Returns void

optimizeDataRouter

  • get optimizeDataRouter(): boolean

    获取是否开启数据路由优化

    Returns boolean

    是否开启数据路由优化

  • set optimizeDataRouter(optimizeDataRouter: boolean): void

    设置是否开启数据路由优化

    Parameters

    • optimizeDataRouter: boolean

      是否开启数据路由优化，默认为 true

    Returns void

accelerateKeySecret

  • get accelerateKeySecret(): undefined | string

    获取加速云KEY密钥

    Returns undefined | string

    当前设置的加速云KEY密钥

  • set accelerateKeySecret(accelerateKeySecret: undefined | string): void

    设置加速云KEY密钥

    Parameters

    • accelerateKeySecret: undefined | string

      要设置的加速云KEY密钥

    Returns void

Methods

toJSON

  • toJSON(): Record<string, undefined | Object>

    将对象转换为 JSON 对象

    Returns Record<string, undefined | Object>

    包含所有属性的 JSON 对象

toString

  • toString(): string

    将对象转换为字符串

    Returns string

    JSON 格式的字符串表示

设置

主题