文档中心
由主叫通过 createLocalInvitation 方法创建，仅供主叫调用的呼叫邀请对象。
LocalInvitation 实例可以发送呼叫邀请或取消邀请，需要注意的是这并非建立呼叫，而是单纯信令流程。
示例
import ArRTM from "ar-rtm-sdk";
...
/**
* 创建 RTM 客户端实例
* @params demoAppId: Pass your App ID here.
*/
const client = ArRTM.createInstance("demoAppId", { enableLogUpload: false });
/**
* 登陆
* @params uid: Pass your user ID here.
*/
client.login({ uid: "userId" })
.then(() => { })
.catch((err) => { });
/**
* 创建主叫呼叫邀请实例 createLocalInvitation
* @params calleeId: 被叫的 uid.
* 设置的呼叫邀请内容 (主叫设置 被叫查看) content
* 查看被叫设置的响应内容 主叫查看 被叫设置) response
* 查看呼叫邀请状态 state
*/
const localInvitation = client.createLocalInvitation("calleeId");
LocalInvitation 属性
| 属性 | 描述 |
|---|---|
calleeId | 被叫的 uid。 |
content | 主叫设置的呼叫邀请内容，最大长度为 8 KB。 |
response | 被叫设置的响应内容。 |
state | 呼叫邀请状态，详见 LocalInvitationState。 |
LocalInvitation 方法
on
on(event: string, callback: (...args: any[]) => void): void;
在该频道实例上添加 listener 函数到名为 eventName 的事件。其他 RtmChannel 实例上的事件方法请参考 EventEmitter API 文档。
参数
| 参数 | 类型 | 描述 |
|---|---|---|
eventName | keyof LocalInvitationEvents | 频道事件的名称。 |
listener | function | 事件的回调函数。LocalInvitationEvents[eventName] |
示例
/**
* 通过绑定 呼叫邀请对象 提供的事件回调进行相关操作监听
* @params eventName: 呼叫邀请对象 提供的事件的名称。(类型：string)
* @params ...args: 不同的事件，回调参数是不同的。(类型：any[])
*/
localInvitation.on("LocalInvitationAccepted", (...args) => {
});
返回
void
cancel
cancel(): void
取消已发送的呼叫邀请。
- 该方法无异步回调。如需监听 LocalInvitationState 变化，请通过 on 方法注册 LocalInvitationEvents 中的事件回调。
示例
/**
* 取消已发送的呼叫邀请
*/
localInvitation.cancel();
返回
void
send
send(): void
向指定用户（被叫）发送呼叫邀请。
- 该方法无异步回调，如需监听 LocalInvitationState 变化，请通过 on 方法注册 LocalInvitationEvents 中的事件回调。
示例
/**
* 发送的呼叫邀请 send
*/
localInvitation.send();
返回
void