本页主要介绍主叫发起呼叫邀请过程中,主叫会收到哪些回调事件。所有回调都是在 LocalInvitation
实例上进行监听。
示例
本示例中 localInvitation 实例适用于本页所有的示例。
/**
* 创建 RTM 客户端实例
* @params appId: 指定频道的 ID。(类型:string)
*/
const client = ArRTM.createInstance(appId, { enableLogUpload: false });
/**
* 用户登录 anyRTC RTM 系统
*/
client.login({token: "undefined", uid: "userID"})
.then((res) => { })
.catch((err) => { });
/**
* 创建主叫呼叫邀请实例 createLocalInvitation
* @params calleeId: 被叫的 uid.
*
*/
const localInvitation = client.createLocalInvitation("calleeId");
主叫发起呼叫邀请回调事件
LocalInvitationReceivedByPeer
LocalInvitationReceivedByPeer: (response: string) => {}
当主叫端呼叫被叫端,被叫端收到邀请之后,该回调会触发。
示例
// 被叫收到呼叫邀请
localInvitation.on("LocalInvitationReceivedByPeer", () => {
console.log("LocalInvitationReceivedByPeer");
});
LocalInvitationAccepted
LocalInvitationAccepted: (response: string) => {}
当主叫端呼叫被叫端,被叫端接受邀请之后,该回调会触发。
回调参数
参数 | 类型 | 描述 |
---|---|---|
response | string | 被叫设置的响应内容。 |
示例
// 被叫接受呼叫邀请
localInvitation.on("LocalInvitationAccepted", (response) => {
console.log("LocalInvitationAccepted", response);
});
LocalInvitationRefused
LocalInvitationRefused: (response: string) => {}
当主叫端呼叫被叫端,被叫拒绝呼叫邀请,该回调会触发。
回调参数
参数 | 类型 | 描述 |
---|---|---|
response | string | 被叫设置的响应内容。例如:可以用来告诉主叫为什么要拒绝。 |
示例
// 被叫拒绝呼叫邀请
localInvitation.on("LocalInvitationRefused", (response) => {
console.log("LocalInvitationRefused", response);
});
LocalInvitationCanceled
LocalInvitationCanceled: () => {}
- 主叫端呼叫被叫端后,在被叫端接收邀请之前,主叫主动取消呼叫邀请,该回调会触发。
- 主叫端呼叫被叫端失败,会在触发 LocalInvitationFailure 回调后触发该回调。
示例
// 呼叫邀请已被主动取消或主叫端呼叫被叫端失败。
localInvitation.on("LocalInvitationCanceled", () => {
console.log("LocalInvitationCanceled");
});
LocalInvitationFailure
LocalInvitationFailure: (reason: RtmStatusCode.LocalInvitationFailureReason) => {}
主叫端呼叫被叫端失败。
回调参数
参数 | 类型 | 描述 |
---|---|---|
reason | RtmStatusCode.LocalInvitationFailureReason | 呼叫邀请的失败原因。 |
示例
// 主叫端呼叫被叫端失败。
localInvitation.on("LocalInvitationFailure", (reason) => {
console.log("LocalInvitationFailure", reason);
});