BotFrameworkAdapter Classe

Pacote:

com.microsoft.bot.builder

Artefato Maven:

com.microsoft.bot:bot-builder:4.14.3

• java.lang.Object
• • com.microsoft.bot.builder.BotAdapter
  • • com.microsoft.bot.builder.BotFrameworkAdapter

Implementações

ConnectorClientBuilder UserTokenProvider AdapterIntegration

public class BotFrameworkAdapter
extends BotAdapter
implements AdapterIntegration, UserTokenProvider, ConnectorClientBuilder

Um adaptador de bot que pode conectar um bot a um ponto de extremidade de serviço. O adaptador de bot encapsula processos de autenticação e envia atividades para e recebe atividades do Serviço de Conector de Bot. Quando o bot recebe uma atividade, o adaptador cria um objeto de contexto, passa-o para a lógica do aplicativo do bot e envia respostas de volta para o canal do usuário.

Use use(Middleware middleware) para adicionar Middleware objetos à coleção de middleware do adaptador\u2019s. O adaptador processa e direciona as atividades de entrada por meio do pipeline de middleware do bot para a lógica do bot\u2019s e, em seguida, volta para fora novamente. O adaptador processa e direciona atividades de entrada através do pipeline de middleware de bot para a lógica do seu bot e, em seguida, recua novamente.

TurnContext Activity Bot Middleware

Resumo do campo

Modificador e tipo	Campo e descrição
static final java.lang.String	CONNECTOR_CLIENT_KEY Chave para armazenar o Cliente do Conector.
static final java.lang.String	INVOKE_RESPONSE_KEY Chave para armazenar a Resposta de Invocação.
static final java.lang.String	TEAMSCONNECTOR_CLIENT_KEY Chave para armazenar o Cliente do Conectordo Teams.

Resumo do Construtor

Construtor	Description
BotFrameworkAdapter(AppCredentials withCredentials, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)	Inicializa uma nova instância da BotFrameworkAdapter classe usando um provedor de credenciais.
BotFrameworkAdapter(CredentialProvider withCredentialProvider)	Inicializa uma nova instância da BotFrameworkAdapter classe usando um provedor de credenciais.
BotFrameworkAdapter(CredentialProvider withCredentialProvider, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)	Inicializa uma nova instância da BotFrameworkAdapter classe usando um provedor de credenciais.
BotFrameworkAdapter(CredentialProvider withCredentialProvider, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)	Inicializa uma nova instância da BotFrameworkAdapter classe usando um provedor de credenciais.

Resumo do método

