IUserTokenProvider interface
Предупреждение
Теперь этот API является нерекомендуемым.
Use UserTokenClient instead.
Интерфейс api OAuth маркера пользователя для BotAdapters
Методы
| get |
Подписывает пользователя с помощью сервера токенов. |
| get |
Возвращает ссылку для входа с сервера токенов, который можно отправить в рамках SigninCard. |
| get |
Извлекает состояние токена для каждого настроенного подключения для данного пользователя с помощью appCredentials бота. |
| get |
Извлекает маркер OAuth для пользователя, который находится в потоке входа. |
| sign |
Подписывает пользователя с помощью сервера токенов. |
Сведения о методе
getAadTokens(TurnContext, string, string[])
Подписывает пользователя с помощью сервера токенов.
function getAadTokens(context: TurnContext, connectionName: string, resourceUrls: string[]): Promise<[key: string]: TokenResponse>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- resourceUrls
-
string[]
Возвращаемое значение
Promise<[key: string]: TokenResponse>
getSignInLink(TurnContext, string)
Возвращает ссылку для входа с сервера токенов, который можно отправить в рамках SigninCard.
function getSignInLink(context: TurnContext, connectionName: string): Promise<string>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
Возвращаемое значение
Promise<string>
getTokenStatus(TurnContext, string, string, any)
Извлекает состояние токена для каждого настроенного подключения для данного пользователя с помощью appCredentials бота.
function getTokenStatus(context: TurnContext, userId: string, includeFilter?: string, oAuthAppCredentials?: any): Promise<any[]>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- userId
-
string
Идентификатор пользователя, для которого извлекается состояние маркера.
- includeFilter
-
string
Разделенный запятыми список включаемых подключений. Пустой возвращает состояние маркера для всех настроенных подключений.
- oAuthAppCredentials
-
any
Учетные данные приложения для OAuth.
Возвращаемое значение
Promise<any[]>
getUserToken(TurnContext, string, string)
Извлекает маркер OAuth для пользователя, который находится в потоке входа.
function getUserToken(context: TurnContext, connectionName: string, magicCode?: string): Promise<TokenResponse>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- magicCode
-
string
(Необязательно) Необязательный введенный пользователем код для проверки.
Возвращаемое значение
Promise<TokenResponse>
signOutUser(TurnContext, string, string)
Подписывает пользователя с помощью сервера токенов.
function signOutUser(context: TurnContext, connectionName: string, userId?: string): Promise<void>Параметры
- context
- TurnContext
Контекст для текущего шага беседы с пользователем.
- connectionName
-
string
Имя используемого подключения проверки подлинности.
- userId
-
string
Идентификатор пользователя для выхода.
Возвращаемое значение
Promise<void>