Поделиться через

@azure/communication-common package

  • Ссылка

Классы

AzureCommunicationTokenCredential

Реализация CommunicationTokenCredential с поддержкой упреждающего обновления маркеров.

Интерфейсы

CommunicationGetTokenOptions

Параметры функции CommunicationTokenCredentialgetToken .
CommunicationTokenCredential

Учетные данные маркера Службы коммуникации Azure.
CommunicationTokenRefreshOptions

Параметры автоматического обновления учетных данных маркера связи.
CommunicationUserIdentifier

Пользователь Службы коммуникации Azure.
CommunicationUserKind

IdentifierKind для CommunicationUserIdentifier.
MicrosoftTeamsAppIdentifier

Приложение Microsoft Teams.
MicrosoftTeamsAppKind

IdentifierKind для MicrosoftTeamsAppIdentifier.
MicrosoftTeamsUserIdentifier

Пользователь Microsoft Teams.
MicrosoftTeamsUserKind

IdentifierKind для MicrosoftTeamsUserIdentifier.
PhoneNumberIdentifier

Номер телефона.
PhoneNumberKind

IdentifierKind для PhoneNumberIdentifier.
UnknownIdentifier

Неизвестный идентификатор, который не соответствует ни одному из других типов идентификаторов.
UnknownIdentifierKind

IdentifierKind для UnknownIdentifier.

Псевдонимы типа

CommunicationIdentifier

Идентифицирует участника связи.
CommunicationIdentifierKind

CommunicationIdentifierKind — это различающееся объединение, которое добавляет свойство kind к идентификатору.

Функции

createIdentifierFromRawId(string)

Создает CommunicationIdentifierKind из заданного rawId. При хранении rawId используйте эту функцию для восстановления идентификатора, который был закодирован в rawId.
getIdentifierKind(CommunicationIdentifier)

Возвращает CommunicationIdentifierKind для заданного CommunicationIdentifier. Возвращает значение undefined, если не удалось вывести тип.
getIdentifierRawId(CommunicationIdentifier)

Возвращает rawId для заданного CommunicationIdentifier. Вы можете использовать rawId для кодирования идентификатора, а затем использовать его в качестве ключа в базе данных.
isCommunicationUserIdentifier(CommunicationIdentifier)

Проверяет идентификатор, чтобы определить, реализует ли он CommunicationUserIdentifier.
isKeyCredential(unknown)

Проверяет, является ли значение KeyCredential.
isMicrosoftTeamsAppIdentifier(CommunicationIdentifier)

Проверяет идентификатор, чтобы определить, реализует ли он MicrosoftTeamsAppIdentifier.
isMicrosoftTeamsUserIdentifier(CommunicationIdentifier)

Проверяет идентификатор, чтобы определить, реализует ли он MicrosoftTeamsUserIdentifier.
isPhoneNumberIdentifier(CommunicationIdentifier)

Проверяет идентификатор, чтобы определить, реализует ли он PhoneNumberIdentifier.
isUnknownIdentifier(CommunicationIdentifier)

Проверяет идентификатор, чтобы определить, реализует ли он UnknownIdentifier.

Сведения о функции

createIdentifierFromRawId(string)

Создает CommunicationIdentifierKind из заданного rawId. При хранении rawId используйте эту функцию для восстановления идентификатора, который был закодирован в rawId.

function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKind

Параметры

rawId

string

RawId, который необходимо преобразовать в представление идентификатора.

Возвращаемое значение

CommunicationIdentifierKind

getIdentifierKind(CommunicationIdentifier)

Возвращает CommunicationIdentifierKind для заданного CommunicationIdentifier. Возвращает значение undefined, если не удалось вывести тип.

function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKind

Параметры

identifier
CommunicationIdentifier

Идентификатор, тип которого должен быть выведен.

Возвращаемое значение

CommunicationIdentifierKind

getIdentifierRawId(CommunicationIdentifier)

Возвращает rawId для заданного CommunicationIdentifier. Вы можете использовать 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