Modificador e tipo	Método e descrição
protected void	addConnectorClientToCache(String serviceUrl, String appId, String scope, ConnectorClient client) Insere um cliente conectorno cache.
protected java.util.concurrent.CompletableFuture<AppCredentials>	buildAppCredentials(String appId, String scope) Cria umobjeto credenciais de aplicativo para a ID e o escopo do aplicativoespecificados.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback) Envia uma mensagem proativa para uma conversa.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback) Envia uma mensagem proativa para uma conversa.
java.util.concurrent.CompletableFuture<java.lang.Void>	continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback) Envia uma mensagem proativa do bot para uma conversa.
java.util.concurrent.CompletableFuture<ConnectorClient>	createConnectorClient(String serviceUrl, ClaimsIdentity claimsIdentity, String audience) Cria o cliente do conector assíncrono.
java.util.concurrent.CompletableFuture<java.lang.Void>	createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback) Cria uma conversa no canal especificado.
java.util.concurrent.CompletableFuture<java.lang.Void>	createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback, ConversationReference reference) Cria uma conversa no canal especificado.
protected java.util.concurrent.CompletableFuture<OAuthClient>	createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials) Cria um cliente OAuth para o bot.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteActivity(TurnContext context, ConversationReference reference) Exclui uma atividade existente na conversa.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteConversationMember(TurnContextImpl context, String memberId) Exclui um membro da conversa atual.
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.
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.
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 de aplicativopersonalizadas.
java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,TokenResponse>>	getAadTokens(TurnContext context, String connectionName, String[] resourceUrls, String userId) Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada.
java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>	getActivityMembers(TurnContextImpl context) Lista os membros de uma determinada atividade.
java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>	getActivityMembers(TurnContextImpl context, String activityId) Lista os membros de uma determinada atividade.
protected java.util.Map<java.lang.String,ConnectorClient>	getConnectorClientCache() Obtenha o cache do Cliente do Conector.
java.util.concurrent.CompletableFuture<java.util.List<ChannelAccount>>	getConversationMembers(TurnContextImpl context) Lista os membros da conversa atual.
java.util.concurrent.CompletableFuture<ConversationsResult>	getConversations(TurnContextImpl context) Lista as Conversas nas quais esse bot participou de um determinado servidor de canal.
java.util.concurrent.CompletableFuture<ConversationsResult>	getConversations(TurnContextImpl context, String continuationToken) Lista as Conversas nas quais esse bot participou para um determinado servidor de canal.
java.util.concurrent.CompletableFuture<ConversationsResult>	getConversations(String serviceUrl, MicrosoftAppCredentials credentials) Lista as Conversas nas quais esse bot participou para um determinado servidor de canal.
java.util.concurrent.CompletableFuture<ConversationsResult>	getConversations(String serviceUrl, MicrosoftAppCredentials credentials, String continuationToken) Lista as Conversas nas quais esse bot participou para um determinado servidor de canal.
protected java.util.Map<java.lang.String,AppCredentials>	getCredentialsCache() Obtenha o cache de Credenciais do Aplicativo.
java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName) Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para obter um nome de conexão, usando credenciais de aplicativo personalizadas.
java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para obter um nome de conexão, usando as Credenciais de Aplicativodo bot.
java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext context, String connectionName) Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para obter um nome de conexão.
java.util.concurrent.CompletableFuture<java.lang.String>	getOAuthSignInLink(TurnContext context, String connectionName, String userId, String finalRedirect) Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para obter um nome de conexão.
protected java.util.concurrent.CompletableFuture<ConnectorClient>	getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials) Retorna um Cliente conector, seja de um cache ou recém-criado.
java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId, String finalRedirect) Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para obter um nome de conexão.
java.util.concurrent.CompletableFuture<SignInResource>	getSignInResource(TurnContext turnContext, String connectionName) Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para obter um nome de conexão.
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 para obter um nome de conexão.
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 de aplicativopersonalizadas.
java.util.concurrent.CompletableFuture<java.util.List<TokenStatus>>	getTokenStatus(TurnContext context, String userId, String includeFilter) Recupera o status do token para cada conexão configurada para o usuário determinado.
java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String magicCode) Tenta recuperar o token de um usuário que está em um fluxo de logon, usando credenciais de aplicativopersonalizadas.
java.util.concurrent.CompletableFuture<TokenResponse>	getUserToken(TurnContext context, String connectionName, String magicCode) Tenta recuperar o token para um usuário que está em um fluxo de logon.
protected static java.lang.String	keyForAppCredentials(String appId, String scope) Gera a chave para acessar o cache de credenciais do aplicativo.
protected static java.lang.String	keyForConnectorClient(String serviceUrl, String appId, String scope) Gera a chave para acessar o cache do cliente do conector.
java.util.concurrent.CompletableFuture<InvokeResponse>	processActivity(ClaimsIdentity identity, Activity activity, BotCallbackHandler callback) Cria um contexto de turno e executa o pipeline de middleware para uma atividade de entrada.
java.util.concurrent.CompletableFuture<InvokeResponse>	processActivity(String authHeader, Activity activity, BotCallbackHandler callback) Cria um contexto de turno e executa o pipeline de middleware para uma atividade de entrada.
java.util.concurrent.CompletableFuture<ResourceResponse[]>	sendActivities(TurnContext context, List<Activity> activities) Envia atividades para a conversa.
java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName, String userId) Desconscreve o usuário com o servidor de token usando credenciais de aplicativo personalizadas.
java.util.concurrent.CompletableFuture<java.lang.Void>	signOutUser(TurnContext context, String connectionName, String userId) Desconscreve o usuário com o servidor de token.
java.util.concurrent.CompletableFuture<ResourceResponse>	updateActivity(TurnContext context, Activity activity) Substitui uma atividade existente na conversa.
BotFrameworkAdapter	use(Middleware middleware) Adiciona middleware ao pipeline do adaptador.

Métodos herdados de BotAdapter

continueConversation continueConversation continueConversation continueConversation continueConversation continueConversation deleteActivity getMiddlewareSet getOnTurnError runPipeline sendActivities setOnTurnError updateActivity use

