CallInfo interface

パッケージ:

@azure/communication-calling

通話に関する情報。

Extends

CallInfoCommon

プロパティ

groupId	CallAgent.join(groupLocator: GroupLocator) API を使用して呼び出しに参加した場合は、呼び出しのグループ ID を取得します。
roomId	CallAgent.join(roomLocator: RoomLocator) API を使用して呼び出しに参加した場合は、呼び出しの Room ID を取得します。

継承されたプロパティ

callScenario	呼び出しの呼び出しの種類を取得します
context	呼び出しの詳細を取得するために必要な追加情報コンテキストを取得する
direction	発信または着信の通話方向を取得する
initiatorKind	呼び出しのイニシエーターの種類を取得する
participantId	ローカル参加者 ID を取得する
targetKind	呼び出しのイニシエーター ターゲットの種類を取得する
threadId	チーム会議の threadId ID を取得します。

継承されたメソッド

getServerCallId()

サーバー呼び出し ID を取得します。

プロパティの詳細

groupId

CallAgent.join(groupLocator: GroupLocator) API を使用して呼び出しに参加した場合は、呼び出しのグループ ID を取得します。

groupId: undefined | string

プロパティ値

undefined | string

roomId

注意

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

CallAgent.join(roomLocator: RoomLocator) API を使用して呼び出しに参加した場合は、呼び出しの Room ID を取得します。

roomId: undefined | string

プロパティ値

undefined | string

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

callScenario

注意

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

呼び出しの呼び出しの種類を取得します

callScenario?: CallInformationScenario

プロパティ値

CallInformationScenario

CallInfoCommon.callScenario から継承された

context

注意

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

呼び出しの詳細を取得するために必要な追加情報コンテキストを取得する

context?: CallInformationContext

プロパティ値

CallInformationContext

CallInfoCommon.context から継承された

direction

注意

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

発信または着信の通話方向を取得する

direction?: CallDirection

プロパティ値

CallDirection

callInfoCommon.direction から継承

initiatorKind

注意

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

呼び出しのイニシエーターの種類を取得する

initiatorKind?: CallInformationIdentifierKind

プロパティ値

CallInformationIdentifierKind

callInfoCommon.initiatorKind から継承

participantId

ローカル参加者 ID を取得する

participantId: string

プロパティ値

string

CallInfoCommon.participantId から継承された

targetKind

注意

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

呼び出しのイニシエーター ターゲットの種類を取得する

targetKind?: string

プロパティ値

string

CallInfoCommon.targetKind から継承された

threadId

チーム会議の threadId ID を取得します。

threadId: undefined | string

プロパティ値

undefined | string

callInfoCommon.threadId から継承

継承済みメソッドの詳細

getServerCallId()

サーバー呼び出し ID を取得します。

function getServerCallId(): Promise<string>

戻り値

Promise<string>

CallInfoCommon.getServerCallId から継承された