@azure/communication-common package

Kelas

AzureCommunicationTokenCredential

Implementasi CommunicationTokenCredential dengan dukungan untuk refresh token proaktif.

Antarmuka

CommunicationGetTokenOptions	Opsi untuk CommunicationTokenCredentialgetToken fungsi.
CommunicationTokenCredential	Kredensial token Azure Communication Services.
CommunicationTokenRefreshOptions	Opsi untuk menyegarkan kredensial Token Komunikasi secara otomatis.
CommunicationUserIdentifier	Pengguna Azure Communication.
CommunicationUserKind	IdentifierKind untuk CommunicationUserIdentifier.
MicrosoftTeamsAppIdentifier	Aplikasi Microsoft Teams.
MicrosoftTeamsAppKind	IdentifierKind untuk MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier	Pengguna Microsoft Teams.
MicrosoftTeamsUserKind	IdentifierKind untuk MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier	Nomor telepon.
PhoneNumberKind	IdentifierKind untuk PhoneNumberIdentifier.
UnknownIdentifier	Pengidentifikasi tidak diketahui yang tidak sesuai dengan jenis pengidentifikasi lainnya.
UnknownIdentifierKind	IdentifierKind untuk UnknownIdentifier.

Alias Jenis

CommunicationIdentifier	Mengidentifikasi peserta komunikasi.
CommunicationIdentifierKind	CommunicationIdentifierKind adalah gabungan diskriminasi yang menambahkan properti kind ke Pengidentifikasi.

Fungsi

createIdentifierFromRawId(string)	Membuat CommunicationIdentifierKind dari rawId tertentu. Saat menyimpan rawId, gunakan fungsi ini untuk memulihkan pengidentifikasi yang dikodekan dalam rawId.
getIdentifierKind(CommunicationIdentifier)	Mengembalikan CommunicationIdentifierKind untuk CommunicationIdentifier tertentu. Mengembalikan tidak terdefinisi jika jenis tidak dapat disimpulkan.
getIdentifierRawId(CommunicationIdentifier)	Mengembalikan rawId untuk CommunicationIdentifier tertentu. Anda dapat menggunakan rawId untuk mengodekan pengidentifikasi lalu menggunakannya sebagai kunci dalam database.
isCommunicationUserIdentifier(CommunicationIdentifier)	Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi mengimplementasikan CommunicationUserIdentifier.
isKeyCredential(unknown)	Memeriksa apakah nilai adalah KeyCredential.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)	Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi menerapkan MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)	Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi mengimplementasikan MicrosoftTeamsUserIdentifier.
isPhoneNumberIdentifier(CommunicationIdentifier)	Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi mengimplementasikan PhoneNumberIdentifier.
isUnknownIdentifier(CommunicationIdentifier)	Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi tidak dikenal.

Detail Fungsi

createIdentifierFromRawId(string)

Membuat CommunicationIdentifierKind dari rawId tertentu. Saat menyimpan rawId, gunakan fungsi ini untuk memulihkan pengidentifikasi yang dikodekan dalam rawId.

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Parameter

rawId

string

rawId yang akan diterjemahkan ke representasi pengidentifikasinya.

Mengembalikan

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Mengembalikan CommunicationIdentifierKind untuk CommunicationIdentifier tertentu. Mengembalikan tidak terdefinisi jika jenis tidak dapat disimpulkan.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Parameter

identifier

CommunicationIdentifier

Pengidentifikasi yang jenisnya akan disimpulkan.

Mengembalikan

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Mengembalikan rawId untuk CommunicationIdentifier tertentu. Anda dapat menggunakan rawId untuk mengodekan pengidentifikasi lalu menggunakannya sebagai kunci dalam database.

function getIdentifierRawId(identifier: CommunicationIdentifier): string

Parameter

identifier

CommunicationIdentifier

Pengidentifikasi yang akan diterjemahkan ke rawId-nya.

Mengembalikan

string

isCommunicationUserIdentifier(CommunicationIdentifier)

Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi mengimplementasikan CommunicationUserIdentifier.

function isCommunicationUserIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

CommunicationUserIdentifier yang diasumsikan untuk diuji.

Mengembalikan

identifier

isKeyCredential(unknown)

Memeriksa apakah nilai adalah KeyCredential.

function isKeyCredential(credential: unknown): credential

Parameter

credential

unknown

Kredensial sedang diperiksa.

Mengembalikan

credential

isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi menerapkan MicrosoftTeamsAppIdentifier.

function isMicrosoftTeamsAppIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

yang diasumsikan tersedia untuk diuji.

Mengembalikan

identifier

isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi mengimplementasikan MicrosoftTeamsUserIdentifier.

function isMicrosoftTeamsUserIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

yang diasumsikan tersedia untuk diuji.

Mengembalikan

identifier

isPhoneNumberIdentifier(CommunicationIdentifier)

Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi mengimplementasikan PhoneNumberIdentifier.

function isPhoneNumberIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

PhoneNumberIdentifier yang diasumsikan untuk diuji.

Mengembalikan

identifier

isUnknownIdentifier(CommunicationIdentifier)

Menguji Pengidentifikasi untuk menentukan apakah pengidentifikasi tidak dikenal.

function isUnknownIdentifier(identifier: CommunicationIdentifier): identifier

Parameter

identifier

CommunicationIdentifier

UnknownIdentifier yang diasumsikan akan diuji.

Mengembalikan

identifier