Métodos herdados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalhes do campo

CONNECTOR_CLIENT_KEY

public static final String CONNECTOR_CLIENT_KEY

Chave para armazenar ConnectorClient.

INVOKE_RESPONSE_KEY

public static final String INVOKE_RESPONSE_KEY

Chave para armazenar InvokeResponse.

TEAMSCONNECTOR_CLIENT_KEY

public static final String TEAMSCONNECTOR_CLIENT_KEY

Chave para armazenar o TeamsConnectorClient. Somente para teste.

Detalhes do construtor

BotFrameworkAdapter

public BotFrameworkAdapter(AppCredentials withCredentials, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Inicializa uma nova instância da BotFrameworkAdapter classe usando um provedor de credenciais.

Parameters:

withCredentials - As credenciais a usar.

withAuthConfig - A configuração de autenticação.

withChannelProvider - O provedor de canais.

withRetryStrategy - Política de repetição para repetir operações HTTP.

withMiddleware - O middleware a ser adicionado inicialmente ao adaptador.

BotFrameworkAdapter

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

Inicializa uma nova instância da BotFrameworkAdapter classe usando um provedor de credenciais.

Parameters:

withCredentialProvider - O provedor de credenciais.

BotFrameworkAdapter

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, AuthenticationConfiguration withAuthConfig, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Inicializa uma nova instância da BotFrameworkAdapter classe usando um provedor de credenciais.

Parameters:

withCredentialProvider - O provedor de credenciais.

withAuthConfig - A configuração de autenticação.

withChannelProvider - O provedor de canais.

withRetryStrategy - Política de repetição para repetir operações HTTP.

withMiddleware - O middleware a ser adicionado inicialmente ao adaptador.

BotFrameworkAdapter

public BotFrameworkAdapter(CredentialProvider withCredentialProvider, ChannelProvider withChannelProvider, RetryStrategy withRetryStrategy, Middleware withMiddleware)

Inicializa uma nova instância da BotFrameworkAdapter classe usando um provedor de credenciais.

Parameters:

withCredentialProvider - O provedor de credenciais.

withChannelProvider - O provedor de canais.

withRetryStrategy - Política de repetição para repetir operações HTTP.

withMiddleware - O middleware a ser adicionado inicialmente ao adaptador.

Detalhes do método

addConnectorClientToCache

protected void addConnectorClientToCache(String serviceUrl, String appId, String scope, ConnectorClient client)

Insere um ConnectorClient no cache. SOMENTE PARA TESTE DE UNIDADE.

Parameters:

serviceUrl - A URL do serviço

appId - O aplicativo fez

scope - O escopo

client - O ConnectorClient a ser inserido.

buildAppCredentials

protected CompletableFuture buildAppCredentials(String appId, String scope)

Cria um objeto AppCredentials para o appId e o escopo especificados.

Parameters:

appId - A appId.

scope - O escopo.

Returns:

Um objeto AppCredentials.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Envia uma mensagem proativa para uma conversa.

Chame esse método para enviar proativamente uma mensagem para uma conversa. A maioria dos canais exige que um usuário inicie uma conversa com um bot antes que o bot possa enviar atividades ao usuário.

Overrides:

BotFrameworkAdapter.continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, BotCallbackHandler callback)

Parameters:

claimsIdentity - Uma referência claimsIdentity para a conversa.

reference - Uma referência à conversa para continuar.

callback - O método a ser chamado para a volta do bot de resultado.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

continueConversation

public CompletableFuture continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Envia uma mensagem proativa para uma conversa.

Chame esse método para enviar proativamente uma mensagem para uma conversa. A maioria dos canais exige que um usuário inicie uma conversa com um bot antes que o bot possa enviar atividades ao usuário.

Overrides:

BotFrameworkAdapter.continueConversation(ClaimsIdentity claimsIdentity, ConversationReference reference, String audience, BotCallbackHandler callback)

Parameters:

claimsIdentity - Uma referência claimsIdentity para a conversa.

reference - Uma referência à conversa para continuar.

audience - Um valor que significa o destinatário da mensagem proativa.

callback - O método a ser chamado para a volta do bot de resultado.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

continueConversation

public CompletableFuture continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Envia uma mensagem proativa do bot para uma conversa.

Chame esse método para enviar proativamente uma mensagem para uma conversa. A maioria dos canais exige que um usuário inicie uma conversa com um bot antes que o bot possa enviar atividades ao usuário.

