共用方式為


TeamsCallAgent interface

TeamsCallAgent 可用來處理 Teams 通話。

Extends

屬性

calls

取得呼叫。

繼承的屬性

connectionState

取得連線狀態。

kind

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

方法

join(MeetingLocator, JoinCallOptions)

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

join(TeamsMeetingIdLocator, JoinCallOptions)

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

join(TeamsMeetingLinkLocator, JoinCallOptions)

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

off("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

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

off("connectionStateChanged", ConnectionStateChangedEvent)

connectionStateChanged 事件的取消訂閱函式。

off("incomingCall", TeamsIncomingCallEvent)

取消訂閱 incomingCall 事件的函式。

on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)

callsUpdated 事件的訂閱函式。

on("connectionStateChanged", ConnectionStateChangedEvent)

connectionStateChanged 事件的 Subscribe 函式。

on("incomingCall", TeamsIncomingCallEvent)

incomingCall 事件的訂閱函式。

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

屬性值

繼承自CallAgentCommon.connectionState

kind

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

kind: CallAgentKind

屬性值

繼承自CallAgentCommon.kind

方法詳細資料

join(MeetingLocator, JoinCallOptions)

注意

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

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

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

參數

meetingLocator
MeetingLocator

會議資訊。

options
JoinCallOptions

Teams 通話開始選項。

傳回

與呼叫相關聯的TeamsCall物件。

join(TeamsMeetingIdLocator, JoinCallOptions)

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

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

參數

meetingLocator
TeamsMeetingIdLocator

會議資訊。

options
JoinCallOptions

呼叫開始選項。

傳回

與呼叫相關聯的 Call 物件。

join(TeamsMeetingLinkLocator, JoinCallOptions)

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

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

參數

meetingLocator
TeamsMeetingLinkLocator

會議資訊。

options
JoinCallOptions

呼叫開始選項。

傳回

與呼叫相關聯的 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)

取消訂閱 incomingCall 事件的函式。

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)

incomingCall 事件的訂閱函式。

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

參數

傳回

與呼叫相關聯的TeamsCall物件。

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

開始 1:1 通話。

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

傳回

TFeature

繼承自CallAgentCommon.feature

handlePushNotification(IncomingCallPushNotificationData)

注意

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

處理推播通知。

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

參數

data
IncomingCallPushNotificationData

推播通知數據

傳回

Promise<void>

繼承自CallAgentCommon.handlePushNotification