@azure/communication-common package

クラス

AzureCommunicationTokenCredential

プロアクティブ トークン更新をサポートする CommunicationTokenCredential 実装。

インターフェイス

CommunicationGetTokenOptions	CommunicationTokenCredentialの getToken 関数のオプション。
CommunicationTokenCredential	Azure Communication Services トークンの資格情報。
CommunicationTokenRefreshOptions	通信トークン資格情報を自動的に更新するためのオプション。
CommunicationUserIdentifier	Azure Communication ユーザー。
CommunicationUserKind	CommunicationUserIdentifier の IdentifierKind。
EntraCommunicationTokenCredentialOptions	Entra 通信トークン オプション。
MicrosoftTeamsAppIdentifier	Microsoft Teams アプリ。
MicrosoftTeamsAppKind	MicrosoftTeamsAppIdentifier の IdentifierKind。
MicrosoftTeamsUserIdentifier	Microsoft Teams ユーザー。
MicrosoftTeamsUserKind	MicrosoftTeamsUserIdentifier の IdentifierKind。
PhoneNumberIdentifier	電話番号。
PhoneNumberKind	PhoneNumberIdentifier の IdentifierKind。
TeamsExtensionUserIdentifier	Microsoft Teams 電話のユーザーで、Azure Communication Services リソースを使用して Teams 電話のセットアップを拡張しているユーザー。
TeamsExtensionUserKind	TeamsExtensionUserIdentifier の IdentifierKind。
UnknownIdentifier	他の識別子の種類に適合しない不明な識別子。
UnknownIdentifierKind	UnknownIdentifier の IdentifierKind。

型エイリアス

CommunicationIdentifier	コミュニケーション参加者を識別します。
CommunicationIdentifierKind	CommunicationIdentifierKind は識別子にプロパティ kind を追加する判別共用体です。

関数

isRestError(unknown)

RestError の Typeguard

変数

RestError	失敗したパイプライン要求のカスタム エラーの種類。
createIdentifierFromRawId	指定された rawId から CommunicationIdentifierKind を作成します。 rawId を格納するときは、この関数を使用して、rawId でエンコードされた識別子を復元します。
getIdentifierKind	指定された CommunicationIdentifier の CommunicationIdentifierKind を返します。 型を推論できなかった場合は undefined を返します。
getIdentifierRawId	指定された CommunicationIdentifier の rawId を返します。 rawId を使用して識別子をエンコードし、データベースのキーとして使用できます。
isCommunicationUserIdentifier	識別子をテストして、CommunicationUserIdentifier が実装されているかどうかを判断します。
isKeyCredential	値が KeyCredential であるかどうかを確認します。
isMicrosoftTeamsAppIdentifier	識別子をテストして、それが MicrosoftTeamsAppIdentifier を実装しているかどうかを判断します。
isMicrosoftTeamsUserIdentifier	識別子をテストして、それが MicrosoftTeamsUserIdentifier を実装しているかどうかを判断します。
isPhoneNumberIdentifier	識別子をテストして、PhoneNumberIdentifier が実装されているかどうかを判断します。
isTeamsExtensionUserIdentifier	識別子をテストして、TeamsExtensionUserIdentifier が実装されているかどうかを判断します。
isUnknownIdentifier	識別子をテストして、UnknownIdentifier が実装されているかどうかを判断します。

関数の詳細

isRestError(unknown)

RestError の Typeguard

function isRestError(e: unknown): e is RestError

パラメーター

e

unknown

catch 句によってキャッチされる何か。

返品

e is RestError

変数の詳細

RestError

失敗したパイプライン要求のカスタム エラーの種類。

RestError: RestErrorConstructor

型

RestErrorConstructor

createIdentifierFromRawId

指定された rawId から CommunicationIdentifierKind を作成します。 rawId を格納するときは、この関数を使用して、rawId でエンコードされた識別子を復元します。

createIdentifierFromRawId: (rawId: string) => CommunicationIdentifierKind

型

(rawId: string) => CommunicationIdentifierKind

getIdentifierKind

指定された CommunicationIdentifier の CommunicationIdentifierKind を返します。 型を推論できなかった場合は undefined を返します。

getIdentifierKind: (identifier: CommunicationIdentifier) => CommunicationIdentifierKind

型

(identifier: CommunicationIdentifier) => CommunicationIdentifierKind

getIdentifierRawId

指定された CommunicationIdentifier の rawId を返します。 rawId を使用して識別子をエンコードし、データベースのキーとして使用できます。

getIdentifierRawId: (identifier: CommunicationIdentifier) => string

型

(identifier: CommunicationIdentifier) => string

isCommunicationUserIdentifier

識別子をテストして、CommunicationUserIdentifier が実装されているかどうかを判断します。

isCommunicationUserIdentifier: (identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier

型

(identifier: CommunicationIdentifier) => identifier is CommunicationUserIdentifier

isKeyCredential

値が KeyCredential であるかどうかを確認します。

isKeyCredential: (credential: unknown) => credential is KeyCredential

型

(credential: unknown) => credential is KeyCredential

isMicrosoftTeamsAppIdentifier

識別子をテストして、それが MicrosoftTeamsAppIdentifier を実装しているかどうかを判断します。

isMicrosoftTeamsAppIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifier

型

(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsAppIdentifier

isMicrosoftTeamsUserIdentifier

識別子をテストして、それが MicrosoftTeamsUserIdentifier を実装しているかどうかを判断します。

isMicrosoftTeamsUserIdentifier: (identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier

型

(identifier: CommunicationIdentifier) => identifier is MicrosoftTeamsUserIdentifier

isPhoneNumberIdentifier

識別子をテストして、PhoneNumberIdentifier が実装されているかどうかを判断します。

isPhoneNumberIdentifier: (identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifier

型

(identifier: CommunicationIdentifier) => identifier is PhoneNumberIdentifier

isTeamsExtensionUserIdentifier

識別子をテストして、TeamsExtensionUserIdentifier が実装されているかどうかを判断します。

isTeamsExtensionUserIdentifier: (identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifier

型

(identifier: CommunicationIdentifier) => identifier is TeamsExtensionUserIdentifier

isUnknownIdentifier

識別子をテストして、UnknownIdentifier が実装されているかどうかを判断します。

isUnknownIdentifier: (identifier: CommunicationIdentifier) => identifier is UnknownIdentifier

型

(identifier: CommunicationIdentifier) => identifier is UnknownIdentifier