TeamsCallAgent interface

パッケージ:

@azure/communication-calling

TeamsCallAgent は、Teams の呼び出しを処理するために使用されます。

Extends

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>)	callsUpdated イベントの Unsubscribe 関数。
off("connectionStateChanged", ConnectionStateChangedEvent)	connectionStateChanged イベントの Unsubscribe 関数。
off("incomingCall", TeamsIncomingCallEvent)	incomingCall イベントの Unsubscribe 関数。
on("callsUpdated", CollectionUpdatedEvent<TeamsCall>)	callsUpdated イベントのサブスクライブ関数。
on("connectionStateChanged", ConnectionStateChangedEvent)	connectionStateChanged イベントのサブスクライブ関数。
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 を使用して初期化およびメモ化された Feature オブジェクトを取得します。 このパッケージで使用可能なすべての拡張通話エージェント機能については、オブジェクトの機能*を確認してください。
handlePushNotification(IncomingCallPushNotificationData)	プッシュ通知を処理します。

プロパティの詳細

calls

呼び出しを取得します。

calls: readonly TeamsCall[]

プロパティ値

readonly TeamsCall[]

継承されたプロパティの詳細

connectionState

接続状態を取得します。

connectionState: ConnectionState

プロパティ値

ConnectionState

callAgentCommon.connectionStateから継承された

kind

呼び出しエージェント オブジェクトの種類を取得します。

kind: CallAgentKind

プロパティ値

CallAgentKind

CallAgentCommon.kind から継承された

メソッドの詳細

join(MeetingLocator, JoinCallOptions)

注意

この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この 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>)

callsUpdated イベントの Unsubscribe 関数。

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

パラメーター

event

"callsUpdated"

イベント名。

listener

CollectionUpdatedEvent<TeamsCall>

このイベントのサブスクライブに使用された allback fn。

off("connectionStateChanged", ConnectionStateChangedEvent)

connectionStateChanged イベントの Unsubscribe 関数。

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

パラメーター

event

"connectionStateChanged"

イベント名。

listener

ConnectionStateChangedEvent

このプロパティの値が変更されたときに呼び出されるコールバック fn。

off("incomingCall", TeamsIncomingCallEvent)

incomingCall イベントの Unsubscribe 関数。

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 イベントのサブスクライブ関数。

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

この callAgent が着信呼び出しを受信するときに呼び出されるコールバック fn。

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

注意

この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この 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 はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この API は運用環境で使用しないでください。

拡張 API を使用して初期化およびメモ化された Feature オブジェクトを取得します。 このパッケージで使用可能なすべての拡張通話エージェント機能については、オブジェクトの機能*を確認してください。

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

パラメーター

factory

CallAgentFeatureFactory<TFeature>

拡張 API を提供する呼び出しエージェント機能コンストラクターのファクトリ。

戻り値

TFeature

callAgentCommon.feature から継承

handlePushNotification(IncomingCallPushNotificationData)

注意

この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この API は運用環境で使用しないでください。

プッシュ通知を処理します。

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

パラメーター

data

IncomingCallPushNotificationData

プッシュ通知データ

戻り値

Promise<void>

CallAgentCommon.handlePushNotification から継承された