Class JRTCCallExtraParam

通话邀请相关参数类

Remarks

此类用于封装通话邀请过程中的各种参数，包括通话类型、参与者身份信息、 业务标识和额外数据等。在发起邀请、接收邀请和处理邀请回调时使用。

Accessors

video serialId callerUserId callerDisplayName calleeUserId calleeDisplayName calleeUserType callerNumberForSip routeId extraInfo

Methods

toJSON toString

Accessors

video

  • get video(): boolean

    获取是否为视频通话

    Returns boolean

    通话类型

    • true: 视频通话
    • false: 音频通话
  • set video(value: boolean): void

    设置是否为视频通话

    Parameters

    • value: boolean

      通话类型

      • true: 视频通话
      • false: 音频通话

    Returns void

serialId

  • get serialId(): string

    获取业务流水号

    Returns string

    当前通话的业务流水号

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

    设置业务流水号

    Parameters

    • value: undefined | string

      唯一标识此次通话的业务流水号，可用于后续业务关联

    Returns void

callerUserId

  • get callerUserId(): undefined | string

    获取邀请者(主叫方)用户ID

    Returns undefined | string

    邀请者的用户唯一标识

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

    设置邀请者(主叫方)用户ID

    Parameters

    • value: undefined | string

      邀请者的用户唯一标识

    Returns void

callerDisplayName

  • get callerDisplayName(): undefined | string

    获取邀请者(主叫方)用户昵称

    Returns undefined | string

    邀请者的显示名称

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

    设置邀请者(主叫方)用户昵称

    Parameters

    • value: undefined | string

      邀请者的显示名称，用于界面展示

    Returns void

calleeUserId

  • get calleeUserId(): undefined | string

    获取被邀请者(被叫方)用户ID

    Returns undefined | string

    被邀请者的用户唯一标识

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

    设置被邀请者(被叫方)用户ID

    Parameters

    • value: undefined | string

      被邀请者的用户唯一标识

    Returns void

calleeDisplayName

  • get calleeDisplayName(): undefined | string

    获取被邀请者(被叫方)用户昵称

    Returns undefined | string

    被邀请者的显示名称

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

    设置被邀请者(被叫方)用户昵称

    Parameters

    • value: undefined | string

      被邀请者的显示名称，用于界面展示

    Returns void

calleeUserType

  • get calleeUserType(): JRTCCallUserType

    获取被邀请者(被叫方)用户类型

    Returns JRTCCallUserType

    被邀请者的用户类型

  • set calleeUserType(value: JRTCCallUserType): void

    设置被邀请者(被叫方)用户类型

    Parameters

    Returns void

    Remarks

    当被邀请者用户ID不为空时，该值有效。用户类型决定了通话的连接方式。

callerNumberForSip

  • get callerNumberForSip(): undefined | string

    获取SIP外呼主叫号码

    Returns undefined | string

    SIP外呼时显示的主叫号码

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

    设置SIP外呼主叫号码

    Parameters

    • value: undefined | string

      SIP外呼时显示的主叫号码

    Returns void

    Remarks

    当被邀请者用户类型是SIP用户时，此参数有效。 此号码会在SIP设备上显示为来电号码。

routeId

  • get routeId(): undefined | string

    获取SIP外呼线路ID

    Returns undefined | string

    SIP外呼使用的线路ID

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

    设置SIP外呼线路ID

    Parameters

    • value: undefined | string

      SIP外呼使用的线路ID

    Returns void

    Remarks

    当被邀请者用户类型是SIP用户时，此参数有效。 线路ID用于选择特定的SIP线路进行呼叫。

extraInfo

  • get extraInfo(): any

    获取随路参数

    Returns any

    额外的自定义参数

  • set extraInfo(value: any): void

    设置随路参数

    Parameters

    • value: any

      额外的自定义参数，可用于传递业务相关信息

    Returns void

    Remarks

    随路参数会在邀请过程中传递，可用于在通话双方传递额外的业务信息。

Methods

toJSON

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

    将参数转换为JSON对象

    Returns Record<string, undefined | Object>

    包含所有参数的JSON对象

    Remarks

    此方法用于将参数序列化，便于传输或存储。

toString

  • toString(): string

    将参数转换为字符串

    Returns string

    参数的JSON字符串表示

    Remarks

    此方法将所有参数转换为JSON字符串格式，便于日志记录和调试。

设置

主题