UserTokenProvider Interface

  • Referência
Pacote:
com.microsoft.bot.builder
Artefato Maven:
com.microsoft.bot:bot-builder:4.14.3

public interface UserTokenProvider

Provedor OAuth.

Resumo do método

Modificador e tipo Método e descrição
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Executa uma operação de troca de token, como para logon único.
abstract java.util.concurrent.CompletableFuture<TokenResponse> exchangeToken(TurnContext turnContext, String connectionName, String userId, TokenExchangeRequest exchangeRequest)

Executa uma operação de troca de token, como para logon único.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String[] resourceUrls, String userId)

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada, usando credenciais dede aplicativo personalizadas.
default java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls)

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.
abstract java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>> getAadTokens(TurnContext turnContext, String connectionName, String[] resourceUrls, String userId)

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão usando credenciais dede aplicativo personalizadas.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão usando credenciais dede aplicativo personalizadas.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.
abstract java.util.concurrent.CompletableFuture<java.lang.String> getOAuthSignInLink(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.
abstract java.util.concurrent.CompletableFuture<SignInResource> getSignInResource(TurnContext turnContext, String connectionName, String userId, String finalRedirect)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext context, AppCredentials oAuthAppCredentials, String userId, String includeFilter)

Recupera o status do token para cada conexão configurada para o usuário fornecido, usando credenciais dede aplicativo personalizadas.
default java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId)

Recupera o status do token para cada conexão configurada para o usuário fornecido.
abstract java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>> getTokenStatus(TurnContext turnContext, String userId, String includeFilter)

Recupera o status do token para cada conexão configurada para o usuário fornecido.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String magicCode)

Tenta recuperar o token de um usuário que está em um fluxo de logon usando credenciais dede aplicativo personalizadas.
abstract java.util.concurrent.CompletableFuture<TokenResponse> getUserToken(TurnContext turnContext, String connectionName, String magicCode)

Tenta recuperar o token de um usuário que está em um fluxo de logon.
default java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext)

Desconscreve o usuário com o servidor de token.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, AppCredentials oAuthAppCredentials, String connectionName, String userId)

Desconecta o usuário com o servidor de token usando credenciais dede aplicativo personalizadas.
abstract java.util.concurrent.CompletableFuture<java.lang.Void> signOutUser(TurnContext turnContext, String connectionName, String userId)

Desconscreve o usuário com o servidor de token.

Detalhes do método

exchangeToken

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

Executa uma operação de troca de token, como para logon único.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nome da conexão de autenticação a ser usada.
userId - A ID do usuário associada ao token..
exchangeRequest - Os detalhes da solicitação de troca, um token a ser trocado ou um uri a ser trocado.

Retornos:

Se o CompleteableFuture for concluído, o token trocado será retornado.

exchangeToken

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

Executa uma operação de troca de token, como para logon único.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
connectionName - Nome da conexão de autenticação a ser usada.
userId - A ID do usuário associada ao token..
exchangeRequest - Os detalhes da solicitação de troca, um token a ser trocado ou um uri a ser trocado.

Retornos:

Se o CompleteableFuture for concluído, o token trocado será retornado.

getAadTokens

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

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada, usando AppCredentials personalizados.

Parâmetros:

context - Contexto para a virada atual da conversa com o usuário.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - O nome da conexão do Azure Active Directory configurada com esse bot.
resourceUrls - A lista de URLs de recurso para a qual recuperar tokens.
userId - A ID do usuário para a qual os tokens são recuperados. Se a passagem for nula, a userId será retirada da Atividade no TurnContext.

Retornos:

Dicionário de resourceUrl para o TokenResponse correspondente.

getAadTokens

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

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
connectionName - O nome da conexão do Azure Active Directory configurada com esse bot.
resourceUrls - A lista de URLs de recurso para a qual recuperar tokens.

Retornos:

Dicionário de resourceUrl para o TokenResponse correspondente.

getAadTokens

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

Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
connectionName - O nome da conexão do Azure Active Directory configurada com esse bot.
resourceUrls - A lista de URLs de recurso para a qual recuperar tokens.
userId - A ID do usuário para a qual os tokens são recuperados. Se a passagem for nula, a userId será retirada da Atividade no ITurnContext.

Retornos:

Dicionário de resourceUrl para o TokenResponse correspondente.

getOAuthSignInLink

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

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão usando AppCredentials personalizados.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nome da conexão de autenticação a ser usada.

Retornos:

Um CompletableFuture que representa o trabalho enfileirado a ser executado. Se o CompleteableFuture for concluído com êxito, o resultado conterá o link de entrada bruto.

