@azure/communication-common package
Классы
| AzureCommunicationTokenCredential |
Реализация CommunicationTokenCredential с поддержкой упреждающего обновления маркера. |
Интерфейсы
| CommunicationGetTokenOptions |
Параметры функции |
| 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 — это дискриминированный союз, который добавляет свойство |
Функции
| create |
Создает CommunicationIdentifierKind из заданного rawId. При хранении необработанных идентификаторов эта функция используется для восстановления идентификатора, закодированного в rawId. |
| get |
Возвращает CommunicationIdentifierKind для заданного Параметра CommunicationIdentifier. Возвращает неопределенное значение, если тип не может быть выведен. |
| get |
Возвращает необработанный идентификатор для заданного объекта CommunicationIdentifier. Вы можете использовать необработанный идентификатор для кодирования идентификатора, а затем использовать его в качестве ключа в базе данных. |
| is |
Проверяет идентификатор, чтобы определить, реализуется ли он CommunicationUserIdentifier. |
| is |
Проверяет, является ли значение keyCredential. |
| is |
Проверяет идентификатор, чтобы определить, реализуется ли он MicrosoftTeamsAppIdentifier. |
| is |
Проверяет идентификатор, чтобы определить, реализуется ли он MicrosoftTeamsUserIdentifier. |
| is |
Проверяет идентификатор, чтобы определить, реализуется ли он PhoneNumberIdentifier. |
| is |
Проверяет идентификатор, чтобы определить, реализуется ли он UnknownIdentifier. |
Сведения о функции
createIdentifierFromRawId(string)
Создает CommunicationIdentifierKind из заданного rawId. При хранении необработанных идентификаторов эта функция используется для восстановления идентификатора, закодированного в rawId.
function createIdentifierFromRawId(rawId: string): CommunicationIdentifierKindПараметры
- rawId
-
string
Необработанный идентификатор, который необходимо преобразовать в его представление идентификатора.
Возвращаемое значение
getIdentifierKind(CommunicationIdentifier)
Возвращает CommunicationIdentifierKind для заданного Параметра CommunicationIdentifier. Возвращает неопределенное значение, если тип не может быть выведен.
function getIdentifierKind(identifier: CommunicationIdentifier): CommunicationIdentifierKindПараметры
- identifier
- CommunicationIdentifier
Идентификатор, тип которого должен быть выведен.
Возвращаемое значение
getIdentifierRawId(CommunicationIdentifier)
Возвращает необработанный идентификатор для заданного объекта CommunicationIdentifier. Вы можете использовать необработанный идентификатор для кодирования идентификатора, а затем использовать его в качестве ключа в базе данных.
function getIdentifierRawId(identifier: CommunicationIdentifier): stringПараметры
- identifier
- CommunicationIdentifier
Идентификатор, который необходимо преобразовать в необработанный идентификатор.
Возвращаемое значение
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