Class JRTCNotifyMessage

事件通知消息类

Remarks

该类用于封装呼叫中心系统中的事件通知消息。 在通话过程中，各方可以使用该类发送各种业务事件通知， 如文件传输请求、评价请求等。事件通知消息通常用于 传递结构化的业务信息，比普通文本消息更具扩展性。

Accessors

eventCode desc extra

Methods

toString toJSON

Accessors

eventCode

  • get eventCode(): undefined | number

    获取事件码

    Returns undefined | number

    事件码，如果未设置则返回undefined

    Remarks

    通过事件码可以判断当前通知消息的类型， 详见JRTCEventCode 事件码定义。 接收方应根据事件码执行对应的业务逻辑。

  • set eventCode(value: undefined | number): void

    设置事件码

    Parameters

    • value: undefined | number

      事件码，用于标识不同类型的事件通知

    Returns void

    Remarks

    事件码是用于区分不同类型事件通知的数字标识符， 可参考JRTCEventCode 事件码的定义。 事件码决定了消息的处理方式和业务含义。

desc

  • get desc(): undefined | string

    获取事件描述

    Returns undefined | string

    事件描述文本，如果未设置则返回undefined

    Remarks

    该方法返回事件的描述文本，可用于向用户展示事件的基本信息。

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

    设置事件描述

    Parameters

    • value: undefined | string

      事件的文字描述，用于补充说明事件的内容或目的

    Returns void

    Remarks

    事件描述是对事件的文字说明，可以包含事件的基本信息、 目的或其他相关内容。这个字段主要面向用户，可用于UI展示。

extra

  • get extra(): undefined | string

    获取随路参数

    Returns undefined | string

    随路参数字符串，如果未设置则返回undefined

    Remarks

    该方法返回事件通知的扩展数据，应用程序需要根据事件类型 解析此字符串以获取详细信息。通常为JSON格式。

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

    设置随路参数

    Parameters

    • value: undefined | string

      随路参数，通常是JSON格式的字符串，包含事件的详细信息

    Returns void

    Remarks

    随路参数是事件通知的扩展字段，可以包含复杂的结构化数据。 通常采用JSON字符串格式，便于传输和解析。具体内容由事件类型决定。

Methods

toString

  • toString(): string

    将对象转换为字符串

    Returns string

    包含所有属性的JSON字符串

    Remarks

    该方法用于将对象转换为JSON字符串，主要用于日志记录和调试。

toJSON

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

    将对象转换为JSON对象

    Returns Record<string, undefined | Object>

    包含所有属性的JSON对象

    Remarks

    该方法用于将对象转换为JSON格式，便于数据序列化和传输。 返回的对象包含eventCode、desc和extra属性，未设置的属性值为undefined。

设置

主题