Essa sobrecarga difere da implementação do Nó, exigindo que o BotId seja passado. O código .Net permite que vários bots sejam hospedados em um único adaptador, o que não é algo compatível com o Node.

processActivity(String authHeader, Activity activity, BotCallbackHandler callback) runPipeline(TurnContext context, BotCallbackHandler callback)

Overrides:

BotFrameworkAdapter.continueConversation(String botAppId, ConversationReference reference, BotCallbackHandler callback)

Parameters:

botAppId - A ID do aplicativo do bot. Essa é a appId retornada pelo registro do Portal e geralmente é encontrada no parâmetro "MicrosoftAppId" em appSettings.json.

reference - Uma referência à conversa para continuar.

callback - O método a ser chamado para a volta do bot resultante.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

createConnectorClient

public CompletableFuture createConnectorClient(String serviceUrl, ClaimsIdentity claimsIdentity, String audience)

Cria o cliente do conector assíncrono.

Parameters:

serviceUrl - A URL do serviço.

claimsIdentity - A identidade por declarações.

audience - O público-alvo do conector.

Returns:

Instância connectorClient.

createConversation

public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback)

Cria uma conversa no canal especificado. Para iniciar uma conversa, seu bot deve saber suas informações de conta e as informações da conta do usuário nesse canal. A maioria dos canais dá suporte apenas ao início de uma conversa de mensagem direta (não em grupo).

O adaptador tenta criar uma nova conversa no canal e envia uma conversationUpdate atividade por meio de seu pipeline de middleware para o callback método .

Se a conversa for estabelecida com os usuários especificados, a ID da atividade Activity#getConversation conterá a ID da nova conversa.

Parameters:

channelId - A ID do canal.

serviceUrl - O ponto de extremidade da URL de serviço do canal.

credentials - As credenciais do aplicativo para o bot.

conversationParameters - As informações de conversa a serem usadas para criar a conversa.

callback - O método a ser chamado para a volta do bot resultante.

Returns:

Uma tarefa que representa o trabalho enfileirado para execução.

createConversation

public CompletableFuture createConversation(String channelId, String serviceUrl, MicrosoftAppCredentials credentials, ConversationParameters conversationParameters, BotCallbackHandler callback, ConversationReference reference)

Cria uma conversa no canal especificado. Para iniciar uma conversa, seu bot deve saber suas informações de conta e as informações da conta do usuário nesse canal. A maioria dos canais dá suporte apenas ao início de uma conversa de mensagem direta (não em grupo).

O adaptador tenta criar uma nova conversa no canal e envia uma conversationUpdate atividade por meio de seu pipeline de middleware para o callback método .

Se a conversa for estabelecida com os usuários especificados, a ID da atividade Activity#getConversation conterá a ID da nova conversa.

Parameters:

channelId - A ID do canal.

serviceUrl - O ponto de extremidade da URL de serviço do canal.

credentials - As credenciais do aplicativo para o bot.

conversationParameters - As informações de conversa a serem usadas para criar a conversa.

callback - O método a ser chamado para a volta do bot resultante.

reference - Uma referência de conversa que contém o locatário.

Returns:

Uma tarefa que representa o trabalho enfileirado para execução.

createOAuthAPIClient

protected CompletableFuture createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

Cria um cliente OAuth para o bot.

Observação: isso é protegido principalmente para que os testes de unidade possam substituir para fornecer um OAuthClient fictício.

Parameters:

turnContext - O objeto de contexto para a curva atual.

oAuthAppCredentials - As credenciais a serem usadas ao criar o cliente. Se for nulo, as credenciais padrão serão usadas.

Returns:

Um cliente OAuth para o bot.

deleteActivity

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Exclui uma atividade existente na conversa.

Overrides:

BotFrameworkAdapter.deleteActivity(TurnContext context, ConversationReference reference)

Parameters:

context - O objeto de contexto para a curva.

reference - Referência de conversa para a atividade a ser excluída.

Returns:

Uma tarefa que representa o trabalho enfileirado para execução. onDeleteActivity(DeleteActivityHandler handler)

deleteConversationMember

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

Exclui um membro da conversa atual.

Parameters:

context - O objeto de contexto para a curva.

memberId - ID do membro a ser excluído da conversa

Returns:

Uma tarefa que representa o trabalho enfileirado para execução.

exchangeToken

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

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

Parameters:

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

oAuthAppCredentials - AppCredentials para OAuth.

connectionName - Nome da conexão de autenticação a ser usada.

userId - A ID de usuário associada ao token..

exchangeRequest - Os detalhes da solicitação de troca, um token a ser trocado ou um uri a ser trocado.

Returns:

Se a tarefa for concluída, o token trocado será retornado.

exchangeToken

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

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

Parameters:

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

connectionName - Nome da conexão de autenticação a ser usada.

userId - A ID de usuário associada ao token..

exchangeRequest - Os detalhes da solicitação de troca, um token a ser trocado ou um uri a ser trocado.

Returns:

Se a tarefa for concluída, o token trocado será retornado.

getAadTokens

public 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.

Parameters:

context - Contexto para a virada de conversa atual 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 de usuário para a qual os tokens são recuperados. Se passar nulo, userId será obtido da Atividade no TurnContext.

Returns:

Dicionário de resourceUrl para o TokenResponse correspondente.

getAadTokens

public CompletableFuture<>> getAadTokens(TurnContext context, String connectionName, String[] resourceUrls, String userId)

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

Parameters:

context - Contexto para a virada de conversa atual 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 de usuário para a qual os tokens são recuperados. Se passar nulo, userId será obtido da Atividade no TurnContext.

Returns:

Mapa de resourceUrl para o correspondente TokenResponse.

getActivityMembers

public CompletableFuture<>> getActivityMembers(TurnContextImpl context)

Lista os membros de uma determinada atividade.

Parameters:

context - O objeto de contexto para a curva.

Returns:

Lista de membros da atividade

getActivityMembers

public CompletableFuture<>> getActivityMembers(TurnContextImpl context, String activityId)

Lista os membros de uma determinada atividade.

Parameters:

context - O objeto de contexto para a curva.

activityId - (Opcional) ID da atividade a ser enumerada. Se não for especificado, a ID das atividades atuais será usada.

Returns:

Lista de membros da atividade

getConnectorClientCache

protected Map getConnectorClientCache()

Obtenha o cache ConnectorClient. PARA TESTE DE UNIDADE.

Returns:

O cache ConnectorClient.

getConversationMembers

public CompletableFuture<>> getConversationMembers(TurnContextImpl context)

Lista os membros da conversa atual.

Parameters:

context - O objeto de contexto para a curva.

Returns:

Lista de membros da conversa atual

getConversations

public CompletableFuture getConversations(TurnContextImpl context)

Lista as Conversas nas quais esse bot participou de um determinado servidor de canal. O servidor de canal retorna resultados em páginas e cada página incluirá um 'continuationToken' que pode ser usado para buscar a próxima página de resultados do servidor. Essa sobrecarga pode ser chamada durante o processamento de atividade padrão, momento em que a URL de serviço do Bot e as credenciais que fazem parte do pipeline de processamento de atividades atual serão usadas.

Parameters:

context - O objeto de contexto para a curva.

Returns:

Lista de membros da conversa atual

getConversations

public CompletableFuture getConversations(TurnContextImpl context, String continuationToken)

Lista as Conversas nas quais esse bot participou de um determinado servidor de canal. O servidor de canal retorna resultados em páginas e cada página incluirá um 'continuationToken' que pode ser usado para buscar a próxima página de resultados do servidor. Essa sobrecarga pode ser chamada durante o processamento de atividade padrão, momento em que a URL de serviço do Bot e as credenciais que fazem parte do pipeline de processamento de atividades atual serão usadas.

Parameters:

context - O objeto de contexto para a curva.

continuationToken - O token de continuação da página anterior de resultados.

Returns:

Lista de membros da conversa atual

getConversations

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

Lista as Conversas nas quais esse bot participou para um determinado servidor de canal. O servidor de canal retorna resultados em páginas e cada página incluirá um 'continuationToken' que pode ser usado para buscar a próxima página de resultados do servidor.

Parameters:

serviceUrl - A URL do servidor de canal a ser consultada. Isso pode ser recuperado de context.activity.serviceUrl.

credentials - As credenciais necessárias para que o Bot se conecte ao.services().

Returns:

Lista de membros da conversa atual

Essa sobrecarga pode ser chamada de fora do contexto de uma conversa, pois apenas o ServiceUrl e as credenciais do Bot são necessários.

