Sdílet prostřednictvím

@azure/communication-common package

  • Reference

Třídy

AzureCommunicationTokenCredential

Implementace CommunicationTokenCredential s podporou proaktivní aktualizace tokenů.

Rozhraní

CommunicationGetTokenOptions

Možnosti funkce CommunicationTokenCredentialgetToken
CommunicationTokenCredential

Přihlašovací údaje tokenu Azure Communication Services.
CommunicationTokenRefreshOptions

Možnosti automatické aktualizace přihlašovacích údajů komunikačního tokenu
CommunicationUserIdentifier

Uživatel služby Azure Communication.
CommunicationUserKind

IdentifierKind pro CommunicationUserIdentifier.
MicrosoftTeamsAppIdentifier

Aplikace Microsoft Teams.
MicrosoftTeamsAppKind

IdentifierKind pro MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier

Uživatel Microsoft Teams.
MicrosoftTeamsUserKind

IdentifierKind pro MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier

Telefonní číslo.
PhoneNumberKind

IdentifierKind pro PhoneNumberIdentifier.
UnknownIdentifier

Neznámý identifikátor, který neodpovídá žádnému z ostatních typů identifikátorů.
UnknownIdentifierKind

IdentifierKind pro UnknownIdentifier.

Aliasy typu

CommunicationIdentifier

Identifikuje účastníka komunikace.
CommunicationIdentifierKind

CommunicationIdentifierKind je diskriminované sjednocení, které přidává vlastnost kind identifikátoru.

Funkce

createIdentifierFromRawId(string)

Vytvoří CommunicationIdentifierKind z daného identifikátoru rawId. Při ukládání identifikátorů rawId použijte tuto funkci k obnovení identifikátoru, který byl kódován v rawId.
getIdentifierKind(CommunicationIdentifier)

Vrátí CommunicationIdentifierKind pro daný CommunicationIdentifier. Vrátí nedefinovanou hodnotu, pokud druh nelze odvodit.
getIdentifierRawId(CommunicationIdentifier)

Vrátí rawId pro daný CommunicationIdentifier. Pro kódování identifikátoru můžete použít rawId a pak ho použít jako klíč v databázi.
isCommunicationUserIdentifier(CommunicationIdentifier)

Testuje identifikátor k určení, zda implementuje CommunicationUserIdentifier.
isKeyCredential(unknown)

Zkontroluje, jestli je hodnota KeyCredential.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Testuje identifikátor a určí, jestli implementuje MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Testuje identifikátor a určí, jestli implementuje MicrosoftTeamsUserIdentifier.
isPhoneNumberIdentifier(CommunicationIdentifier)

Testuje identifikátor k určení, zda implementuje PhoneNumberIdentifier.
isUnknownIdentifier(CommunicationIdentifier)

Testuje identifikátor k určení, zda implementuje UnknownIdentifier.

Podrobnosti funkce

createIdentifierFromRawId(string)

Vytvoří CommunicationIdentifierKind z daného identifikátoru rawId. Při ukládání identifikátorů rawId použijte tuto funkci k obnovení identifikátoru, který byl kódován v rawId.

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Parametry

rawId

string

Identifikátor rawId, který se má přeložit na reprezentaci identifikátoru.

Návraty

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Vrátí CommunicationIdentifierKind pro daný CommunicationIdentifier. Vrátí nedefinovanou hodnotu, pokud druh nelze odvodit.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Parametry

identifier
CommunicationIdentifier

Identifikátor, jehož druh má být odvozen.

Návraty

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Vrátí rawId pro daný CommunicationIdentifier. Pro kódování identifikátoru můžete použít rawId a pak ho použít jako klíč v databázi.

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parametry

identifier
CommunicationIdentifier

Identifikátor, který se má přeložit na jeho rawId.

Návraty

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Testuje identifikátor k určení, zda implementuje CommunicationUserIdentifier.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Parametry

identifier
CommunicationIdentifier

Předpokládá se, že CommunicationUserIdentifier bude testován.

Návraty

identifier

isKeyCredential(unknown)

Zkontroluje, jestli je hodnota KeyCredential.

function isKeyCredential(credential: unknown): credential

Parametry

credential

unknown

Přihlašovací údaje, které se kontrolují.

Návraty

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Testuje identifikátor a určí, jestli implementuje MicrosoftTeamsAppIdentifier.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parametry

identifier
CommunicationIdentifier

Předpokládá se, že je k dispozici k testování.

Návraty

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Testuje identifikátor a určí, jestli implementuje MicrosoftTeamsUserIdentifier.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parametry

identifier
CommunicationIdentifier

Předpokládá se, že je k dispozici k testování.

Návraty

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Testuje identifikátor k určení, zda implementuje PhoneNumberIdentifier.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parametry

identifier
CommunicationIdentifier

Předpokládá se, že PhoneNumberIdentifier bude testován.

Návraty

identifier

isUnknownIdentifier(CommunicationIdentifier)

Testuje identifikátor k určení, zda implementuje UnknownIdentifier.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parametry

identifier
CommunicationIdentifier

Předpokládá se, že unknownIdentifier bude testován.

Návraty

identifier