BotFrameworkAdapter Clase

public static final String CONNECTOR_CLIENT_KEY

Clave para almacenar ConnectorClient.

public static final String INVOKE_RESPONSE_KEY

Clave para almacenar InvokeResponse.

public static final String TEAMSCONNECTOR_CLIENT_KEY

Clave para almacenar TeamsConnectorClient. Solo para pruebas.

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

Inicializa una nueva instancia de la clase BotFrameworkAdapter mediante un proveedor de credenciales.

Parámetros:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

Inicializa una nueva instancia de la clase BotFrameworkAdapter mediante un proveedor de credenciales.

Parámetros:

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

Inicializa una nueva instancia de la clase BotFrameworkAdapter mediante un proveedor de credenciales.

Parámetros:

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

Inicializa una nueva instancia de la clase BotFrameworkAdapter mediante un proveedor de credenciales.

Parámetros:

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

Inserta un ConnectorClient en la memoria caché. SOLO PARA PRUEBAS UNITARIAS.

Parámetros:

protected CompletableFuture buildAppCredentials(String appId, String scope)

Crea un objeto AppCredentials para el appId y el ámbito especificados.

Parámetros:

Devoluciones:

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

Envía un mensaje proactivo a una conversación.

Llame a este método para enviar de forma proactiva un mensaje a una conversación. La mayoría de los canales requieren que un usuario inicie una conversación con un bot antes de que el bot pueda enviar actividades al usuario.

Invalidaciones:

Parámetros:

Devoluciones:

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

Envía un mensaje proactivo a una conversación.

Llame a este método para enviar de forma proactiva un mensaje a una conversación. La mayoría de los canales requieren que un usuario inicie una conversación con un bot antes de que el bot pueda enviar actividades al usuario.

Invalidaciones:

Parámetros:

Devoluciones:

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

Envía un mensaje proactivo desde el bot a una conversación.

Llame a este método para enviar de forma proactiva un mensaje a una conversación. La mayoría de los canales requieren que un usuario inicie una conversación con un bot antes de que el bot pueda enviar actividades al usuario.

Esta sobrecarga difiere de la implementación del nodo, ya que requiere que se pase botId. El código .Net permite hospedar varios bots en un único adaptador que no es algo compatible con Node.

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

Invalidaciones:

Parámetros:

Devoluciones:

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

Crea el cliente del conector asincrónico.

Parámetros:

Devoluciones:

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

Crea una conversación en el canal especificado. Para iniciar una conversación, el bot debe conocer su información de cuenta y la información de la cuenta del usuario en ese canal. La mayoría de los canales solo admiten iniciar una conversación de mensaje directo (no grupo).

El adaptador intenta crear una nueva conversación en el canal y, a continuación, envía una actividad conversationUpdate a través de su canalización de middleware al método callback.

Si la conversación se establece con los usuarios especificados, el identificador de la Activity#getConversation de la actividad contendrá el identificador de la nueva conversación.

Parámetros:

Devoluciones:

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

Crea una conversación en el canal especificado. Para iniciar una conversación, el bot debe conocer su información de cuenta y la información de la cuenta del usuario en ese canal. La mayoría de los canales solo admiten iniciar una conversación de mensaje directo (no grupo).

El adaptador intenta crear una nueva conversación en el canal y, a continuación, envía una actividad conversationUpdate a través de su canalización de middleware al método callback.

Si la conversación se establece con los usuarios especificados, el identificador de la Activity#getConversation de la actividad contendrá el identificador de la nueva conversación.

Parámetros:

Devoluciones:

protected CompletableFuture createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

Crea un cliente de OAuth para el bot.

Nota: Esto está protegido principalmente para que las pruebas unitarias puedan invalidar para proporcionar un OAuthClient ficticio.

Parámetros:

Devoluciones:

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Elimina una actividad existente en la conversación.

Invalidaciones:

Parámetros:

Devoluciones:

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

Elimina un miembro de la conversación actual.

Parámetros:

Devoluciones:

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

Realiza una operación de intercambio de tokens como para el inicio de sesión único.

Parámetros:

Devoluciones:

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

Realiza una operación de intercambio de tokens como para el inicio de sesión único.

Parámetros:

Devoluciones:

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

Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada mediante AppCredentials personalizados.

Parámetros:

Devoluciones:

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

Recupera tokens de Azure Active Directory para recursos concretos en una conexión configurada.

