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

UserTokenClientImpl class

  • Ссылка
Пакет:
botframework-connector
Extends
UserTokenClient

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

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions)

Методы

exchangeToken(string, string, string, TokenExchangeRequest)

Выполняет операцию обмена маркерами, например для единого входа.
getAadTokens(string, string, string[], string)

Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении.
getSignInResource(string, Activity, string)

Асинхронно получение ресурса необработанного входа для отправки пользователю для входа.
getTokenStatus(string, string, string)

Извлекает состояние токена для каждого настроенного подключения для данного пользователя.
getUserToken(string, string, string, string)

Пытается получить маркер для пользователя, который находится в потоке входа.
signOutUser(string, string, string)

Подписывает пользователя с помощью сервера токенов.

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

UserTokenClientImpl(string, ServiceClientCredentials, string, ConnectorClientOptions) 

new UserTokenClientImpl(appId: string, credentials: ServiceClientCredentials, oauthEndpoint: string, connectorClientOptions?: ConnectorClientOptions)

Параметры

appId

string

Идентификатор приложения.

credentials

ServiceClientCredentials

AppCredentials для OAuth.

oauthEndpoint

string

Конечная точка API OAuth.

connectorClientOptions
ConnectorClientOptions

Объект ConnectorClientOptions.

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

exchangeToken(string, string, string, TokenExchangeRequest)

Выполняет операцию обмена маркерами, например для единого входа.

function exchangeToken(userId: string, connectionName: string, channelId: string, exchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

Параметры

userId

string

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

connectionName

string

Имя используемого подключения проверки подлинности.

channelId

string

Идентификатор канала, связанный с маркером.

exchangeRequest

TokenExchangeRequest

Сведения о запросе на обмен, маркер для обмена или URI для обмена.

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

Promise<TokenResponse>

Обещание, представляющее результат операции.

getAadTokens(string, string, string[], string)

Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении.

function getAadTokens(userId: string, connectionName: string, resourceUrls: string[], channelId: string): Promise<Record<string, TokenResponse>>

Параметры

userId

string

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

connectionName

string

Имя используемого подключения проверки подлинности.

resourceUrls

string[]

Список URL-адресов ресурсов для получения маркеров.

channelId

string

Идентификатор канала, связанный с маркером.

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

Promise<Record<string, TokenResponse>>

Обещание словаря resourceUrl соответствующему TokenResponse.

getSignInResource(string, Activity, string)

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

function getSignInResource(connectionName: string, activity: Activity, finalRedirect: string): Promise<SignInUrlResponse>

Параметры

connectionName

string

Имя используемого подключения проверки подлинности.

activity

Activity

Действие, из которого следует наследовать состояние обмена маркерами.

finalRedirect

string

Окончательный URL-адрес, на который будет перенаправлен поток OAuth.

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

Promise<SignInUrlResponse>

Ресурс signInUrlResponse .

getTokenStatus(string, string, string)

Извлекает состояние токена для каждого настроенного подключения для данного пользователя.

function getTokenStatus(userId: string, channelId: string, includeFilter: string): Promise<TokenStatus[]>

Параметры

userId

string

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

channelId

string

Идентификатор канала, связанный с маркером.

includeFilter

string

IncludeFilter.

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

Promise<TokenStatus[]>

Обещание с массивом состояния токена.

getUserToken(string, string, string, string)

Пытается получить маркер для пользователя, который находится в потоке входа.

function getUserToken(userId: string, connectionName: string, channelId: string, magicCode: string): Promise<TokenResponse>

Параметры

userId

string

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

connectionName

string

Имя используемого подключения проверки подлинности.

channelId

string

Идентификатор канала, связанный с маркером.

magicCode

string

(Необязательно) Необязательный введенный пользователем код для проверки.

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

Promise<TokenResponse>

Ответ маркера.

signOutUser(string, string, string)

Подписывает пользователя с помощью сервера токенов.

function signOutUser(userId: string, connectionName: string, channelId: string): Promise<void>

Параметры

userId

string

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

connectionName

string

Имя используемого подключения проверки подлинности.

channelId

string

Идентификатор канала, связанный с маркером.

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

Promise<void>