UserTokenProvider Интерфейс

Ссылка

Пакет:: com.microsoft.bot.builder

Артефакт Maven:: com.microsoft.bot:bot-builder:4.14.3

public interface UserTokenProvider

Поставщик OAuth.

Сводка по методу

Модификатор и тип	Метод и описание
abstract java.util.concurrent.CompletableFuture<TokenResponse>	exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest) Выполняет операцию обмена маркерами, например для единого входа.
abstract java.util.concurrent.CompletableFuture<TokenResponse>	exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest) Выполняет операцию обмена маркерами, например для единого входа.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId) Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении с помощью настраиваемых учетных данных приложения.
default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls) Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId) Извлекает маркеры Azure Active Directory для определенных ресурсов в настроенном подключении.
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName) Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения, используя настраиваемые учетные данные приложения.
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения, используя настраиваемые учетные данные приложения.
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, String connectionName) Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
abstract java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect) Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
abstract java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
abstract java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, String connectionName) Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
abstract java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect) Получите ссылку необработанного входа, отправляемую пользователю для входа в имя подключения.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter) Извлекает состояние токена для каждого настроенного подключения для данного пользователя с помощью настраиваемых учетных данных приложения.
default java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext turnContext, String userId) Извлекает состояние токена для каждого настроенного подключения для данного пользователя.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext turnContext, String userId, String includeFilter) Извлекает состояние токена для каждого настроенного подключения для данного пользователя.
abstract java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode) Пытается получить маркер для пользователя, который находится в потоке входа, используя настраиваемые учетные данные приложения.
abstract java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext turnContext, String connectionName, String magicCode) Пытается получить маркер для пользователя, который находится в потоке входа.
default java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext turnContext) Подписывает пользователя с помощью сервера токенов.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId) Подписывает пользователя с помощью сервера маркеров с помощью настраиваемых учетных данных приложения.
abstract java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext turnContext, String connectionName, String userId) Подписывает пользователя с помощью сервера токенов.

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

exchangeToken

public abstract CompletableFuture exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

oAuthAppCredentials - AppCredentials для OAuth.

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

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

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

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

Если завершение completeableFuture завершается, возвращается обменный маркер.

exchangeToken

public abstract CompletableFuture exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

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

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

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

Если завершение completeableFuture завершается, возвращается обменный маркер.

getAadTokens

public abstract CompletableFuture> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

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

Параметры:

context - Контекст для текущего шага беседы с пользователем.

oAuthAppCredentials - AppCredentials для OAuth.

connectionName - Имя подключения Azure Active Directory, настроенного с помощью этого бота.

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

userId - Идентификатор пользователя, для которого извлекаются маркеры. При передаче значения NULL идентификатор пользователя берется из действия в TurnContext.

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

Словарь resourceUrl для соответствующего TokenResponse.

getAadTokens

public default CompletableFuture> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

connectionName - Имя подключения Azure Active Directory, настроенного с помощью этого бота.

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

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

Словарь resourceUrl для соответствующего TokenResponse.

getAadTokens

public abstract CompletableFuture> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

connectionName - Имя подключения Azure Active Directory, настроенного с помощью этого бота.

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

userId - Идентификатор пользователя, для которого извлекаются маркеры. При передаче значения NULL userId берется из действия в ITurnContext.

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

Словарь resourceUrl для соответствующего TokenResponse.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

oAuthAppCredentials - AppCredentials для OAuth.

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

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

Завершеннаяfuture, представляющая рабочую очередь для выполнения. Если завершение completeableFuture выполнено успешно, результат содержит необработанную ссылку для входа.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

oAuthAppCredentials - AppCredentials для OAuth.

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

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

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

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

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

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

Задача, представляющая выполняемую рабочую очередь. Если задача выполнена успешно, результат содержит необработанную ссылку для входа.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

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

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

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

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

oAuthAppCredentials - Учетные данные для OAuth.

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

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

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

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

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

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

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

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

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

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

getTokenStatus

public abstract CompletableFuture> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

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

Параметры:

context - Контекст для текущего шага беседы с пользователем.

oAuthAppCredentials - AppCredentials для OAuth.

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

includeFilter - Необязательный список разделенных запятыми для включения. Пустой возвращает состояние маркера для всех настроенных подключений.

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

Массив TokenStatus.

getTokenStatus

public default CompletableFuture> getTokenStatus(TurnContext turnContext, String userId)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

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

Массив TokenStatus.

getTokenStatus

public abstract CompletableFuture> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

includeFilter - Разделенный запятыми список включаемых подключений. Пустой возвращает состояние маркера для всех настроенных подключений.

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

Массив TokenStatus.

getUserToken

public abstract CompletableFuture getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

oAuthAppCredentials - AppCredentials для OAuth.

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

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

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

Ответ токена.

getUserToken

public abstract CompletableFuture getUserToken(TurnContext turnContext, String connectionName, String magicCode)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

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

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

Ответ токена.

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

Задача, представляющая выполняемую рабочую очередь.

signOutUser

public abstract CompletableFuture signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

oAuthAppCredentials - AppCredentials для OAuth.

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

userId - Идентификатор пользователя для выхода.

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

Завершеннаяfuture, представляющая рабочую очередь для выполнения.

signOutUser

public abstract CompletableFuture signOutUser(TurnContext turnContext, String connectionName, String userId)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

userId - Идентификатор пользователя для выхода.

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

Задача, представляющая выполняемую рабочую очередь.

UserTokenProvider Интерфейс

Сводка по методу

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

exchangeToken

exchangeToken

getAadTokens

getAadTokens

getAadTokens

getOAuthSignInLink

getOAuthSignInLink

getOAuthSignInLink

getOAuthSignInLink

getSignInResource

getSignInResource

getSignInResource

getTokenStatus

getTokenStatus

getTokenStatus

getUserToken

getUserToken

signOutUser

signOutUser

signOutUser

Применяется к