BotFrameworkAdapter Clase

Referencia

Definición

Espacio de nombres:: Microsoft.Bot.Builder

Ensamblado:: Microsoft.Bot.Builder.dll

Paquete:: Microsoft.Bot.Builder v4.22.7

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Un adaptador de bot que puede conectar un bot a un punto de conexión de servicio.

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

Herencia: Object

BotAdapter
BotFrameworkAdapter

Derivado: Microsoft.Bot.Builder.Streaming.BotFrameworkHttpAdapterBase

Implementaciones: IExtendedUserTokenProvider IAdapterIntegration IUserTokenProvider IConnectorClientBuilder

Comentarios

BotFrameworkAdapter sigue siendo compatible, pero el adaptador recomendado es "CloudAdapter". El adaptador de bot encapsula los procesos de autenticación y envía actividades a y recibe actividades de Bot Connector Service. Cuando el bot recibe una actividad, el adaptador crea un objeto de contexto, lo pasa a la lógica de la aplicación del bot y envía respuestas de vuelta al canal del usuario.

Use Use(IMiddleware) para agregar IMiddleware objetos a la colección de middleware del adaptador. El adaptador procesa y dirige las actividades entrantes en a través de la canalización de middleware del bot a la lógica del bot y, a continuación, vuelve a salir. A medida que cada actividad fluye dentro y fuera del bot, cada fragmento de middleware puede inspeccionar o actuar sobre la actividad, tanto antes como después de que se ejecute la lógica del bot.

Constructores

BotFrameworkAdapter(AppCredentials, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicializa una nueva instancia de la clase BotFrameworkAdapter mediante un proveedor de credenciales.
BotFrameworkAdapter(ICredentialProvider, AuthenticationConfiguration, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicializa una nueva instancia de la clase BotFrameworkAdapter mediante un proveedor de credenciales.
BotFrameworkAdapter(ICredentialProvider, IChannelProvider, RetryPolicy, HttpClient, IMiddleware, ILogger)	Inicializa una nueva instancia de la clase BotFrameworkAdapter mediante un proveedor de credenciales.

Campos

BotIdentityKey	Valor de cadena de la clave de identidad del bot. (Heredado de BotAdapter)
InvokeResponseKey	El valor de clave de cualquier InvokeResponseActivity que estaría en TurnState. (Heredado de BotAdapter)
OAuthScopeKey	Valor de cadena de la clave de ámbito de OAuth. (Heredado de BotAdapter)

Propiedades

AppCredentialMap	Obtiene el mapa de las aplicaciones que se van a AppCredentials para este adaptador.
ChannelProvider	Obtiene el proveedor de canales para este adaptador.
CredentialProvider	Obtiene el proveedor de credenciales de este adaptador.
HttpClient	Obtiene el HttpClient personalizado para este adaptador si se especifica.
Logger	Obtiene el registrador de este adaptador.
MiddlewareSet	Obtiene la colección de middleware en la canalización del adaptador. (Heredado de BotAdapter)
OnTurnError	Obtiene o establece un controlador de errores que puede detectar excepciones en el middleware o la aplicación. (Heredado de BotAdapter)

Métodos

BuildCredentialsAsync(String, String)	Lógica para compilar un objeto AppCredentials que se usará para adquirir tokens para este HttpClient.
CanProcessOutgoingActivity(Activity)	Oportunidad para que las subclases opten por procesar una actividad saliente.
ContinueConversationAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Envía un mensaje proactivo a una conversación. (Heredado de BotAdapter)
ContinueConversationAsync(ClaimsIdentity, Activity, String, BotCallbackHandler, CancellationToken)	Envía un mensaje proactivo a una conversación. (Heredado de BotAdapter)
ContinueConversationAsync(ClaimsIdentity, ConversationReference, BotCallbackHandler, CancellationToken)	Envía un mensaje proactivo desde el bot a una conversación.
ContinueConversationAsync(ClaimsIdentity, ConversationReference, String, BotCallbackHandler, CancellationToken)	Envía un mensaje proactivo desde el bot a una conversación.
ContinueConversationAsync(String, Activity, BotCallbackHandler, CancellationToken)	Envía un mensaje proactivo a una conversación. (Heredado de BotAdapter)
ContinueConversationAsync(String, ConversationReference, BotCallbackHandler, CancellationToken)	Envía un mensaje proactivo desde el bot a una conversación.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Crea una conversación en el canal especificado.
CreateConversationAsync(String, String, AppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsoletos. Crea una conversación en el canal especificado. La sobrecarga recibe una ConversationReference, incluido el inquilino.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, CancellationToken)	Crea una conversación en el canal especificado.
CreateConversationAsync(String, String, MicrosoftAppCredentials, ConversationParameters, BotCallbackHandler, ConversationReference, CancellationToken)	Obsoletos. Crea una conversación en el canal especificado. La sobrecarga recibe una ConversationReference, incluido el inquilino.
CreateConversationAsync(String, String, String, String, ConversationParameters, BotCallbackHandler, CancellationToken)	Crea una conversación en el canal especificado. (Heredado de BotAdapter)
CreateOAuthApiClientAsync(ITurnContext)	Crea un cliente de OAuth para el bot.
CreateOAuthApiClientAsync(ITurnContext, AppCredentials)	Crea un cliente de OAuth para el bot con las credenciales.
DeleteActivityAsync(ITurnContext, ConversationReference, CancellationToken)	Elimina una actividad existente en la conversación.
DeleteConversationMemberAsync(ITurnContext, String, CancellationToken)	Quita un miembro de la conversación actual.
ExchangeTokenAsync(ITurnContext, AppCredentials, String, String, TokenExchangeRequest, CancellationToken)	Realiza una operación de intercambio de tokens como para el inicio de sesión único.
ExchangeTokenAsync(ITurnContext, String, String, TokenExchangeRequest, CancellationToken)	Realiza una operación de intercambio de tokens como para el inicio de sesión único.
GetAadTokensAsync(ITurnContext, AppCredentials, String, String[], String, CancellationToken)	Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada mediante AppCredentials personalizados.
GetAadTokensAsync(ITurnContext, String, String[], String, CancellationToken)	Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada mediante AppCredentials del bot.
GetActivityMembersAsync(ITurnContext, String, CancellationToken)	Enumera los miembros de una actividad determinada.
GetConversationMembersAsync(ITurnContext, CancellationToken)	Enumera los miembros de la conversación actual.
GetConversationsAsync(ITurnContext, String, CancellationToken)	Enumera las conversaciones en las que este bot ha participado para un servidor de canal determinado. El servidor de canal devuelve resultados en páginas y cada página incluirá un `continuationToken` que se puede usar para capturar la siguiente página de resultados del servidor.
GetConversationsAsync(String, MicrosoftAppCredentials, String, CancellationToken)	Enumera las conversaciones en las que este bot ha participado para un servidor de canal determinado. El servidor de canal devuelve resultados en páginas y cada página incluirá un `continuationToken` que se puede usar para capturar la siguiente página de resultados del servidor.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, CancellationToken)	Obtenga el vínculo de inicio de sesión sin formato que se va a enviar al usuario para iniciar sesión para un nombre de conexión mediante AppCredentials personalizado.
GetOauthSignInLinkAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Obtenga el vínculo de inicio de sesión sin formato que se va a enviar al usuario para iniciar sesión para un nombre de conexión mediante AppCredentials personalizado.
GetOauthSignInLinkAsync(ITurnContext, String, CancellationToken)	Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión mediante AppCredentials del bot.
GetOauthSignInLinkAsync(ITurnContext, String, String, String, CancellationToken)	Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión mediante AppCredentials del bot.
GetSignInResourceAsync(ITurnContext, AppCredentials, String, String, String, CancellationToken)	Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.
GetSignInResourceAsync(ITurnContext, String, CancellationToken)	Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.
GetSignInResourceAsync(ITurnContext, String, String, String, CancellationToken)	Obtenga el vínculo de inicio de sesión sin procesar que se enviará al usuario para iniciar sesión para un nombre de conexión.
GetTokenStatusAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Recupera el estado del token para cada conexión configurada para el usuario determinado, mediante AppCredentials personalizado.
GetTokenStatusAsync(ITurnContext, String, String, CancellationToken)	Recupera el estado del token para cada conexión configurada para el usuario determinado, mediante appCredentials del bot.
GetUserTokenAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión mediante AppCredentials personalizado.
GetUserTokenAsync(ITurnContext, String, String, CancellationToken)	Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión mediante appCredentials del bot.
ProcessActivityAsync(ClaimsIdentity, Activity, BotCallbackHandler, CancellationToken)	Crea un contexto de turno y ejecuta la canalización de middleware para una actividad entrante.
ProcessActivityAsync(String, Activity, BotCallbackHandler, CancellationToken)	Crea un contexto de turno y ejecuta la canalización de middleware para una actividad entrante.
ProcessOutgoingActivityAsync(ITurnContext, Activity, CancellationToken)	Lógica personalizada para enviar una actividad saliente. Las subclases pueden invalidar este método junto con CanProcessOutgoingActivity para tener lógica personalizada para procesar la actividad saliente.
RunPipelineAsync(ITurnContext, BotCallbackHandler, CancellationToken)	Inicia el procesamiento de actividad para el turno de bot actual. (Heredado de BotAdapter)
SendActivitiesAsync(ITurnContext, Activity[], CancellationToken)	Envía actividades a la conversación.
SignOutUserAsync(ITurnContext, AppCredentials, String, String, CancellationToken)	Cierra la sesión del usuario con el servidor de tokens mediante AppCredentials personalizado.
SignOutUserAsync(ITurnContext, String, String, CancellationToken)	Cierra la sesión del usuario con el servidor de tokens mediante AppCredentials del bot.
UpdateActivityAsync(ITurnContext, Activity, CancellationToken)	Reemplaza una actividad existente en la conversación.
Use(IMiddleware)	Agrega middleware a la canalización del adaptador.

Implementaciones de interfaz explícitas

IConnectorClientBuilder.CreateConnectorClientAsync(String, ClaimsIdentity, String, CancellationToken)

Un adaptador de bot que puede conectar un bot a un punto de conexión de servicio.

Métodos de extensión

UseBotState(BotAdapter, BotState[])	Agrega middleware al adaptador para registrar uno o varios objetos BotState en el contexto de turno. El middleware registra los objetos de estado en el contexto de turno al principio de cada turno.
UseState(BotAdapter, UserState, ConversationState, Boolean)	Obsoletos. Registra objetos de estado de usuario y conversación con el adaptador. Estos objetos estarán disponibles a través de la TurnStatedel contexto de turno. métodoGet<T>().
UseStorage(BotAdapter, IStorage)	Agrega middleware al adaptador para registrar un objeto IStorage en el contexto de turno. El middleware registra los objetos de estado en el contexto de turno al principio de cada turno.

Se aplica a

Compartir a través de