本页主要介绍主叫发起呼叫邀请过程中,被叫会收到哪些回调事件。所有回调都是在 RemoteInvitation
实例上进行监听。
示例
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) => { });
/**
* 收到来自主叫的呼叫邀请回调 RemoteInvitationReceived
* @params remoteInvitation: 由 SDK 创建的供被叫调用的呼叫邀请对象 RemoteInvitation
*
* 通过绑定 被叫调用的呼叫邀请对象 提供的事件回调进行相关操作监听
* @params eventName: 呼叫邀请对象 提供的事件的名称。(类型:string)
* @params ...args: 回调参数。(类型:any[])
*/
client.on("RemoteInvitationReceived", (remoteInvitation) => {
remoteInvitation.on("RemoteInvitationAccepted", (...args) => {
});
});
被叫收到呼叫邀请回调事件
RemoteInvitationAccepted
RemoteInvitationAccepted: () => {}
返回给被叫:接受呼叫邀请成功。
示例
// 返回给被叫:接受呼叫邀请成功。
remoteInvitation.on("RemoteInvitationAccepted", () => {
console.log("RemoteInvitationAccepted");
});
RemoteInvitationRefused
RemoteInvitationRefused: () => {}
返回给被叫:拒绝呼叫邀请成功。
示例
// 返回给被叫:拒绝呼叫邀请成功。
remoteInvitation.on("RemoteInvitationRefused", () => {
console.log("RemoteInvitationRefused");
});
RemoteInvitationCanceled
RemoteInvitationCanceled: (content: string) => {}
返回给被叫:主叫已取消呼叫邀请。
回调参数
参数 | 类型 | 描述 |
---|---|---|
content | string | 主叫取消设置的响应内容。如果主叫没设置,content 为 undefined 。 |
示例
// 返回给被叫:主叫已取消呼叫邀请。
remoteInvitation.on("RemoteInvitationCanceled", (content) => {
console.log("RemoteInvitationCanceled", content);
});
RemoteInvitationFailure
RemoteInvitationFailure: (reason: RtmStatusCode.RemoteInvitationFailureReason) => {}
返回给被叫:呼叫邀请进程失败。
回调参数
参数 | 类型 | 描述 |
---|---|---|
reason | RtmStatusCode.RemoteInvitationFailureReason | 呼叫邀请的失败原因。 |
示例
// 返回给被叫:呼叫邀请进程失败。
remoteInvitation.on("RemoteInvitationFailure", (reason) => {
console.log("RemoteInvitationFailure", reason);
});