BotFrameworkAdapter Classe

public static final String CONNECTOR_CLIENT_KEY

Clé pour stocker ConnectorClient.

public static final String INVOKE_RESPONSE_KEY

Clé pour stocker InvokeResponse.

public static final String TEAMSCONNECTOR_CLIENT_KEY

Clé pour stocker TeamsConnectorClient. Pour les tests uniquement.

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

Initialise une nouvelle instance de la classe BotFrameworkAdapter à l’aide d’un fournisseur d’informations d’identification.

Paramètres:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

Initialise une nouvelle instance de la classe BotFrameworkAdapter à l’aide d’un fournisseur d’informations d’identification.

Paramètres:

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

Initialise une nouvelle instance de la classe BotFrameworkAdapter à l’aide d’un fournisseur d’informations d’identification.

Paramètres:

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

Initialise une nouvelle instance de la classe BotFrameworkAdapter à l’aide d’un fournisseur d’informations d’identification.

Paramètres:

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

Insère un ConnectorClient dans le cache. POUR LES TESTS UNITAIRES UNIQUEMENT.

Paramètres:

protected CompletableFuture buildAppCredentials(String appId, String scope)

Crée un objet AppCredentials pour l’appId et l’étendue spécifiés.

Paramètres:

Retours:

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

Envoie un message proactif à une conversation.

Appelez cette méthode de manière proactive pour envoyer un message à une conversation. La plupart des canaux nécessitent qu’un utilisateur lance une conversation avec un bot avant que le bot puisse envoyer des activités à l’utilisateur.

Remplacements:

Paramètres:

Retours:

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

Envoie un message proactif à une conversation.

Appelez cette méthode de manière proactive pour envoyer un message à une conversation. La plupart des canaux nécessitent qu’un utilisateur lance une conversation avec un bot avant que le bot puisse envoyer des activités à l’utilisateur.

Remplacements:

Paramètres:

Retours:

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

Envoie un message proactif du bot à une conversation.

Appelez cette méthode de manière proactive pour envoyer un message à une conversation. La plupart des canaux nécessitent qu’un utilisateur lance une conversation avec un bot avant que le bot puisse envoyer des activités à l’utilisateur.

Cette surcharge diffère de l’implémentation du nœud en exigeant que botId soit transmis. Le code .Net permet à plusieurs bots d’être hébergés dans une seule carte qui n’est pas prise en charge par Node.

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

Remplacements:

Paramètres:

Retours:

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

Crée le client de connecteur asynchrone.

Paramètres:

Retours:

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

Crée une conversation sur le canal spécifié. Pour démarrer une conversation, votre bot doit connaître ses informations de compte et les informations de compte de l’utilisateur sur ce canal. La plupart des canaux prennent uniquement en charge le lancement d’une conversation de message direct (non-groupe).

L’adaptateur tente de créer une conversation sur le canal, puis envoie une activité conversationUpdate via son pipeline d’intergiciels à la méthode callback.

Si la conversation est établie avec les utilisateurs spécifiés, l’ID du Activity#getConversation de l’activité contient l’ID de la nouvelle conversation.

Paramètres:

Retours:

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

Crée une conversation sur le canal spécifié. Pour démarrer une conversation, votre bot doit connaître ses informations de compte et les informations de compte de l’utilisateur sur ce canal. La plupart des canaux prennent uniquement en charge le lancement d’une conversation de message direct (non-groupe).

L’adaptateur tente de créer une conversation sur le canal, puis envoie une activité conversationUpdate via son pipeline d’intergiciels à la méthode callback.

Si la conversation est établie avec les utilisateurs spécifiés, l’ID du Activity#getConversation de l’activité contient l’ID de la nouvelle conversation.

Paramètres:

Retours:

protected CompletableFuture createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

Crée un client OAuth pour le bot.

Remarque : Il s’agit principalement d’une protection qui permet aux tests unitaires de remplacer pour fournir un OAuthClient fictif.

Paramètres:

Retours:

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Supprime une activité existante dans la conversation.

Remplacements:

Paramètres:

Retours:

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

Supprime un membre de la conversation actuelle.

Paramètres:

Retours:

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

Effectue une opération d’échange de jetons telle que pour l’authentification unique.

Paramètres:

Retours:

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

Effectue une opération d’échange de jetons telle que pour l’authentification unique.

Paramètres:

Retours:

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

Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée, à l’aide d’AppCredentials personnalisés.

Paramètres:

Retours:

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

Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée.

Paramètres:

Retours:

public CompletableFuture> getActivityMembers(TurnContextImpl context)

