BotFrameworkAdapter Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Um adaptador de bot que pode conectar um bot a um ponto de extremidade de serviço.
public class BotFrameworkAdapter : Microsoft.Bot.Builder.BotAdapter, Microsoft.Bot.Builder.IExtendedUserTokenProvider, Microsoft.Bot.Builder.Integration.IAdapterIntegration, Microsoft.Bot.Builder.OAuth.IConnectorClientBuilder
type BotFrameworkAdapter = class
inherit BotAdapter
interface IAdapterIntegration
interface IExtendedUserTokenProvider
interface IUserTokenProvider
interface IConnectorClientBuilder
Public Class BotFrameworkAdapter
Inherits BotAdapter
Implements IAdapterIntegration, IConnectorClientBuilder, IExtendedUserTokenProvider
- Herança
- Derivado
- Implementações
Comentários
Ainda há suporte para BotFrameworkAdapter, mas o adaptador recomendado é 'CloudAdapter'. O adaptador de bot encapsula processos de autenticação e envia atividades para e recebe atividades do Serviço do Bot Connector. 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(IMiddleware) para adicionar objetos IMiddleware à coleção de middleware do adaptador. O adaptador processa e direciona as atividades de entrada por meio do pipeline de middleware de bot para a lógica do bot e, em seguida, volta para fora novamente. À medida que cada atividade entra e sai do bot, cada parte do middleware pode inspecionar ou agir sobre a atividade, antes e depois da execução da lógica do bot.
Construtores
BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger) |
Inicializa uma nova instância da classe BotFrameworkAdapter, usando um provedor de credenciais. |
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger) |
Inicializa uma nova instância da classe BotFrameworkAdapter, usando um provedor de credenciais. |
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger) |
Inicializa uma nova instância da classe BotFrameworkAdapter, usando um provedor de credenciais. |
Campos
BotIdentityKey |
O valor da cadeia de caracteres para a chave de identidade do bot. (Herdado de BotAdapter) |
InvokeResponseKey |
O valor da chave para qualquer InvokeResponseActivity que estaria no TurnState. (Herdado de BotAdapter) |
OAuthScopeKey |
O valor da cadeia de caracteres para a chave de escopo OAuth. (Herdado de BotAdapter) |
Propriedades
AppCredentialMap |
Obtém o mapa de aplicativos para AppCredentials para este adaptador. |
ChannelProvider |
Obtém o provedor de canal para este adaptador. |
CredentialProvider |
Obtém o provedor de credenciais para este adaptador. |
HttpClient |
Obtém o HttpClient personalizado para este adaptador, se especificado. |
Logger |
Obtém o agente deste adaptador. |
MiddlewareSet |
Obtém a coleção de middleware no pipeline do adaptador. (Herdado de BotAdapter) |
OnTurnError |
Obtém ou define um manipulador de erros que pode capturar exceções no middleware ou aplicativo. (Herdado de BotAdapter) |
Métodos
BuildCredentialsAsync(String, String) |
Lógica para criar um objeto AppCredentials a ser usado para adquirir tokens para este HttpClient. |
CanProcessOutgoingActivity(Activity) |
Oportunidade para subclasses optarem por processar uma atividade de saída. |
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Envia uma mensagem proativa para uma conversa. (Herdado de BotAdapter) |
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken) |
Envia uma mensagem proativa para uma conversa. (Herdado de BotAdapter) |
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken) |
Envia uma mensagem proativa do bot para uma conversa. |
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken) |
Envia uma mensagem proativa do bot para uma conversa. |
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Envia uma mensagem proativa para uma conversa. (Herdado de BotAdapter) |
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken) |
Envia uma mensagem proativa do bot para uma conversa. |
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Cria uma conversa no canal especificado. |
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Obsoleto.
Cria uma conversa no canal especificado. A sobrecarga recebe uma ConversationReference, incluindo o locatário. |
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken) |
Cria uma conversa no canal especificado. |
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken) |
Obsoleto.
Cria uma conversa no canal especificado. A sobrecarga recebe uma ConversationReference, incluindo o locatário. |
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken) |
Cria uma conversa no canal especificado. (Herdado de BotAdapter) |
CreateOAuthApiClientAsync(ITurnContext) |
Cria um cliente OAuth para o bot. |
CreateOAuthApiClientAsync(ITurnContext, AppCredentials) |
Cria um cliente OAuth para o bot com as credenciais. |
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken) |
Exclui uma atividade existente na conversa. |
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken) |
Remove um membro da conversa atual. |
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken) |
Executa uma operação de troca de token, como para logon único. |
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken) |
Executa uma operação de troca de token, como para logon único. |
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken) |
Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada, usando AppCredentials personalizados. |
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken) |
Recupera tokens do Azure Active Directory para recursos específicos em uma conexão configurada, usando o AppCredentials do bot. |
GetActivityMembersAsync(ITurnContext, String, CancellationToken) |
Lista os membros de uma determinada atividade. |
GetConversationMembersAsync(ITurnContext, CancellationToken) |
Lista os membros da conversa atual. |
GetConversationsAsync(ITurnContext, String, CancellationToken) |
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 |
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken) |
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 |
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken) |
Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão usando AppCredentials personalizados. |
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Obtenha o link de entrada bruto a ser enviado ao usuário para entrar para um nome de conexão usando AppCredentials personalizados. |
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken) |
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. |
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken) |
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. |
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken) |
Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão. |
GetSignInResourceAsync(ITurnContext, String, CancellationToken) |
Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão. |
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken) |
Obtenha o link de entrada bruto a ser enviado ao usuário para entrar em um nome de conexão. |
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Recupera o status do token para cada conexão configurada para o usuário fornecido, usando AppCredentials personalizados. |
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken) |
Recupera o status do token para cada conexão configurada para o usuário fornecido, usando o AppCredentials do bot. |
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Tenta recuperar o token de um usuário que está em um fluxo de logon usando AppCredentials personalizados. |
GetUserTokenAsync(ITurnContext, String, String, CancellationToken) |
Tenta recuperar o token de um usuário que está em um fluxo de logon usando o AppCredentials do bot. |
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken) |
Cria um contexto de turno e executa o pipeline de middleware para uma atividade de entrada. |
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken) |
Cria um contexto de turno e executa o pipeline de middleware para uma atividade de entrada. |
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken) |
Lógica personalizada para enviar uma atividade de saída. As subclasses podem substituir esse método junto com CanProcessOutgoingActivity para ter uma lógica personalizada para processar a atividade de saída. |
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken) |
Inicia o processamento de atividades para a curva do bot atual. (Herdado de BotAdapter) |
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken) |
Envia atividades para a conversa. |
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken) |
Desconecta o usuário com o servidor de token usando AppCredentials personalizados. |
SignOutUserAsync(ITurnContext, String, String, CancellationToken) |
Desconecta o usuário com o servidor de token usando o AppCredentials do bot. |
UpdateActivityAsync(ITurnContext, Activity, CancellationToken) |
Substitui uma atividade existente na conversa. |
Use(IMiddleware) |
Adiciona middleware ao pipeline do adaptador. |
Implantações explícitas de interface
IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken) |
Um adaptador de bot que pode conectar um bot a um ponto de extremidade de serviço. |
Métodos de Extensão
UseBotState(BotAdapter, BotState[]) |
Adiciona middleware ao adaptador para registrar um ou mais objetos BotState no contexto de turno. O middleware registra os objetos de estado no contexto de turno no início de cada turno. |
UseState(BotAdapter, UserState, ConversationState, Boolean) |
Obsoleto.
Registra objetos de estado de usuário e conversa com o adaptador. Esses objetos estarão disponíveis por meio do TurnStatedo contexto de turno. métodoGet<T>(). |
UseStorage(BotAdapter, IStorage) |
Adiciona middleware ao adaptador para registrar um objeto IStorage no contexto de turno. O middleware registra os objetos de estado no contexto de turno no início de cada turno. |