BotFrameworkAdapter Classe

public static final String CONNECTOR_CLIENT_KEY

Chave para armazenar ConnectorClient.

public static final String INVOKE_RESPONSE_KEY

Chave para armazenar InvokeResponse.

public static final String TEAMSCONNECTOR_CLIENT_KEY

Chave para armazenar o TeamsConnectorClient. Somente para teste.

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

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

Parâmetros:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

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

Parâmetros:

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

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

Parâmetros:

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

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

Parâmetros:

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

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

Parâmetros:

protected CompletableFuture buildAppCredentials(String appId, String scope)

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

Parâmetros:

Retornos:

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.

Substituições:

Parâmetros:

Retornos:

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.

Substituições:

Parâmetros:

Retornos:

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)

Substituições:

Parâmetros:

Retornos:

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

Cria o cliente do conector assíncrono.

Parâmetros:

Retornos:

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

Cria uma conversa no canal especificado. Para iniciar uma conversa, o 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 direta (não em grupo).

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

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

Parâmetros:

Retornos:

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, o 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 direta (não em grupo).

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

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

Parâmetros:

Retornos:

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.

Parâmetros:

Retornos:

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Exclui uma atividade existente na conversa.

Substituições:

Parâmetros:

Retornos:

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

Exclui um membro da conversa atual.

Parâmetros:

Retornos:

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.

Parâmetros:

Retornos:

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

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

Parâmetros:

Retornos:

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.

Parâmetros:

Retornos:

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.

Parâmetros:

Retornos:

public CompletableFuture> getActivityMembers(TurnContextImpl context)

Lista os membros de uma determinada atividade.

Parâmetros:

Retornos:

public CompletableFuture> getActivityMembers(TurnContextImpl context, String activityId)

Lista os membros de uma determinada atividade.

Parâmetros:

Retornos:

protected Map getConnectorClientCache()

Obtenha o cache ConnectorClient. PARA TESTE DE UNIDADE.

Retornos:

public CompletableFuture> getConversationMembers(TurnContextImpl context)

Lista os membros da conversa atual.

Parâmetros:

Retornos:

public CompletableFuture getConversations(TurnContextImpl context)

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 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 atividade atual serão usadas.

Parâmetros:

Retornos:

public CompletableFuture getConversations(TurnContextImpl context, 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 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 atividade atual serão usadas.

Parâmetros:

Retornos:

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.

Parâmetros:

Retornos:

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 somente o ServiceUrl e as credenciais do Bot são necessários.

Parâmetros:

Retornos:

protected Map getCredentialsCache()

Obtenha o cache do AppCredentials. Para teste de unidade.

Retornos:

public CompletableFuture getOAuthSignInLink(TurnContext context, 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:

Retornos:

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

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 o AppCredentials do bot.

Parâmetros:

Retornos:

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

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

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

Parâmetros:

Retornos:

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 em um nome de conexão.

Parâmetros:

Retornos:

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

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

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

Parâmetros:

Retornos:

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 em um nome de conexão.

Parâmetros:

Retornos:

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

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

Retornos:

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

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 em um nome de conexão.

Parâmetros:

Retornos:

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

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

Parâmetros:

Retornos:

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

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

Parâmetros:

Retornos:

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

Parâmetros:

Retornos:

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

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

Parâmetros:

Retornos:

protected static String keyForAppCredentials(String appId, String scope)

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

Parâmetros:

Retornos:

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

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

Parâmetros:

Retornos:

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.

Parâmetros:

Retornos:

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.

Parâmetros:

Retornos:

public CompletableFuture sendActivities(TurnContext context, List activities)

Envia atividades para a conversa.

Substituições:

Parâmetros:

Retornos:

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

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

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

Parâmetros:

Retornos:

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

Desconscreve o usuário com o servidor de token.

Parâmetros:

Retornos:

public CompletableFuture updateActivity(TurnContext context, Activity activity)

Substitui uma atividade existente na conversa.

Substituições:

Parâmetros:

Retornos:

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.

Substituições:

Parâmetros:

Retornos: