@azure/communication-common package

類別

AzureCommunicationTokenCredential

具有主動式令牌重新整理支援的 CommunicationTokenCredential 實作。

介面

CommunicationGetTokenOptions

CommunicationTokenCredential getToken 函式的選項。

CommunicationTokenCredential

Azure 通訊服務令牌認證。

CommunicationTokenRefreshOptions

自動重新整理通訊令牌認證的選項。

CommunicationUserIdentifier

Azure 通訊使用者。

CommunicationUserKind

CommunicationUserIdentifier 的 IdentifierKind。

EntraCommunicationTokenCredentialOptions

Entra 通信令牌選項。

MicrosoftTeamsAppIdentifier

Microsoft Teams 應用程式。

MicrosoftTeamsAppKind

MicrosoftTeamsAppIdentifier 的 IdentifierKind。

MicrosoftTeamsUserIdentifier

Microsoft Teams 使用者。

MicrosoftTeamsUserKind

MicrosoftTeamsUserIdentifier 的 IdentifierKind。

PhoneNumberIdentifier

電話號碼。

PhoneNumberKind

PhoneNumberIdentifier 的 IdentifierKind。

TeamsExtensionUserIdentifier

使用 Azure 通訊服務資源擴展其 Teams 電話設置的 Microsoft Teams 電話使用者。

TeamsExtensionUserKind

IdentifierKind 的 TeamsExtensionUserIdentifier。

UnknownIdentifier

不符合任何其他識別碼類型的未知識別碼。

UnknownIdentifierKind

UnknownIdentifier 的 IdentifierKind。

類型別名

CommunicationIdentifier

識別通訊參與者。

CommunicationIdentifierKind

CommunicationIdentifierKind 是一種歧視聯集,會將屬性 kind 新增至 Identifier。

函式

isRestError(unknown)

RestError 的 Typeguard

變數

RestError

失敗管線要求的自定義錯誤類型。

createIdentifierFromRawId

從指定的 rawId 建立 CommunicationIdentifierKind。 儲存rawId時,使用此函式來還原rawId中編碼的標識碼。

getIdentifierKind

傳回指定 CommunicationIdentifier 的 CommunicationIdentifierKind。 如果無法推斷種類,則傳回未定義。

getIdentifierRawId

傳回指定 CommunicationIdentifier 的 rawId。 您可以使用rawId來編碼標識碼,然後將它當做資料庫中的索引鍵使用。

isCommunicationUserIdentifier

測試標識符,以判斷它是否實作 CommunicationUserIdentifier。

isKeyCredential

檢查值是否為 KeyCredential。

isMicrosoftTeamsAppIdentifier

測試標識符,以判斷它是否實作 MicrosoftTeamsAppIdentifier。

isMicrosoftTeamsUserIdentifier

測試標識符,以判斷它是否實作 MicrosoftTeamsUserIdentifier。

isPhoneNumberIdentifier

測試標識碼,以判斷它是否實作 PhoneNumberIdentifier。

isTeamsExtensionUserIdentifier

測試Identifier以確定它是否實現TeamsExtensionUserIdentifier。

isUnknownIdentifier

測試標識碼,以判斷它是否實作 UnknownIdentifier。

函式詳細資料

isRestError(unknown)

RestError 的 Typeguard

function isRestError(e: unknown): e is RestError

參數

e

unknown

catch 子句攔截到的東西。

傳回

e is RestError

變數詳細資料

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型

createIdentifierFromRawId

從指定的 rawId 建立 CommunicationIdentifierKind。 儲存rawId時,使用此函式來還原rawId中編碼的標識碼。

createIdentifierFromRawId: (rawId: string) => CommunicationIdentifierKind

類型

(rawId: string) => CommunicationIdentifierKind

getIdentifierKind

傳回指定 CommunicationIdentifier 的 CommunicationIdentifierKind。 如果無法推斷種類,則傳回未定義。

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

測試Identifier以確定它是否實現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