Parámetros:

Devoluciones:

public CompletableFuture> getActivityMembers(TurnContextImpl context)

Enumera los miembros de una actividad determinada.

Parámetros:

Devoluciones:

public CompletableFuture> getActivityMembers(TurnContextImpl context, String activityId)

Enumera los miembros de una actividad determinada.

Parámetros:

Devoluciones:

protected Map getConnectorClientCache()

Obtenga la memoria caché connectorClient. PARA PRUEBAS UNITARIAS.

Devoluciones:

public CompletableFuture> getConversationMembers(TurnContextImpl context)

Enumera los miembros de la conversación actual.

Parámetros:

Devoluciones:

public CompletableFuture getConversations(TurnContextImpl context)

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. Se puede llamar a esta sobrecarga durante el procesamiento de actividad estándar, en cuyo momento se usará la dirección URL del servicio del bot y las credenciales que forman parte de la canalización de procesamiento de actividad actual.

Parámetros:

Devoluciones:

public CompletableFuture getConversations(TurnContextImpl context, String continuationToken)

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. Se puede llamar a esta sobrecarga durante el procesamiento de actividad estándar, en cuyo momento se usará la dirección URL del servicio del bot y las credenciales que forman parte de la canalización de procesamiento de actividad actual.

Parámetros:

Devoluciones:

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

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.

Parámetros:

Devoluciones:

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

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. Se puede llamar a esta sobrecarga desde fuera del contexto de una conversación, ya que solo se requieren serviceUrl y credenciales del bot.

Parámetros:

Devoluciones:

protected Map getCredentialsCache()

Obtenga la memoria caché de AppCredentials. Para pruebas unitarias.

Devoluciones:

public CompletableFuture getOAuthSignInLink(TurnContext context, AppCredentials oAuthAppCredentials, String connectionName)

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.

Parámetros:

Devoluciones:

     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)

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.

Parámetros:

Devoluciones:

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

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

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.

Parámetros:

Devoluciones:

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

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.

Parámetros:

Devoluciones:

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

Devuelve un ConnectorClient, ya sea desde una memoria caché o recién creada.

Nota: Esto está protegido principalmente para permitir que las pruebas unitarias invaliden esto para proporcionar un connectorClient ficticio.

Parámetros:

Devoluciones:

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

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.

Parámetros:

Devoluciones:

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

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

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.

Parámetros:

Devoluciones:

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

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

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.

Parámetros:

Devoluciones:

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

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

Recupera el estado del token para cada conexión configurada para el usuario determinado, mediante AppCredentials personalizado.

Parámetros:

Devoluciones:

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

Recupera el estado del token para cada conexión configurada para el usuario especificado.

Parámetros:

Devoluciones:

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

Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión mediante AppCredentials personalizado.

Parámetros:

Devoluciones:

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

Intenta recuperar el token de un usuario que se encuentra en un flujo de inicio de sesión.

Parámetros:

Devoluciones:

protected static String keyForAppCredentials(String appId, String scope)

Genera la clave para acceder a la caché de credenciales de la aplicación.

Parámetros:

Devoluciones:

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

Genera la clave para acceder a la memoria caché del cliente del conector.

Parámetros:

Devoluciones:

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

Crea un contexto de turno y ejecuta la canalización de middleware para una actividad entrante.

Parámetros:

Devoluciones:

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

Crea un contexto de turno y ejecuta la canalización de middleware para una actividad entrante.

Parámetros:

Devoluciones:

public CompletableFuture sendActivities(TurnContext context, List activities)

Envía actividades a la conversación.

Invalidaciones:

Parámetros:

Devoluciones:

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

Cierra la sesión del usuario con el servidor de tokens mediante AppCredentials personalizado.

Parámetros:

Devoluciones:

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

Cierra la sesión del usuario con el servidor de tokens.

Parámetros:

Devoluciones:

public CompletableFuture updateActivity(TurnContext context, Activity activity)

Reemplaza una actividad existente en la conversación.

Invalidaciones:

Parámetros:

Devoluciones:

public BotFrameworkAdapter use(Middleware middleware)

Agrega middleware a la canalización del adaptador. El middleware se agrega al adaptador en el momento de la inicialización. Para cada turno, el adaptador llama al middleware en el orden en que lo agregó.

Invalidaciones:

Parámetros:

Devoluciones: