BotFrameworkAdapter Klasse

public static final String CONNECTOR_CLIENT_KEY

Schlüssel zum Speichern von ConnectorClient.

public static final String INVOKE_RESPONSE_KEY

Schlüssel zum Speichern von InvokeResponse.

public static final String TEAMSCONNECTOR_CLIENT_KEY

Schlüssel zum Speichern von TeamsConnectorClient. Nur für Tests.

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

Initialisiert eine neue Instanz der BotFrameworkAdapter Klasse mithilfe eines Anmeldeinformationsanbieters.

Parameter:

public BotFrameworkAdapter(CredentialProvider withCredentialProvider)

Initialisiert eine neue Instanz der BotFrameworkAdapter Klasse mithilfe eines Anmeldeinformationsanbieters.

Parameter:

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

Initialisiert eine neue Instanz der BotFrameworkAdapter Klasse mithilfe eines Anmeldeinformationsanbieters.

Parameter:

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

Initialisiert eine neue Instanz der BotFrameworkAdapter Klasse mithilfe eines Anmeldeinformationsanbieters.

Parameter:

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

Fügt einen ConnectorClient in den Cache ein. NUR FÜR KOMPONENTENTESTS.

Parameter:

protected CompletableFuture buildAppCredentials(String appId, String scope)

Erstellt ein AppCredentials-Objekt für die angegebene appId und den angegebenen Bereich.

Parameter:

Gibt zurück:

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

Sendet eine proaktive Nachricht an eine Unterhaltung.

Rufen Sie diese Methode auf, um proaktiv eine Nachricht an eine Unterhaltung zu senden. Die meisten Kanäle erfordern, dass ein Benutzer eine Unterhaltung mit einem Bot initiiert, bevor der Bot Aktivitäten an den Benutzer senden kann.

Überschreibt:

Parameter:

Gibt zurück:

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

Sendet eine proaktive Nachricht an eine Unterhaltung.

Rufen Sie diese Methode auf, um proaktiv eine Nachricht an eine Unterhaltung zu senden. Die meisten Kanäle erfordern, dass ein Benutzer eine Unterhaltung mit einem Bot initiiert, bevor der Bot Aktivitäten an den Benutzer senden kann.

Überschreibt:

Parameter:

Gibt zurück:

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

Sendet eine proaktive Nachricht vom Bot an eine Unterhaltung.

Rufen Sie diese Methode auf, um proaktiv eine Nachricht an eine Unterhaltung zu senden. Die meisten Kanäle erfordern, dass ein Benutzer eine Unterhaltung mit einem Bot initiiert, bevor der Bot Aktivitäten an den Benutzer senden kann.

Diese Überladung unterscheidet sich von der Node-Implementierung, indem die BotId übergeben werden muss. Der .Net-Code ermöglicht es mehreren Bots, in einem einzelnen Adapter gehostet zu werden, der von Node nicht unterstützt wird.

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

Überschreibt:

Parameter:

Gibt zurück:

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

Erstellt den Connectorclient asynchron.

Parameter:

Gibt zurück:

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

Erstellt eine Unterhaltung im angegebenen Kanal. Um eine Unterhaltung zu starten, muss Ihr Bot seine Kontoinformationen und die Kontoinformationen des Benutzers in diesem Kanal kennen. Die meisten Kanäle unterstützen nur das Initiieren einer direkten Nachricht (nicht gruppenbezogene) Unterhaltung.

Der Adapter versucht, eine neue Unterhaltung im Kanal zu erstellen, und sendet dann eine conversationUpdate Aktivität über die Middleware-Pipeline an die callback-Methode.

Wenn die Unterhaltung mit den angegebenen Benutzern hergestellt wird, enthält die ID der Activity#getConversation der Aktivität die ID der neuen Unterhaltung.

Parameter:

Gibt zurück:

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

Erstellt eine Unterhaltung im angegebenen Kanal. Um eine Unterhaltung zu starten, muss Ihr Bot seine Kontoinformationen und die Kontoinformationen des Benutzers in diesem Kanal kennen. Die meisten Kanäle unterstützen nur das Initiieren einer direkten Nachricht (nicht gruppenbezogene) Unterhaltung.

