CommunicationIdentityClient class

Пакет:

@azure/communication-identity

Клиентский класс для взаимодействия с управлением пользовательскими маркерами Служб коммуникации Azure.

Конструкторы

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)	Инициализирует новый экземпляр класса CommunicationIdentity.
CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)	Инициализирует новый экземпляр класса CommunicationIdentity с помощью Azure KeyCredential.
CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)	Инициализирует новый экземпляр класса CommunicationIdentity с помощью TokenCredential.

Методы

createUser(OperationOptions)	Создает одного пользователя.
createUserAndToken(TokenScope[], CreateUserAndTokenOptions)	Создает одного пользователя и токен одновременно.
deleteUser(CommunicationUserIdentifier, OperationOptions)	Активирует событие отзыва для пользователя и удаляет все данные.
getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)	Создает маркер пользователя с областью действия.
getTokenForTeamsUser(GetTokenForTeamsUserOptions)	Обмен маркером доступа Azure AD пользователя Teams для нового маркера доступа к удостоверениям связи с соответствующим сроком действия.
revokeTokens(CommunicationUserIdentifier, OperationOptions)	Отменяет все данные и маркеры, созданные для пользователя.

Сведения о конструкторе

CommunicationIdentityClient(string, CommunicationIdentityClientOptions)

Инициализирует новый экземпляр класса CommunicationIdentity.

new CommunicationIdentityClient(connectionString: string, options?: CommunicationIdentityClientOptions)

Параметры

connectionString

string

Строка подключения для подключения к ресурсу Службы коммуникации Azure. Пример: endpoint=https://contoso.eastus.communications.azure.net/; accesskey=secret";

options

CommunicationIdentityClientOptions

Необязательный. Параметры настройки конвейера HTTP.

CommunicationIdentityClient(string, KeyCredential, CommunicationIdentityClientOptions)

Инициализирует новый экземпляр класса CommunicationIdentity с помощью Azure KeyCredential.

new CommunicationIdentityClient(endpoint: string, credential: KeyCredential, options?: CommunicationIdentityClientOptions)

Параметры

endpoint

string

Конечная точка службы (например, https://contoso.eastus.communications.azure.net).

credential

KeyCredential

Объект, используемый для проверки подлинности запросов к службе. Используйте AzureKeyCredential или @azure/identity для создания учетных данных.

options

CommunicationIdentityClientOptions

Необязательный. Параметры настройки конвейера HTTP.

CommunicationIdentityClient(string, TokenCredential, CommunicationIdentityClientOptions)

Инициализирует новый экземпляр класса CommunicationIdentity с помощью TokenCredential.

new CommunicationIdentityClient(endpoint: string, credential: TokenCredential, options?: CommunicationIdentityClientOptions)

Параметры

endpoint

string

Конечная точка службы (например, https://contoso.eastus.communications.azure.net)

credential

TokenCredential

TokenCredential, используемый для проверки подлинности запросов к службе.

options

CommunicationIdentityClientOptions

Необязательный. Параметры настройки конвейера HTTP.

Сведения о методе

createUser(OperationOptions)

Создает одного пользователя.

function createUser(options?: OperationOptions): Promise<CommunicationUserIdentifier>

Параметры

options

OperationOptions

Дополнительные параметры запроса.

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

Promise<CommunicationUserIdentifier>

createUserAndToken(TokenScope[], CreateUserAndTokenOptions)

Создает одного пользователя и токен одновременно.

function createUserAndToken(scopes: TokenScope[], options?: CreateUserAndTokenOptions): Promise<CommunicationUserToken>

Параметры

scopes

TokenScope[]

Области, которые необходимо включить в маркер.

options

CreateUserAndTokenOptions

Дополнительные параметры запроса.

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

Promise<CommunicationUserToken>

deleteUser(CommunicationUserIdentifier, OperationOptions)

Активирует событие отзыва для пользователя и удаляет все данные.

function deleteUser(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>

Параметры

user

CommunicationUserIdentifier

Пользователь, удаляемый.

options

OperationOptions

Дополнительные параметры запроса.

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

Promise<void>

getToken(CommunicationUserIdentifier, TokenScope[], GetTokenOptions)

Создает маркер пользователя с областью действия.

function getToken(user: CommunicationUserIdentifier, scopes: TokenScope[], options?: GetTokenOptions): Promise<CommunicationAccessToken>

Параметры

user

CommunicationUserIdentifier

Пользователь, маркеры которого выдаются.

scopes

TokenScope[]

Области, которые необходимо включить в маркер.

options

GetTokenOptions

Дополнительные параметры запроса.

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

Promise<CommunicationAccessToken>

getTokenForTeamsUser(GetTokenForTeamsUserOptions)

Обмен маркером доступа Azure AD пользователя Teams для нового маркера доступа к удостоверениям связи с соответствующим сроком действия.

function getTokenForTeamsUser(options: GetTokenForTeamsUserOptions): Promise<CommunicationAccessToken>

Параметры

options

GetTokenForTeamsUserOptions

Параметры, используемые для обмена маркером доступа Azure AD пользователя Teams для нового маркера доступа к удостоверениям связи.

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

Promise<CommunicationAccessToken>

revokeTokens(CommunicationUserIdentifier, OperationOptions)

Отменяет все данные и маркеры, созданные для пользователя.

function revokeTokens(user: CommunicationUserIdentifier, options?: OperationOptions): Promise<void>

Параметры

user

CommunicationUserIdentifier

Пользователь, маркеры которого отозваны.

options

OperationOptions

Дополнительные параметры запроса.

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

Promise<void>