CallAgent interface

套件:

@azure/communication-calling

CallAgent 可用來處理呼叫。

Extends

CallAgentCommon

屬性

calls	取得呼叫。
displayName	取得所有新呼叫之本機參與者的顯示名稱。

繼承的屬性

connectionState	取得連線狀態。
kind	取得呼叫代理程式物件的種類。

方法

join(GroupCallLocator, JoinCallOptions)	加入群組通話。 若要加入群組呼叫，請傳遞 groupId。
join(GroupChatCallLocator, JoinCallOptions)	加入群組聊天通話。 若要加入群組聊天通話，請傳遞 threadId。
join(MeetingLocator, JoinCallOptions)	加入 Teams 會議。 若要加入 Teams 會議，請傳遞會議連結或會議座標。
join(RoomCallLocator, JoinCallOptions)	加入會議室通話。 若要加入會議室通話，請傳遞 roomId。
join(TeamsMeetingIdLocator, JoinCallOptions)	加入 Teams 會議。 若要加入 Teams 會議，請傳遞會議標識碼和密碼。
join(TeamsMeetingLinkLocator, JoinCallOptions)	加入 Teams 會議。 若要加入 Teams 會議，請傳遞會議連結。
off("callsUpdated", CollectionUpdatedEvent<Call>)	呼叫Updated 事件的取消訂閱函式。
off("connectionStateChanged", ConnectionStateChangedEvent)	connectionStateChanged 事件的取消訂閱函式。
off("incomingCall", IncomingCallEvent)	取消訂閱 incomingCall 事件的函式。
on("callsUpdated", CollectionUpdatedEvent<Call>)	callsUpdated 事件的訂閱函式。
on("connectionStateChanged", ConnectionStateChangedEvent)	connectionStateChanged 事件的 Subscribe 函式。
on("incomingCall", IncomingCallEvent)	incomingCall 事件的訂閱函式。
startCall((PhoneNumberIdentifier | CommunicationUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)	起始對參與者提供的呼叫。
startCall(CommunicationIdentifier[], StartCallOptions)	起始對參與者提供的呼叫。

繼承的方法

dispose()	處置此呼叫代理程式
feature<TFeature>(CallAgentFeatureFactory<TFeature>)	擷取具有擴充 API 的初始化和備忘功能物件。 檢查物件 Features.* ，以取得此套件中所有可用的擴充呼叫代理程式功能。
handlePushNotification(IncomingCallPushNotificationData)	處理推播通知。

屬性詳細資料

calls

取得呼叫。

calls: readonly Call[]

屬性值

readonly Call[]

displayName

取得所有新呼叫之本機參與者的顯示名稱。

displayName?: string

屬性值

string

繼承的屬性詳細資料

connectionState

取得連線狀態。

connectionState: ConnectionState

屬性值

ConnectionState

繼承自CallAgentCommon.connectionState

kind

取得呼叫代理程式物件的種類。

kind: CallAgentKind

屬性值

CallAgentKind

繼承自CallAgentCommon.kind

方法詳細資料

join(GroupCallLocator, JoinCallOptions)

加入群組通話。 若要加入群組呼叫，請傳遞 groupId。

function join(groupLocator: GroupCallLocator, options?: JoinCallOptions): Call

參數

groupLocator

GroupCallLocator

群組通話資訊。

options

JoinCallOptions

呼叫開始選項。

傳回

Call

與呼叫相關聯的 Call 物件。

join(GroupChatCallLocator, JoinCallOptions)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

加入群組聊天通話。 若要加入群組聊天通話，請傳遞 threadId。

function join(groupChatCallLocator: GroupChatCallLocator, options?: JoinCallOptions): Call

參數

groupChatCallLocator

GroupChatCallLocator

GroupChat 通話資訊。

options

JoinCallOptions

呼叫開始選項。

傳回

Call

與呼叫相關聯的 Call 物件。

join(MeetingLocator, JoinCallOptions)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

加入 Teams 會議。 若要加入 Teams 會議，請傳遞會議連結或會議座標。

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

參數

meetingLocator

MeetingLocator

會議資訊。

options

JoinCallOptions

呼叫開始選項。

傳回

Call

與呼叫相關聯的 Call 物件。

join(RoomCallLocator, JoinCallOptions)

加入會議室通話。 若要加入會議室通話，請傳遞 roomId。

function join(roomLocator: RoomCallLocator, options?: JoinCallOptions): Call

參數

roomLocator

RoomCallLocator

會議室通話資訊。

options

JoinCallOptions

呼叫開始選項。

傳回

Call

與呼叫相關聯的 Call 物件。

join(TeamsMeetingIdLocator, JoinCallOptions)

加入 Teams 會議。 若要加入 Teams 會議，請傳遞會議標識碼和密碼。

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

參數

meetingLocator

TeamsMeetingIdLocator

會議資訊。

options

JoinCallOptions

呼叫開始選項。

傳回

Call

與呼叫相關聯的 Call 物件。

join(TeamsMeetingLinkLocator, JoinCallOptions)

加入 Teams 會議。 若要加入 Teams 會議，請傳遞會議連結。

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

參數

meetingLocator

TeamsMeetingLinkLocator

會議資訊。

options

JoinCallOptions

呼叫開始選項。

傳回

Call

與呼叫相關聯的 Call 物件。

off("callsUpdated", CollectionUpdatedEvent<Call>)

呼叫Updated 事件的取消訂閱函式。

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

參數

event

"callsUpdated"

事件名稱。

listener

CollectionUpdatedEvent<Call>

回呼 fn，用來訂閱此事件。

off("connectionStateChanged", ConnectionStateChangedEvent)

connectionStateChanged 事件的取消訂閱函式。

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

參數

event

"connectionStateChanged"

事件名稱。

listener

ConnectionStateChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

off("incomingCall", IncomingCallEvent)

取消訂閱 incomingCall 事件的函式。

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

CollectionUpdatedEvent<Call>

回呼 fn，會在此集合變更時呼叫，它會傳遞已新增和移除元素的陣列。

on("connectionStateChanged", ConnectionStateChangedEvent)

connectionStateChanged 事件的 Subscribe 函式。

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

參數

event

"connectionStateChanged"

事件名稱。

listener

ConnectionStateChangedEvent

回呼 fn，會在此屬性的值變更時呼叫。

on("incomingCall", IncomingCallEvent)

incomingCall 事件的訂閱函式。

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

與已啟動呼叫相關聯的 Call 物件。

startCall(CommunicationIdentifier[], StartCallOptions)

起始對參與者提供的呼叫。

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): Call

參數

participants

CommunicationIdentifier[]

options

StartCallOptions

[開始通話] 選項。

傳回

Call

與已啟動呼叫相關聯的 Call 物件。

繼承的方法的詳細資料

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 之呼叫代理程式功能建構函式的 Factory。

傳回

TFeature

繼承自CallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

注意

此 API 處於搶鮮版 (Beta) 階段，供開發人員預覽，而且可能會根據收到的意見反應而變更。 請勿將此 API 用於生產環境。

處理推播通知。

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

參數

data

IncomingCallPushNotificationData

推播通知數據

傳回

Promise<void>

繼承自CallAgentCommon.handlePushNotification