Class JCCLoginParam

登录参数类 JCCLoginParam

Remarks

用于配置 JRTCClient 登录时的各种参数，包括服务器地址、用户信息和日志配置等

Example

const loginParam = new JCCLoginParam();
loginParam.server = "服务器地址";
loginParam.appKey = "应用标识";
loginParam.userName = "用户名";
loginParam.password = "密码";

Accessors

server appKey userName password appName sdkInfoDir logConsole logLocalFile looseTimeoutControl nickName terminalType deviceId tokenType token certificate acceptExpiredCertificate accelerateKey accelerateKeySecret optimizeDataRouter

Accessors

server

  • set server(value: undefined | string): void

    设置服务器地址

    Parameters

    • value: undefined | string

      服务器地址

    Returns void

    Remarks

    设置登录的服务器地址，必填参数

appKey

  • set appKey(value: undefined | string): void

    设置应用标识

    Parameters

    • value: undefined | string

      应用标识

    Returns void

    Remarks

    设置应用的唯一标识，必填参数

userName

  • set userName(value: undefined | string): void

    设置用户名

    Parameters

    • value: undefined | string

      用户名

    Returns void

    Remarks

    设置登录的用户名，必填参数。用户名为英文数字和'+' '-' '' '.'，长度不要超过64字符，'-' '' '.'不能作为第一个字符

password

  • set password(value: undefined | string): void

    设置密码

    Parameters

    • value: undefined | string

      密码

    Returns void

    Remarks

    设置登录的密码

appName

  • set appName(value: undefined | string): void

    设置应用名

    Parameters

    • value: undefined | string

      应用名

    Returns void

    Remarks

    设置登录的应用名称，选填参数

sdkInfoDir

  • set sdkInfoDir(value: undefined | string): void

    设置SDK信息存储目录

    Parameters

    • value: undefined | string

      SDK信息存储目录

    Returns void

    Remarks

    设置SDK信息的存储目录，该目录下的log目录用于存储日志，选填参数

logConsole

  • set logConsole(value: boolean): void

    设置是否开启控制台日志输出

    Parameters

    • value: boolean

      是否开启控制台日志输出

    Returns void

    Remarks

    控制SDK是否将日志输出到控制台，默认为true

logLocalFile

  • set logLocalFile(value: boolean): void

    设置是否开启本地文件日志输出

    Parameters

    • value: boolean

      是否开启本地文件日志输出

    Returns void

    Remarks

    控制SDK是否将日志存储到本地文件，默认为true

looseTimeoutControl

  • set looseTimeoutControl(value: boolean): void

    设置是否开启RPC抗信令丢包控制

    Parameters

    • value: boolean

      是否开启RPC抗信令丢包控制

    Returns void

    Remarks

    控制是否开启RPC抗信令丢包控制（70%的上下行信令丢包），默认为false

nickName

  • set nickName(value: undefined | string): void

    设置用户昵称

    Parameters

    • value: undefined | string

      用户昵称

    Returns void

    Remarks

    设置用户的昵称信息，选填参数

terminalType

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

    设置终端登录类型

    Parameters

    • value: undefined | string

      终端登录类型

    Returns void

    Remarks

    设置终端登录类型，支持多终端登录，默认所有终端相同会导致互踢，选填参数

deviceId

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

    设置设备ID

    Parameters

    • value: undefined | string

      设备ID

    Returns void

    Remarks

    设置设备的唯一标识，选填参数

tokenType

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

    设置Token校验类型

    Parameters

    • value: undefined | string

      Token校验类型

    Returns void

    Remarks

    设置Token的校验类型，选填参数

token

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

    设置Token

    Parameters

    • value: undefined | string

      Token值

    Returns void

    Remarks

    设置登录验证的Token，选填参数

certificate

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

    设置S3国密证书

    Parameters

    • value: undefined | string

      S3国密证书Base64编码内容

    Returns void

    Remarks

    设置S3国密证书的Base64编码内容，选填参数

acceptExpiredCertificate

  • set acceptExpiredCertificate(value: boolean): void

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

    Parameters

    • value: boolean

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

    Returns void

    Remarks

    控制是否接受过期的证书，默认为false

accelerateKey

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

    设置加速云KEY

    Parameters

    • value: undefined | string

      加速云KEY

    Returns void

    Remarks

    设置用于加速服务的KEY，选填参数

accelerateKeySecret

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

    设置加速云KEY密钥

    Parameters

    • value: undefined | string

      加速云KEY密钥

    Returns void

    Remarks

    设置用于加速服务的KEY密钥，选填参数

optimizeDataRouter

  • set optimizeDataRouter(value: boolean): void

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

    Parameters

    • value: boolean

      是否开启数据路由优化

    Returns void

    Remarks

    控制是否启用数据传输路由优化，提升网络传输效率，默认为true

设置

主题