CallAgent interface
CallAgent は、呼び出しを処理するために使用されます。
- Extends
プロパティ
| calls | 呼び出しを取得します。 |
| display |
すべての新しい通話のローカル参加者の表示名を取得します。 |
継承されたプロパティ
| connection |
接続状態を取得します。 |
| kind | 呼び出しエージェント オブジェクトの種類を取得します。 |
メソッド
継承されたメソッド
| dispose() | この呼び出しエージェントを破棄する |
| feature<TFeature>(Call |
拡張 API を使用して初期化およびメモ化された Feature オブジェクトを取得します。 このパッケージで使用可能なすべての拡張通話エージェント機能については、オブジェクトの機能*を確認してください。 |
| handle |
プッシュ通知を処理します。 |
プロパティの詳細
calls
呼び出しを取得します。
calls: readonly Call[]プロパティ値
readonly Call[]
displayName
すべての新しい通話のローカル参加者の表示名を取得します。
displayName?: stringプロパティ値
string
継承されたプロパティの詳細
connectionState
接続状態を取得します。
connectionState: ConnectionStateプロパティ値
callAgentCommon.connectionState
kind
メソッドの詳細
join(GroupCallLocator, JoinCallOptions)
グループ呼び出しに参加します。 グループ呼び出しに参加するには、groupId を渡します。
function join(groupLocator: GroupCallLocator, options?: JoinCallOptions): Callパラメーター
- groupLocator
- GroupCallLocator
グループ通話情報。
- options
- JoinCallOptions
通話開始オプション。
戻り値
呼び出しに関連付けられている Call オブジェクト。
join(GroupChatCallLocator, JoinCallOptions)
注意
この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この API は運用環境で使用しないでください。
グループ チャット通話に参加します。 グループ チャット呼び出しに参加するには、threadId を渡します。
function join(groupChatCallLocator: GroupChatCallLocator, options?: JoinCallOptions): Callパラメーター
- groupChatCallLocator
- GroupChatCallLocator
GroupChat の通話情報。
- options
- JoinCallOptions
通話開始オプション。
戻り値
呼び出しに関連付けられている Call オブジェクト。
join(MeetingLocator, JoinCallOptions)
注意
この API はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この 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>)
callsUpdated イベントの Unsubscribe 関数。
function off(event: "callsUpdated", listener: CollectionUpdatedEvent<Call>)パラメーター
- event
-
"callsUpdated"
イベント名。
- listener
このイベントのサブスクライブに使用されたコールバック fn。
off("connectionStateChanged", ConnectionStateChangedEvent)
connectionStateChanged イベントの Unsubscribe 関数。
function off(event: "connectionStateChanged", listener: ConnectionStateChangedEvent)パラメーター
- event
-
"connectionStateChanged"
イベント名。
- listener
- ConnectionStateChangedEvent
このプロパティの値が変更されたときに呼び出されるコールバック fn。
off("incomingCall", IncomingCallEvent)
incomingCall イベントの Unsubscribe 関数。
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 イベントのサブスクライブ関数。
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
この callAgent が着信呼び出しを受信するときに呼び出されるコールバック fn。
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 はベータ版で、開発者向けにプレビューとして提供されており、寄せられたフィードバックに基づいて変更される場合があります。 この 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>パラメーター
プッシュ通知データ
戻り値
Promise<void>