Der Adapter versucht, eine neue Unterhaltung im Kanal zu erstellen, und sendet dann eine conversationUpdate Aktivität über die Middleware-Pipeline an die callback-Methode.

Wenn die Unterhaltung mit den angegebenen Benutzern hergestellt wird, enthält die ID der Activity#getConversation der Aktivität die ID der neuen Unterhaltung.

Parameter:

Gibt zurück:

protected CompletableFuture createOAuthAPIClient(TurnContext turnContext, AppCredentials oAuthAppCredentials)

Erstellt einen OAuth-Client für den Bot.

Hinweis: Dies ist in erster Linie geschützt, sodass Komponententests außer Kraft setzen können, um einen simulierten OAuthClient bereitzustellen.

Parameter:

Gibt zurück:

public CompletableFuture deleteActivity(TurnContext context, ConversationReference reference)

Löscht eine vorhandene Aktivität in der Unterhaltung.

Überschreibt:

Parameter:

Gibt zurück:

public CompletableFuture deleteConversationMember(TurnContextImpl context, String memberId)

Löscht ein Mitglied aus der aktuellen Unterhaltung.

Parameter:

Gibt zurück:

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

Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.

Parameter:

Gibt zurück:

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

Führt einen Tokenaustauschvorgang aus, z. B. für einmaliges Anmelden.

Parameter:

Gibt zurück:

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

Ruft Azure Active Directory-Token für bestimmte Ressourcen für eine konfigurierte Verbindung mithilfe von angepassten AppCredentials ab.

Parameter:

Gibt zurück:

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

Ruft Azure Active Directory-Token für bestimmte Ressourcen in einer konfigurierten Verbindung ab.

Parameter:

Gibt zurück:

public CompletableFuture> getActivityMembers(TurnContextImpl context)

Listet die Mitglieder einer bestimmten Aktivität auf.

Parameter:

Gibt zurück:

public CompletableFuture> getActivityMembers(TurnContextImpl context, String activityId)

Listet die Mitglieder einer bestimmten Aktivität auf.

Parameter:

Gibt zurück:

protected Map getConnectorClientCache()

Rufen Sie den ConnectorClient-Cache ab. FÜR KOMPONENTENTESTS.

Gibt zurück:

public CompletableFuture> getConversationMembers(TurnContextImpl context)

Listet die Mitglieder der aktuellen Unterhaltung auf.

Parameter:

Gibt zurück:

public CompletableFuture getConversations(TurnContextImpl context)

Listet die Unterhaltungen auf, an denen dieser Bot für einen bestimmten Kanalserver teilgenommen hat. Der Kanalserver gibt Ergebnisse auf Seiten zurück, und jede Seite enthält ein "continuationToken", das verwendet werden kann, um die nächste Seite der Ergebnisse vom Server abzurufen. Diese Überladung kann während der standardmäßigen Aktivitätsverarbeitung aufgerufen werden, an welcher Stelle die Dienst-URL und Anmeldeinformationen des Bots, die Teil der aktuellen Aktivitätsverarbeitungspipeline sind, verwendet werden.

Parameter:

Gibt zurück:

public CompletableFuture getConversations(TurnContextImpl context, String continuationToken)

Listet die Unterhaltungen auf, an denen dieser Bot für einen bestimmten Kanalserver teilgenommen hat. Der Kanalserver gibt Ergebnisse auf Seiten zurück, und jede Seite enthält ein "continuationToken", das verwendet werden kann, um die nächste Seite der Ergebnisse vom Server abzurufen. Diese Überladung kann während der standardmäßigen Aktivitätsverarbeitung aufgerufen werden, an welcher Stelle die Dienst-URL und Anmeldeinformationen des Bots, die Teil der aktuellen Aktivitätsverarbeitungspipeline sind, verwendet werden.

Parameter:

Gibt zurück:

public CompletableFuture getConversations(String serviceUrl, MicrosoftAppCredentials credentials)

Listet die Unterhaltungen auf, an denen dieser Bot für einen bestimmten Kanalserver teilgenommen hat. Der Kanalserver gibt Ergebnisse auf Seiten zurück, und jede Seite enthält ein "continuationToken", das verwendet werden kann, um die nächste Seite der Ergebnisse vom Server abzurufen.

