通知
RTM 1.x 将于近期下架，各版本退休日期和替代方案详见 退休政策 。
文档中心
云信令（原实时消息）
Console 官网 社区 技术支持
简体中文
search-icon

Agora RTM Web API Reference

概览 Globals AgoraRTM RtmClient RtmMessage RtmChannel LocalInvitation RemoteInvitation RtmErrorCode RtmStatusCode

由主叫通过 createLocalInvitation 方法创建，仅供主叫调用的呼叫邀请对象。

Hierarchy

Index

Properties

Methods

Properties

calleeId

calleeId: string

被叫的 uid。

channelId

channelId: string

主叫设置的频道 ID。

note

与老信令 SDK 互通时你必须设置频道 ID。不过即使在被叫成功接受呼叫邀请后，Agora RTM SDK 也不会把主叫加入指定频道。

content

content: string

主叫设置的呼叫邀请内容。

note

最大长度为 8 KB。

response

response: string

被叫设置的响应内容。

readonly

state

state: LocalInvitationState

Methods

cancel

  • cancel(): void

on

  • on<EventName>(eventName: EventName, listener: function): this

  • 在该频道实例上添加 listener 函数到名为 eventName 的事件。其他 RtmChannel 实例上的事件方法请参考 EventEmitter API 文档。

    Type parameters

    • EventName: keyof LocalInvitationEvents

    Parameters

    • eventName: EventName

      频道事件的名称。事件列表请参考 LocalInvitationEvents 中的属性名。

    • listener: function

      事件的回调函数。

        • (...args: ListenerType<LocalInvitationEvents[EventName]>): any

        • Parameters

          • Rest ...args: ListenerType<LocalInvitationEvents[EventName]>

          Returns any

    Returns this

send

  • send(): void