getConversations

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials, String continuationToken)

Lista as Conversas nas quais esse bot participou para um determinado servidor de canal. O servidor de canal retorna resultados em páginas e cada página incluirá um 'continuationToken' que pode ser usado para buscar a próxima página de resultados do servidor. Essa sobrecarga pode ser chamada de fora do contexto de uma conversa, pois apenas o ServiceUrl e as credenciais do Bot são necessários.

Parameters:

serviceUrl - A URL do servidor de canal a ser consultada. Isso pode ser recuperado de context.activity.serviceUrl.

credentials - As credenciais necessárias para que o Bot se conecte ao.services().

continuationToken - O token de continuação da página anterior de resultados.

Returns:

Lista de membros da conversa atual

getCredentialsCache

protected Map getCredentialsCache()

Obtenha o cache appCredentials. Para teste de unidade.

Returns:

O cache do AppCredentials.

getOAuthSignInLink

public CompletableFuture getOAuthSignInLink(TurnContext context, 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 AppCredentials personalizado.

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

oAuthAppCredentials - AppCredentials para OAuth.

connectionName - Nome da conexão de autenticação a ser usada.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

     If the task completes successfully, the result contains the raw
     signin link.

getOAuthSignInLink

public CompletableFuture getOAuthSignInLink(TurnContext context, 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 AppCredentials do bot.

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

oAuthAppCredentials

connectionName - Nome da conexão de autenticação a ser usada.

userId - A ID de usuário que será associada ao token.

finalRedirect - A URL final para a qual o fluxo OAuth será redirecionado.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

     If the task completes successfully, the result contains the raw
     signin link.

getOAuthSignInLink

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

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

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

connectionName - Nome da conexão de autenticação a ser usada.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

getOAuthSignInLink

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName, String userId, String finalRedirect)

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

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

connectionName - Nome da conexão de autenticação a ser usada.

userId - A ID de usuário que será associada ao token.

finalRedirect - A URL final para a qual o fluxo OAuth será redirecionado.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

getOrCreateConnectorClient

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

Retorna um ConnectorClient, seja de um cache ou recém-criado.

Observação: isso é protegido principalmente para permitir que os testes de unidade substituam isso para fornecer um ConnectorClient fictício

Parameters:

serviceUrl - A URL do serviço para o cliente.

usingAppCredentials - (Opcional) As AppCredentials a serem usadas.

Returns:

Uma tarefa que retornará o ConnectorClient.

getSignInResource

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

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

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

oAuthAppCredentials - AppCredentials para OAuth.

connectionName - Nome da conexão de autenticação a ser usada.

userId - A ID de usuário que será associada ao token.

finalRedirect - A URL final para a qual o fluxo OAuth será redirecionado.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

     If the task completes successfully, the result contains the raw
     signin link.

getSignInResource

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

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

Parameters:

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

connectionName - Nome da conexão de autenticação a ser usada.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

     If the task completes successfully, the result contains the raw
     signin link.

getSignInResource

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

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

Parameters:

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

connectionName - Nome da conexão de autenticação a ser usada.

userId - A ID de usuário que será associada ao token.

finalRedirect - A URL final para a qual o fluxo OAuth será redirecionado.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

     If the task completes successfully, the result contains the raw
     signin link.

getTokenStatus

public 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 personalizado.

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

oAuthAppCredentials - AppCredentials para OAuth.

userId - A ID de usuário para a qual o status do token é recuperado.

includeFilter - Lista opcional separada por vírgulas das conexões a serem incluídas. Blank retornará o status do token para todas as conexões configuradas.

Returns:

Lista de TokenStatus.

getTokenStatus

public CompletableFuture<>> getTokenStatus(TurnContext context, String userId, String includeFilter)

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

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

userId - A ID de usuário para a qual o status do token é recuperado.

includeFilter - Lista opcional separada por vírgulas das conexões a serem incluídas. Blank retornará o status do token para todas as conexões configuradas.

Returns:

Matriz de TokenStatus.

getUserToken

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

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

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

oAuthAppCredentials - AppCredentials para OAuth.

connectionName - Nome da conexão de autenticação a ser usada.

magicCode - (Opcional) O usuário opcional inseriu o código para validar.

Returns:

Resposta de token.

getUserToken

public CompletableFuture getUserToken(TurnContext context, String connectionName, String magicCode)

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

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

connectionName - Nome da conexão de autenticação a ser usada.

magicCode - (Opcional) O usuário opcional inseriu o código para validar.

Returns:

Resposta de token

keyForAppCredentials

protected static String keyForAppCredentials(String appId, String scope)

Gera a chave para acessar o cache de credenciais do aplicativo.

Parameters:

appId - A appId

scope - O escopo.

Returns:

A chave de cache

keyForConnectorClient

protected static String keyForConnectorClient(String serviceUrl, String appId, String scope)

Gera a chave para acessar o cache do cliente do conector.

Parameters:

serviceUrl - A URL do serviço

appId - O aplicativo fez

scope - O escopo

Returns:

A chave em cache.

processActivity

public CompletableFuture processActivity(ClaimsIdentity identity, Activity activity, BotCallbackHandler callback)

Cria um contexto de turno e executa o pipeline de middleware para uma atividade de entrada.

Parameters:

identity - Um ClaimsIdentity para a solicitação.

activity - A atividade de entrada.

callback - O código a ser executado no final do pipeline de middleware do adaptador.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se o tipo de atividade foi 'Invoke' e a chave correspondente (channelId + activityId) foi encontrada, um InvokeResponse é retornado; caso contrário, nulo é retornado.

processActivity

public CompletableFuture processActivity(String authHeader, Activity activity, BotCallbackHandler callback)

Cria um contexto de turno e executa o pipeline de middleware para uma atividade de entrada.

Parameters:

authHeader - O cabeçalho de autenticação HTTP da solicitação.

activity - A atividade de entrada.

callback - O código a ser executado no final do pipeline de middleware do adaptador.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se o tipo de atividade foi 'Invoke' e a chave correspondente (channelId + activityId) foi encontrada, um InvokeResponse é retornado; caso contrário, nulo é retornado.

sendActivities

public CompletableFuture sendActivities(TurnContext context, List activities)

Envia atividades para a conversa.

Overrides:

BotFrameworkAdapter.sendActivities(TurnContext context, List<Activity> activities)

Parameters:

context - O objeto de contexto para a curva.

activities - As atividades a serem enviadas.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se as atividades forem enviadas com êxito, o resultado da tarefa conterá uma matriz de ResourceResponse objetos que contêm as IDs atribuídas pelo canal de recebimento às atividades.

     <xref uid="com.microsoft.bot.builder.TurnContext.onSendActivities(com.microsoft.bot.builder.SendActivitiesHandler)" data-throw-if-not-resolved="false" data-raw-source="TurnContext#onSendActivities(SendActivitiesHandler)"></xref>

signOutUser

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

Desconscreve o usuário com o servidor de token usando AppCredentials personalizado.

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

oAuthAppCredentials - AppCredentials para OAuth.

connectionName - Nome da conexão de autenticação a ser usada.

userId - ID de usuário do usuário para sair.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

signOutUser

public CompletableFuture signOutUser(TurnContext context, String connectionName, String userId)

Desconscreve o usuário com o servidor de token.

Parameters:

context - Contexto para a atual virada de conversa com o usuário.

connectionName - Nome da conexão de autenticação a ser usada.

userId

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado.

updateActivity

public CompletableFuture updateActivity(TurnContext context, Activity activity)

Substitui uma atividade existente na conversa.

Overrides:

BotFrameworkAdapter.updateActivity(TurnContext context, Activity activity)

Parameters:

context - O objeto de contexto para a curva.

activity - Nova atividade de substituição.

Returns:

Uma tarefa que representa o trabalho enfileirado a ser executado. Se a atividade for enviada com êxito, o resultado da tarefa conterá um ResourceResponse objeto que contém a ID que o canal de recebimento atribuiu à atividade.

Antes de chamar isso, defina a ID da atividade de substituição como a ID da atividade a ser substituída. onUpdateActivity(UpdateActivityHandler handler)

use

public BotFrameworkAdapter use(Middleware middleware)

Adiciona middleware ao pipeline do adaptador. O middleware é adicionado ao adaptador no momento da inicialização. Para cada turno, o adaptador chama o middleware na ordem em que você o adicionou.

Overrides:

BotFrameworkAdapter.use(Middleware middleware)

Parameters:

middleware - O middleware a ser adicionado.

Returns:

O objeto do adaptador atualizado.