TeamsCallAgent interface

包:

@azure/communication-calling

TeamsCallAgent 用于处理 Teams 呼叫。

扩展

CallAgentCommon

属性

calls

获取呼叫。

继承属性

connectionState	获取连接状态。
kind	获取调用代理对象的类型。

方法

join(MeetingLocator, JoinCallOptions)	加入 Teams 会议。 若要加入 Teams 会议，请传递会议链接或会议 ID 或会议坐标。
join(TeamsMeetingIdLocator, JoinCallOptions)	加入 Teams 会议。 若要加入 Teams 会议，请传递会议 ID 和密码。
join(TeamsMeetingLinkLocator, JoinCallOptions)	加入 Teams 会议。 若要加入 Teams 会议，请传递会议链接。
off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	取消订阅调用Updated 事件的函数。
off("connectionStateChanged", ConnectionStateChangedEvent)	取消订阅 connectionStateChanged 事件的函数。
off("incomingCall", TeamsIncomingCallEvent)	取消订阅传入Call 事件的函数。
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	为 callsUpdated 事件订阅函数。
on("connectionStateChanged", ConnectionStateChangedEvent)	connectionStateChanged 事件的 Subscribe 函数。
on("incomingCall", TeamsIncomingCallEvent)	订阅传入Call 事件的函数。
startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)	启动 1：N 调用。
startCall(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)	开始 1：1 呼叫。

继承的方法

dispose()	释放此呼叫代理
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	使用扩展 API 检索已初始化和备忘录化的功能对象。 检查对象 Features.* 中是否有此包中所有可用的扩展调用代理功能。
handlePushNotification(IncomingCallPushNotificationData)	处理推送通知。

属性详细信息

calls

获取呼叫。

calls: readonly TeamsCall[]

属性值

readonly TeamsCall[]

继承属性详细信息

connectionState

获取连接状态。

connectionState: ConnectionState

属性值

ConnectionState

继承自CallAgentCommon.connectionState

kind

获取调用代理对象的类型。

kind: CallAgentKind

属性值

CallAgentKind

继承自CallAgentCommon.kind

方法详细信息

join(MeetingLocator, JoinCallOptions)

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

加入 Teams 会议。 若要加入 Teams 会议，请传递会议链接或会议 ID 或会议坐标。

function join(meetingLocator: MeetingLocator, options?: JoinCallOptions): TeamsCall

参数

meetingLocator

MeetingLocator

会议信息。

options

JoinCallOptions

Teams 呼叫开始选项。

返回

TeamsCall

与调用关联的 TeamsCall 对象。

join(TeamsMeetingIdLocator, JoinCallOptions)

加入 Teams 会议。 若要加入 Teams 会议，请传递会议 ID 和密码。

function join(meetingLocator: TeamsMeetingIdLocator, options?: JoinCallOptions): TeamsCall

参数

meetingLocator

TeamsMeetingIdLocator

会议信息。

options

JoinCallOptions

调用开始选项。

返回

TeamsCall

与调用关联的 Call 对象。

join(TeamsMeetingLinkLocator, JoinCallOptions)

加入 Teams 会议。 若要加入 Teams 会议，请传递会议链接。

function join(meetingLocator: TeamsMeetingLinkLocator, options?: JoinCallOptions): TeamsCall

参数

meetingLocator

TeamsMeetingLinkLocator

会议信息。

options

JoinCallOptions

调用开始选项。

返回

TeamsCall

与调用关联的 Call 对象。

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

取消订阅调用Updated 事件的函数。

function off(event: "callsUpdated", listener: CollectionUpdatedEvent<TeamsCall>)

参数

event

"callsUpdated"

事件名称。

listener

CollectionUpdatedEvent<TeamsCall>

用于订阅此事件的 allback fn。

off("connectionStateChanged", ConnectionStateChangedEvent)

取消订阅 connectionStateChanged 事件的函数。

function off(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)

参数

event

"connectionStateChanged"

事件名称。

listener

ConnectionStateChangedEvent

回调 fn，将在此属性的值发生更改时调用。

off("incomingCall", TeamsIncomingCallEvent)

取消订阅传入Call 事件的函数。

function off(event: "incomingCall", listener: TeamsIncomingCallEvent)

参数

event

"incomingCall"

事件名称。

listener

TeamsIncomingCallEvent

用于订阅此事件的回调 fn。

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

为 callsUpdated 事件订阅函数。

function on(event: "callsUpdated", listener: CollectionUpdatedEvent<TeamsCall>)

参数

event

"callsUpdated"

事件名称。

listener

CollectionUpdatedEvent<TeamsCall>

回调 fn，将在此集合更改时调用，它将传递已添加和删除元素的数组。

on("connectionStateChanged", ConnectionStateChangedEvent)

connectionStateChanged 事件的 Subscribe 函数。

function on(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)

参数

event

"connectionStateChanged"

事件名称。

listener

ConnectionStateChangedEvent

回调 fn，将在此属性的值发生更改时调用。

on("incomingCall", TeamsIncomingCallEvent)

订阅传入Call 事件的函数。

function on(event: "incomingCall", listener: TeamsIncomingCallEvent)

参数

event

"incomingCall"

事件名称。

listener

TeamsIncomingCallEvent

回调 fn，将在此 callAgent 收到传入呼叫时调用。

startCall((PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartTeamsGroupCallOptions)

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

启动 1：N 调用。

function startCall(participants: (PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartTeamsGroupCallOptions): TeamsCall

参数

participants

(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]

options

StartTeamsGroupCallOptions

返回

TeamsCall

与调用关联的 TeamsCall 对象。

startCall(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, StartTeamsCallOptions)

开始 1：1 呼叫。

function startCall(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, options?: StartTeamsCallOptions): TeamsCall

参数

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

options

StartTeamsCallOptions

返回

TeamsCall

与调用关联的 TeamsCall 对象。

继承的方法详细信息

dispose()

释放此呼叫代理

function dispose(): Promise<void>

返回

Promise<void>

继承自CallAgentCommon.dispose

feature<TFeature>(CallAgentFeatureFactory<TFeature>)

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

使用扩展 API 检索已初始化和备忘录化的功能对象。 检查对象 Features.* 中是否有此包中所有可用的扩展调用代理功能。

function feature<TFeature>(factory: CallAgentFeatureFactory<TFeature>): TFeature

参数

factory

CallAgentFeatureFactory<TFeature>

提供扩展 API 的调用代理功能构造函数的工厂。

返回

TFeature

继承自CallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

注意

此 API 以 Beta 版本预览形式提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

处理推送通知。

function handlePushNotification(data: IncomingCallPushNotificationData): Promise<void>

参数

data

IncomingCallPushNotificationData

推送通知数据

返回

Promise<void>

继承自CallAgentCommon.handlePushNotification