getOAuthSignInLink

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

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão usando AppCredentials personalizados.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nome da conexão de autenticação a ser usada.
userId - A ID do usuário que será associada ao token.
finalRedirect - A URL final para a qual o fluxo OAuth será redirecionada.

Retornos:

Um CompletableFuture que representa o trabalho enfileirado a ser executado. Se o CompleteableFuture for concluído com êxito, o resultado conterá o link de entrada bruto.

getOAuthSignInLink

public abstract CompletableFuture getOAuthSignInLink(TurnContext turnContext, String connectionName)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
connectionName - Nome da conexão de autenticação a ser usada.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se a tarefa for concluída com êxito, o resultado conterá o link de entrada bruto.

getOAuthSignInLink

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

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
connectionName - Nome da conexão de autenticação a ser usada.
userId - A ID do usuário que será associada ao token.
finalRedirect - A URL final para a qual o fluxo OAuth será redirecionada.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se a tarefa for concluída com êxito, o resultado conterá o link de entrada bruto.

getSignInResource

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

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
oAuthAppCredentials - Credenciais para OAuth.
connectionName - Nome da conexão de autenticação a ser usada.
userId - A ID do usuário que será associada ao token.
finalRedirect - A URL final para a qual o fluxo OAuth será redirecionada.

Retornos:

Um CompletableFuture que representa o trabalho enfileirado a ser executado. Se o CompleteableFuture for concluído com êxito, o resultado conterá o link de entrada bruto.

getSignInResource

public abstract CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
connectionName - Nome da conexão de autenticação a ser usada.

Retornos:

Um CompletableFuture que representa o trabalho enfileirado a ser executado. Se o CompleteableFuture for concluído com êxito, o resultado conterá o link de entrada bruto.

getSignInResource

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

Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
connectionName - Nome da conexão de autenticação a ser usada.
userId - A ID do usuário que será associada ao token.
finalRedirect - A URL final para a qual o fluxo OAuth será redirecionada.

Retornos:

Um CompletableFuture que representa o trabalho enfileirado a ser executado. Se o CompleteableFuture for concluído com êxito, o resultado conterá o link de entrada bruto.

getTokenStatus

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

Recupera o status do token para cada conexão configurada para o usuário fornecido, usando AppCredentials personalizados.

Parâmetros:

context - Contexto para a virada atual da conversa com o usuário.
oAuthAppCredentials - AppCredentials para OAuth.
userId - A ID do usuário para a qual o status do token é recuperado.
includeFilter - Lista opcional separada por vírgulas das conexões a serem incluídas. Em branco retornará o status do token para todas as conexões configuradas.

Retornos:

Matriz de TokenStatus.

getTokenStatus

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

Recupera o status do token para cada conexão configurada para o usuário fornecido.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
userId - A ID do usuário para a qual o status do token é recuperado.

Retornos:

Matriz de TokenStatus.

getTokenStatus

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

Recupera o status do token para cada conexão configurada para o usuário fornecido.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
userId - A ID do usuário para a qual o status do token é recuperado.
includeFilter - Lista separada por vírgulas das conexões a serem incluídas. Em branco retornará o status do token para todas as conexões configuradas.

Retornos:

Matriz de TokenStatus.

getUserToken

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

Tenta recuperar o token de um usuário que está em um fluxo de logon usando AppCredentials personalizados.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nome da conexão de autenticação a ser usada.
magicCode - (Opcional) Código inserido pelo usuário opcional para validar.

Retornos:

Resposta de token.

getUserToken

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

Tenta recuperar o token de um usuário que está em um fluxo de logon.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
connectionName - Nome da conexão de autenticação a ser usada.
magicCode - (Opcional) Código inserido pelo usuário opcional para validar.

Retornos:

Resposta de token.

signOutUser

public default CompletableFuture signOutUser(TurnContext turnContext)

Desconscreve o usuário com o servidor de token.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

signOutUser

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

Desconecta o usuário com o servidor de token usando AppCredentials personalizados.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
oAuthAppCredentials - AppCredentials para OAuth.
connectionName - Nome da conexão de autenticação a ser usada.
userId - ID do usuário para sair.

Retornos:

Um CompletableFuture que representa o trabalho enfileirado a ser executado.

signOutUser

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

Desconscreve o usuário com o servidor de token.

Parâmetros:

turnContext - Contexto para a virada atual da conversa com o usuário.
connectionName - Nome da conexão de autenticação a ser usada.
userId - ID do usuário para sair.

Retornos:

Uma tarefa que representa o trabalho enfileirado a ser executado.

Aplica-se a