Répertorie les membres d’une activité donnée.

Paramètres:

Retours:

public CompletableFuture> getActivityMembers(TurnContextImpl context, String activityId)

Répertorie les membres d’une activité donnée.

Paramètres:

Retours:

protected Map getConnectorClientCache()

Obtenez le cache ConnectorClient. POUR LES TESTS UNITAIRES.

Retours:

public CompletableFuture> getConversationMembers(TurnContextImpl context)

Répertorie les membres de la conversation actuelle.

Paramètres:

Retours:

public CompletableFuture getConversations(TurnContextImpl context)

Répertorie les conversations dans lesquelles ce bot a participé pour un serveur de canal donné. Le serveur de canal retourne les résultats dans les pages et chaque page inclut un « continuationToken » qui peut être utilisé pour extraire la page suivante des résultats à partir du serveur. Cette surcharge peut être appelée pendant le traitement d’activité standard, à quel moment l’URL du service du bot et les informations d’identification qui font partie du pipeline de traitement d’activité actuel seront utilisées.

Paramètres:

Retours:

public CompletableFuture getConversations(TurnContextImpl context, String continuationToken)

Répertorie les conversations dans lesquelles ce bot a participé pour un serveur de canal donné. Le serveur de canal retourne les résultats dans les pages et chaque page inclut un « continuationToken » qui peut être utilisé pour extraire la page suivante des résultats à partir du serveur. Cette surcharge peut être appelée pendant le traitement d’activité standard, à quel moment l’URL du service du bot et les informations d’identification qui font partie du pipeline de traitement d’activité actuel seront utilisées.

Paramètres:

Retours:

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

Répertorie les conversations dans lesquelles ce bot a participé pour un serveur de canal donné. Le serveur de canal retourne les résultats dans les pages et chaque page inclut un « continuationToken » qui peut être utilisé pour extraire la page suivante des résultats à partir du serveur.

Paramètres:

Retours:

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

Répertorie les conversations dans lesquelles ce bot a participé pour un serveur de canal donné. Le serveur de canal retourne les résultats dans les pages et chaque page inclut un « continuationToken » qui peut être utilisé pour extraire la page suivante des résultats à partir du serveur. Cette surcharge peut être appelée à partir de l’extérieur du contexte d’une conversation, car seules les informations d’identification et ServiceUrl du bot sont requises.

Paramètres:

Retours:

protected Map getCredentialsCache()

Obtenez le cache AppCredentials. Pour les tests unitaires.

Retours:

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

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide d’AppCredentials personnalisés.

Paramètres:

Retours:

     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)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion, à l’aide de l’AppCredentials du bot.

Paramètres:

Retours:

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

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

Retours:

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

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

Retours:

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

Retourne un ConnectorClient, à partir d’un cache ou d’une nouvelle création.

Remarque : Il est protégé principalement pour permettre aux tests unitaires de remplacer ceci pour fournir un ConnectorClient fictif

Paramètres:

Retours:

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

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

Retours:

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

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

Retours:

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

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

Obtenez le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

Paramètres:

Retours:

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

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

Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné, à l’aide d’AppCredentials personnalisés.

Paramètres:

Retours:

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

Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné.

Paramètres:

Retours:

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

Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion à l’aide d’AppCredentials personnalisés.

Paramètres:

Retours:

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

Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion.

Paramètres:

Retours:

protected static String keyForAppCredentials(String appId, String scope)

Génère la clé pour accéder au cache des informations d’identification de l’application.

Paramètres:

Retours:

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

Génère la clé pour accéder au cache client du connecteur.

Paramètres:

Retours:

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

Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante.

Paramètres:

Retours:

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

Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante.

Paramètres:

Retours:

public CompletableFuture sendActivities(TurnContext context, List activities)

Envoie des activités à la conversation.

Remplacements:

Paramètres:

Retours:

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

Déconnecte l’utilisateur avec le serveur de jetons à l’aide d’AppCredentials personnalisés.

Paramètres:

Retours:

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

Déconnecte l’utilisateur avec le serveur de jetons.

Paramètres:

Retours:

public CompletableFuture updateActivity(TurnContext context, Activity activity)

Remplace une activité existante dans la conversation.

Remplacements:

Paramètres:

Retours:

public BotFrameworkAdapter use(Middleware middleware)

Ajoute un intergiciel au pipeline de l’adaptateur. L’intergiciel est ajouté à l’adaptateur au moment de l’initialisation. Pour chaque tour, l’adaptateur appelle l’intergiciel dans l’ordre dans lequel vous l’avez ajouté.

Remplacements:

Paramètres:

Retours: