@azure/communication-common package
クラス
| AzureCommunicationTokenCredential |
予防的なトークン更新をサポートする CommunicationTokenCredential 実装。 |
インターフェイス
| CommunicationGetTokenOptions |
|
| CommunicationTokenCredential |
Azure Communication Services トークンの資格情報。 |
| CommunicationTokenRefreshOptions |
通信トークンの資格情報を自動的に更新するためのオプション。 |
| CommunicationUserIdentifier |
Azure Communication ユーザー。 |
| CommunicationUserKind |
CommunicationUserIdentifier の IdentifierKind。 |
| MicrosoftTeamsAppIdentifier |
Microsoft Teams アプリ。 |
| MicrosoftTeamsAppKind |
MicrosoftTeamsAppIdentifier の IdentifierKind。 |
| MicrosoftTeamsUserIdentifier |
Microsoft Teams ユーザー。 |
| MicrosoftTeamsUserKind |
MicrosoftTeamsUserIdentifier の IdentifierKind。 |
| PhoneNumberIdentifier |
電話番号。 |
| PhoneNumberKind |
PhoneNumberIdentifier の IdentifierKind。 |
| UnknownIdentifier |
他の識別子の種類のいずれにも適合しない不明な識別子。 |
| UnknownIdentifierKind |
UnknownIdentifier の IdentifierKind。 |
型エイリアス
| CommunicationIdentifier |
コミュニケーション参加者を識別します。 |
| CommunicationIdentifierKind |
CommunicationIdentifierKind は識別子にプロパティ |
機能
| create |
指定された rawId から CommunicationIdentifierKind を作成します。 rawId を格納する場合は、この関数を使用して、rawId でエンコードされた識別子を復元します。 |
| get |
指定した CommunicationIdentifier の CommunicationIdentifierKind を返します。 型を推論できなかった場合は undefined を返します。 |
| get |
指定した CommunicationIdentifier の rawId を返します。 rawId を使用して識別子をエンコードし、データベースのキーとして使用できます。 |
| is |
識別子をテストして、CommunicationUserIdentifier を実装するかどうかを判断します。 |
| is |
値が KeyCredential であるかどうかを確認します。 |
| is |
識別子をテストして、それが MicrosoftTeamsAppIdentifier を実装しているかどうかを判断します。 |
| is |
識別子をテストして、それが MicrosoftTeamsUserIdentifier を実装しているかどうかを判断します。 |
| is |
識別子をテストして、PhoneNumberIdentifier が実装されているかどうかを判断します。 |
| is |
識別子をテストして、UnknownIdentifier が実装されているかどうかを判断します。 |
関数の詳細
createIdentifierFromRawId(string)
指定された rawId から CommunicationIdentifierKind を作成します。 rawId を格納する場合は、この関数を使用して、rawId でエンコードされた識別子を復元します。
function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKindパラメーター
- rawId
-
string
識別子表現に変換される rawId。
戻り値
getIdentifierKind(CommunicationIdentifier)
指定した CommunicationIdentifier の CommunicationIdentifierKind を返します。 型を推論できなかった場合は undefined を返します。
function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKindパラメーター
- identifier
- CommunicationIdentifier
型が推論される識別子。
戻り値
getIdentifierRawId(CommunicationIdentifier)
指定した CommunicationIdentifier の rawId を返します。 rawId を使用して識別子をエンコードし、データベースのキーとして使用できます。
function getIdentifierRawId(identifier: CommunicationIdentifier): stringパラメーター
- identifier
- CommunicationIdentifier
rawId に変換される識別子。
戻り値
string
isCommunicationUserIdentifier(CommunicationIdentifier)
識別子をテストして、CommunicationUserIdentifier を実装するかどうかを判断します。
function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifierパラメーター
- identifier
- CommunicationIdentifier
テスト対象の CommunicationUserIdentifier を想定しています。
戻り値
identifier
isKeyCredential(unknown)
値が KeyCredential であるかどうかを確認します。
function isKeyCredential(credential: unknown): credentialパラメーター
- credential
-
unknown
確認中の資格情報。
戻り値
credential
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)
識別子をテストして、それが MicrosoftTeamsAppIdentifier を実装しているかどうかを判断します。
function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifierパラメーター
- identifier
- CommunicationIdentifier
テストが可能であると想定されている 。
戻り値
identifier
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)
識別子をテストして、それが MicrosoftTeamsUserIdentifier を実装しているかどうかを判断します。
function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifierパラメーター
- identifier
- CommunicationIdentifier
テストが可能であると想定されている 。
戻り値
identifier
isPhoneNumberIdentifier(CommunicationIdentifier)
識別子をテストして、PhoneNumberIdentifier が実装されているかどうかを判断します。
function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifierパラメーター
- identifier
- CommunicationIdentifier
テスト対象の想定 PhoneNumberIdentifier。
戻り値
identifier
isUnknownIdentifier(CommunicationIdentifier)
識別子をテストして、UnknownIdentifier が実装されているかどうかを判断します。
function isUnknownIdentifier(identifier: CommunicationIdentifier): identifierパラメーター
- identifier
- CommunicationIdentifier
テスト対象の UnknownIdentifier を想定しています。
戻り値
identifier