CallAgent interface
CallAgent 用于处理调用。
- 扩展
属性
| calls | 获取呼叫。 |
| display |
获取所有新呼叫的本地参与者的显示名称。 |
继承属性
| connection |
获取连接状态。 |
| kind | 获取调用代理对象的类型。 |
方法
继承的方法
| dispose() | 释放此呼叫代理 |
| feature<TFeature>(Call |
使用扩展 API 检索已初始化和备忘录化的功能对象。 检查对象 Features.* 中是否有此包中所有可用的扩展调用代理功能。 |
| handle |
处理推送通知。 |
属性详细信息
calls
获取呼叫。
calls: readonly Call[]属性值
readonly Call[]
displayName
获取所有新呼叫的本地参与者的显示名称。
displayName?: string属性值
string
继承属性详细信息
connectionState
kind
方法详细信息
join(GroupCallLocator, JoinCallOptions)
加入组呼叫。 若要加入组呼叫，请传递 groupId。
function join(groupLocator: GroupCallLocator, options?: JoinCallOptions): Call参数
- groupLocator
- GroupCallLocator
组呼叫信息。
- options
- JoinCallOptions
调用开始选项。
返回
与调用关联的 Call 对象。
join(GroupChatCallLocator, JoinCallOptions)
注意
此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
加入群组聊天呼叫。 若要加入群组聊天呼叫，请传递 threadId。
function join(groupChatCallLocator: GroupChatCallLocator, options?: JoinCallOptions): Call参数
- groupChatCallLocator
- GroupChatCallLocator
GroupChat 呼叫信息。
- options
- JoinCallOptions
调用开始选项。
返回
与调用关联的 Call 对象。
join(MeetingLocator, JoinCallOptions)
注意
此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
加入 Teams 会议。 若要加入 Teams 会议，请传递会议链接或会议坐标。
function join(meetingLocator: MeetingLocator, options?: JoinCallOptions): Call参数
- meetingLocator
- MeetingLocator
会议信息。
- options
- JoinCallOptions
调用开始选项。
返回
与调用关联的 Call 对象。
join(RoomCallLocator, JoinCallOptions)
加入会议室呼叫。 若要加入会议室呼叫，请传递 roomId。
function join(roomLocator: RoomCallLocator, options?: JoinCallOptions): Call参数
- roomLocator
- RoomCallLocator
会议室呼叫信息。
- options
- JoinCallOptions
调用开始选项。
返回
与调用关联的 Call 对象。
join(TeamsMeetingIdLocator, JoinCallOptions)
加入 Teams 会议。 若要加入 Teams 会议，请传递会议 ID 和密码。
function join(meetingLocator: TeamsMeetingIdLocator, options?: JoinCallOptions): Call参数
- meetingLocator
- TeamsMeetingIdLocator
会议信息。
- options
- JoinCallOptions
调用开始选项。
返回
与调用关联的 Call 对象。
join(TeamsMeetingLinkLocator, JoinCallOptions)
加入 Teams 会议。 若要加入 Teams 会议，请传递会议链接。
function join(meetingLocator: TeamsMeetingLinkLocator, options?: JoinCallOptions): Call参数
- meetingLocator
- TeamsMeetingLinkLocator
会议信息。
- options
- JoinCallOptions
调用开始选项。
返回
与调用关联的 Call 对象。
off("callsUpdated", CollectionUpdatedEvent<Call>)
取消订阅调用Updated 事件的函数。
function off(event: "callsUpdated", listener: CollectionUpdatedEvent<Call>)参数
- event
-
"callsUpdated"
事件名称。
- listener
用于订阅此事件的回调 fn。
off("connectionStateChanged", ConnectionStateChangedEvent)
取消订阅 connectionStateChanged 事件的函数。
function off(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)参数
- event
-
"connectionStateChanged"
事件名称。
- listener
- ConnectionStateChangedEvent
回调 fn，将在此属性的值发生更改时调用。
off("incomingCall", IncomingCallEvent)
取消订阅传入Call 事件的函数。
function off(event: "incomingCall", listener: IncomingCallEvent)参数
- event
-
"incomingCall"
事件名称。
- listener
- IncomingCallEvent
用于订阅此事件的回调 fn。
on("callsUpdated", CollectionUpdatedEvent<Call>)
为 callsUpdated 事件订阅函数。
function on(event: "callsUpdated", listener: CollectionUpdatedEvent<Call>)参数
- event
-
"callsUpdated"
事件名称。
- listener
回调 fn，将在此集合更改时调用，它将传递已添加和删除元素的数组。
on("connectionStateChanged", ConnectionStateChangedEvent)
connectionStateChanged 事件的 Subscribe 函数。
function on(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)参数
- event
-
"connectionStateChanged"
事件名称。
- listener
- ConnectionStateChangedEvent
回调 fn，将在此属性的值发生更改时调用。
on("incomingCall", IncomingCallEvent)
订阅传入Call 事件的函数。
function on(event: "incomingCall", listener: IncomingCallEvent)参数
- event
-
"incomingCall"
事件名称。
- listener
- IncomingCallEvent
回调 fn，将在此 callAgent 收到传入呼叫时调用。
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
发起对提供的参与者的呼叫。
function startCall(participants: (PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): Call参数
- participants
-
(PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
- options
- StartCallOptions
“开始呼叫”选项。
返回
与已启动调用关联的 Call 对象。
startCall(CommunicationIdentifier[], StartCallOptions)
发起对提供的参与者的呼叫。
function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call参数
- participants
- options
- StartCallOptions
“开始呼叫”选项。
返回
与已启动调用关联的 Call 对象。
继承的方法详细信息
dispose()
释放此呼叫代理
function dispose(): Promise<void>返回
Promise<void>
继承自
feature<TFeature>(CallAgentFeatureFactory<TFeature>)
注意
此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
使用扩展 API 检索已初始化和备忘录化的功能对象。 检查对象 Features.* 中是否有此包中所有可用的扩展调用代理功能。
function feature<TFeature>(factory: CallAgentFeatureFactory<TFeature>): TFeature参数
- factory
-
CallAgentFeatureFactory<TFeature>
提供扩展 API 的调用代理功能构造函数的工厂。
返回
TFeature
handlePushNotification(IncomingCallPushNotificationData)
注意
此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
处理推送通知。
function handlePushNotification(data: IncomingCallPushNotificationData): Promise<void>参数
推送通知数据
返回
Promise<void>