CallConnection class
CallConnection クラスは、呼び出し接続ベースの API を表します。
メソッド
| add |
通話に参加者を追加する |
| cancel |
参加者の追加リクエストをキャンセルします。 |
| get |
呼び出しの呼び出し接続プロパティを取得する |
| get |
CallMedia の新しいインスタンスを初期化します。 |
| get |
通話から参加者を取得する |
| hang |
それ自体の呼び出しを切断するか、呼び出し全体を終了します。 |
| list |
通話からすべての参加者を取得する |
| mute |
通話から参加者をミュートします。 |
| remove |
通話から参加者を削除する |
| transfer |
通話をターゲット参加者に転送する |
コンストラクターの詳細
CallConnection(string, string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)
new CallConnection(callConnectionId: string, endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationApiClientOptionalParams)パラメーター
- callConnectionId
-
string
- endpoint
-
string
- credential
- options
-
CallAutomationApiClientOptionalParams
メソッドの詳細
addParticipant(CallInvite, AddParticipantOptions)
通話に参加者を追加する
function addParticipant(targetParticipant: CallInvite, options?: AddParticipantOptions): Promise<AddParticipantResult>パラメーター
- targetParticipant
- CallInvite
- options
- AddParticipantOptions
戻り値
Promise<AddParticipantResult>
cancelAddParticipantOperation(string, CancelAddParticipantOperationOptions)
参加者の追加リクエストをキャンセルします。
function cancelAddParticipantOperation(invitationId: string, options?: CancelAddParticipantOperationOptions): Promise<CancelAddParticipantOperationResult>パラメーター
- invitationId
-
string
参加者の追加要求をキャンセルするために使用される招待 ID。
戻り値
Promise<CancelAddParticipantOperationResult>
getCallConnectionProperties(OperationOptions)
呼び出しの呼び出し接続プロパティを取得する
function getCallConnectionProperties(options?: OperationOptions): Promise<CallConnectionProperties>パラメーター
- options
- OperationOptions
戻り値
Promise<CallConnectionProperties>
getCallMedia()
getParticipant(CommunicationIdentifier, OperationOptions)
通話から参加者を取得する
function getParticipant(targetParticipant: CommunicationIdentifier, options?: OperationOptions): Promise<CallParticipant>パラメーター
- targetParticipant
- CommunicationIdentifier
要求された参加者の通信識別子。
- options
- OperationOptions
戻り値
Promise<CallParticipant>
hangUp(boolean, OperationOptions)
それ自体の呼び出しを切断するか、呼び出し全体を終了します。
function hangUp(isForEveryone: boolean, options?: OperationOptions): Promise<void>パラメーター
- isForEveryone
-
boolean
- options
- OperationOptions
戻り値
Promise<void>
listParticipants(OperationOptions)
通話からすべての参加者を取得する
function listParticipants(options?: OperationOptions): Promise<ListParticipantsResult>パラメーター
- options
- OperationOptions
戻り値
Promise<ListParticipantsResult>
muteParticipant(CommunicationIdentifier, MuteParticipantOption)
通話から参加者をミュートします。
function muteParticipant(participant: CommunicationIdentifier, options?: MuteParticipantOption): Promise<MuteParticipantResult>パラメーター
- participant
- CommunicationIdentifier
通話からミュートされる参加者。
- options
- MuteParticipantOption
ミュート参加者の追加の属性。
戻り値
Promise<MuteParticipantResult>
removeParticipant(CommunicationIdentifier, RemoveParticipantsOption)
通話から参加者を削除する
function removeParticipant(participant: CommunicationIdentifier, options?: RemoveParticipantsOption): Promise<RemoveParticipantResult>パラメーター
- participant
- CommunicationIdentifier
参加者は通話から削除されます。
- options
- RemoveParticipantsOption
戻り値
Promise<RemoveParticipantResult>
transferCallToParticipant(CommunicationIdentifier, TransferCallToParticipantOptions)
通話をターゲット参加者に転送する
function transferCallToParticipant(targetParticipant: CommunicationIdentifier, options?: TransferCallToParticipantOptions): Promise<TransferCallResult>パラメーター
- targetParticipant
- CommunicationIdentifier
転送先のターゲット。
- options
- TransferCallToParticipantOptions
戻り値
Promise<TransferCallResult>