Parameter:

Gibt zurück:

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

Listet die Unterhaltungen auf, an denen dieser Bot für einen bestimmten Kanalserver teilgenommen hat. Der Kanalserver gibt Ergebnisse auf Seiten zurück, und jede Seite enthält ein "continuationToken", das verwendet werden kann, um die nächste Seite der Ergebnisse vom Server abzurufen. Diese Überladung kann außerhalb des Kontexts einer Unterhaltung aufgerufen werden, da nur serviceUrl und Anmeldeinformationen des Bots erforderlich sind.

Parameter:

Gibt zurück:

protected Map getCredentialsCache()

Rufen Sie den AppCredentials-Cache ab. Für Komponententests.

Gibt zurück:

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

Rufen Sie den unformatierten Anmeldelink ab, der mit angepassten AppCredentials an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

Gibt zurück:

     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)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden, indem Sie die AppCredentials des Bots verwenden.

Parameter:

Gibt zurück:

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

public CompletableFuture getOAuthSignInLink(TurnContext context, String connectionName)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

Gibt zurück:

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

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

Gibt zurück:

protected CompletableFuture getOrCreateConnectorClient(String serviceUrl, AppCredentials usingAppCredentials)

Gibt einen ConnectorClient zurück, entweder aus einem Cache oder neu erstellt.

Hinweis: Dies ist in erster Linie geschützt, damit Komponententests dies außer Kraft setzen können, um einen simulierten ConnectorClient bereitzustellen.

Parameter:

Gibt zurück:

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

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

Gibt zurück:

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

public CompletableFuture getSignInResource(TurnContext turnContext, String connectionName)

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

Gibt zurück:

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

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

Rufen Sie den unformatierten Anmeldelink ab, der an den Benutzer gesendet werden soll, um sich für einen Verbindungsnamen anzumelden.

Parameter:

Gibt zurück:

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

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

Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer mithilfe von angepassten AppCredentials ab.

Parameter:

Gibt zurück:

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

Ruft den Tokenstatus für jede konfigurierte Verbindung für den angegebenen Benutzer ab.

Parameter:

Gibt zurück:

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

Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldefluss befindet, mithilfe von angepassten AppCredentials.

Parameter:

Gibt zurück:

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

Versucht, das Token für einen Benutzer abzurufen, der sich in einem Anmeldeablauf befindet.

Parameter:

Gibt zurück:

protected static String keyForAppCredentials(String appId, String scope)

Generiert den Schlüssel für den Zugriff auf den Cache für App-Anmeldeinformationen.

Parameter:

Gibt zurück:

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

Generiert den Schlüssel für den Zugriff auf den Connectorclientcache.

Parameter:

Gibt zurück:

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

Erstellt einen Turnkontext und führt die Middlewarepipeline für eine eingehende Aktivität aus.

Parameter:

Gibt zurück:

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

Erstellt einen Turnkontext und führt die Middlewarepipeline für eine eingehende Aktivität aus.

Parameter:

Gibt zurück:

public CompletableFuture sendActivities(TurnContext context, List activities)

Sendet Aktivitäten an die Unterhaltung.

Überschreibt:

Parameter:

Gibt zurück:

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

Signiert den Benutzer mit dem Tokenserver mit angepassten AppCredentials.

Parameter:

Gibt zurück:

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

Meldet den Benutzer mit dem Tokenserver ab.

Parameter:

Gibt zurück:

public CompletableFuture updateActivity(TurnContext context, Activity activity)

Ersetzt eine vorhandene Aktivität in der Unterhaltung.

Überschreibt:

Parameter:

Gibt zurück:

public BotFrameworkAdapter use(Middleware middleware)

Fügt Middleware zur Pipeline des Adapters hinzu. Middleware wird dem Adapter zur Initialisierungszeit hinzugefügt. Für jede Drehung ruft der Adapter Middleware in der Reihenfolge auf, in der Sie ihn hinzugefügt haben.

Überschreibt:

Parameter:

Gibt zurück: