BotFrameworkAdapter Classe

Definição

Espaço de Nomes:: Microsoft.Bot.Builder

Assemblagem:: Microsoft.Bot.Builder.dll

Pacote:: Microsoft.Bot.Builder v4.22.7

Importante

Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.

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

BotAdapter
BotFrameworkAdapter

Derivado: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Implementações: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Observações

BotFrameworkAdapter ainda é suportado, mas o adaptador recomendado é 'CloudAdapter'. O adaptador de bot encapsula processos de autenticação e envia e recebe atividades do Bot Connector Service. 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 IMiddleware objetos à coleção de middleware do seu adaptador. O adaptador processa e direciona as atividades de entrada através do pipeline de middleware do 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

Name	Descrição
BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicializa uma nova instância da BotFrameworkAdapter classe, usando um fornecedor de credenciais.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicializa uma nova instância da BotFrameworkAdapter classe, usando um fornecedor de credenciais.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicializa uma nova instância da BotFrameworkAdapter classe, usando um fornecedor de credenciais.

Campos

Name	Descrição
BotIdentityKey	O valor da cadeia de caracteres para a chave de identidade do bot. (Herdado de BotAdapter)
InvokeResponseKey	O valor de 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

Name	Descrição
AppCredentialMap	Obtém o mapa de aplicações para AppCredentials este adaptador.
ChannelProvider	Obtém o provedor de canal para esse adaptador.
CredentialProvider	Obtém o provedor de credenciais para esse adaptador.
HttpClient	Recebe o adaptador personalizado HttpClient se especificado.
Logger	Obtém o registador para este 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

Name	Descrição
BuildCredentialsAsync(String, String)	Lógica para construir um AppCredentials objeto a ser usado para adquirir tokens para este HttpClient.
CanProcessOutgoingActivity(Activity)	Oportunidade para as 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. Overload recebe um 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. Overload recebe um ConversationReference incluindo o locatário.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Cria uma conversa no canal especificado. (Herdado de BotAdapter)
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Cria um cliente OAuth para o bot com as credenciais.
CreateOAuthApiClientAsync(ITurnContext)	Cria um cliente OAuth para o bot.
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 Ative Directory para recursos específicos em uma conexão configurada, usando AppCredentials personalizadas.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Recupera tokens do Azure Ative Directory para recursos específicos em uma conexão configurada, usando 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 devolve resultados em páginas e cada página incluirá um `continuationToken` que pode ser usado para obter a página seguinte de resultados do servidor.
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Lista as Conversas nas quais esse bot participou para um determinado servidor de canal. O servidor de canal devolve resultados em páginas e cada página incluirá um `continuationToken` que pode ser usado para obter a página seguinte de resultados do servidor.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Obtenha o link de login bruto a ser enviado ao usuário para entrar em um nome de conexão, usando AppCredentials personalizadas.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Obtenha o link de login bruto a ser enviado ao usuário para entrar em um nome de conexão, usando AppCredentials personalizadas.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Obtenha o link de login bruto a ser enviado ao usuário para entrar em um nome de conexão, usando AppCredentials do bot.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Obtenha o link de login bruto a ser enviado ao usuário para entrar em um nome de conexão, usando AppCredentials do bot.
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Obtenha o link de login bruto a ser enviado ao usuário para entrar em um nome de conexão.
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Obtenha o link de login 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 login 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 um determinado usuário, usando AppCredentials personalizadas.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Recupera o status do token para cada conexão configurada para um determinado usuário, usando as AppCredentials do bot.
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Tenta recuperar o token de um usuário que está em um fluxo de login, usando AppCredentials personalizadas.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Tenta recuperar o token de um usuário que está em um fluxo de login, usando 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 lógica personalizada para processar a atividade de saída.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Inicia o processamento de atividades para o turno atual do bot. (Herdado de BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Envia atividades para a conversa.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Sai o usuário com o servidor de token, usando AppCredentials personalizadas.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Sai o usuário com o servidor de token, usando AppCredentials do bot.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Substitui uma atividade existente na conversa.
Use(IMiddleware)	Adiciona middleware ao pipeline do adaptador.

Implementações de Interface Explícita

Name	Descrição
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 da Extensão

Name	Descrição
UseBotState(BotAdapter, BotState[])	Adiciona middleware ao adaptador para registar um ou mais BotState objetos no contexto do turn. 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ção com o adaptador. Estes objetos estarão disponíveis através do método .TurnState do Get<T>()contexto de turno.
UseStorage(BotAdapter, IStorage)	Adiciona middleware ao adaptador para registar um IStorage objeto no contexto do turn. O middleware registra os objetos de estado no contexto de turno no início de cada turno.

Aplica-se a