BotAdapter Klasse

Referenz

Konstruktor

BotAdapter(on_turn_error: Callable[[TurnContext, Exception], Awaitable] = None)

Parameter

Name	Beschreibung
on_turn_error	Standardwert: None

Methoden

continue_conversation	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. Einzelner Mandant die Adapter (Konsole, Test usw.) ist jedoch für den BotFrameworkAdapter wichtig, der multimandantenfähig ist. :p aram-Referenz: Ein Verweis auf die Unterhaltung, um fortzufahren. :type reference: ConversationReference :p aram callback: The method to call for the result bot turn. :type callback: Callable :p aram claims_identity: Eine <xref:botframework.connector.auth.ClaimsIdentity> für die Unterhaltung. :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A value signifizieren den Empfänger der proaktiven Nachricht. :type audience: str
create_conversation	Startet eine neue Unterhaltung mit einem Benutzer. Wird verwendet, um eine Nachricht an ein Mitglied einer Gruppe zu leiten.
delete_activity	Löscht eine vorhandene Aktivität.
run_pipeline	Wird von der übergeordneten Klasse aufgerufen, um den Adapter-Middleware-Satz auszuführen, und ruft den übergebenen callback() Handler am Ende der Kette auf.
send_activities	Sendet eine Reihe von Aktivitäten an den Benutzer. Ein Array von Antworten vom Server wird zurückgegeben.
update_activity	Ersetzt eine vorhandene Aktivität.
use	Registriert einen Middleware-Handler mit dem Adapter.

continue_conversation

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.

Einzelner Mandant die Adapter (Konsole, Test usw.) ist jedoch für den BotFrameworkAdapter wichtig, der multimandantenfähig ist. :p aram-Referenz: Ein Verweis auf die Unterhaltung, um fortzufahren. :type reference: ConversationReference :p aram callback: The method to call for the result bot turn. :type callback: Callable :p aram claims_identity: Eine <xref:botframework.connector.auth.ClaimsIdentity> für die Unterhaltung. :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A value signifizieren den Empfänger der proaktiven Nachricht. :type audience: str

async continue_conversation(reference: ConversationReference, callback: Callable, bot_id: str = None, claims_identity: ClaimsIdentity = None, audience: str = None)

Parameter

Name	Beschreibung
bot_id	Die Anwendungs-ID des Bots. Dieser Parameter wird ignoriert in Standardwert: None
reference Erforderlich
callback Erforderlich
claims_identity	Standardwert: None
audience	Standardwert: None

create_conversation

Startet eine neue Unterhaltung mit einem Benutzer. Wird verwendet, um eine Nachricht an ein Mitglied einer Gruppe zu leiten.

async create_conversation(reference: ConversationReference, logic: Callable[[TurnContext], Awaitable] = None, conversation_parameters: ConversationParameters = None, channel_id: str = None, service_url: str = None, credentials: AppCredentials = None)

Parameter

Name	Beschreibung
reference Erforderlich	ConversationReference Die Unterhaltungsreferenz, die den Mandanten enthält
logic	Callable Die Logik, die für die Erstellung der Unterhaltung verwendet werden soll Standardwert: None
conversation_parameters	Die Informationen, die zum Erstellen der Unterhaltung verwendet werden sollen Standardwert: None
channel_id	<xref:typing.str> Die ID für den Kanal. Standardwert: None
service_url	<xref:typing.str> Der Dienst-URL-Endpunkt des Kanals. Standardwert: None
credentials	<xref:botframework.connector.auth.AppCredentials> Die Anwendungsanmeldeinformationen für den Bot. Standardwert: None

Gibt zurück

Typ	Beschreibung
	Eine Aufgabe, die die auszuführende Arbeitswarteschlange darstellt.

Ausnahmen

Typ	Beschreibung
It raises a generic exception error.

Hinweise

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 Unterhaltungsaktualisierungsaktivität über die Middleware-Pipeline an die Rückrufmethode. Wenn die Unterhaltung mit den angegebenen Benutzern eingerichtet wird, enthält die ID der Aktivität die ID der neuen Unterhaltung.

delete_activity

Löscht eine vorhandene Aktivität.

abstract async delete_activity(context: TurnContext, reference: ConversationReference)

Parameter

Name	Beschreibung
context Erforderlich	TurnContext Das Kontextobjekt für die Drehung.
reference Erforderlich	ConversationReference Unterhaltungsverweis für die zu löschende Aktivität.

run_pipeline

Wird von der übergeordneten Klasse aufgerufen, um den Adapter-Middleware-Satz auszuführen, und ruft den übergebenen callback() Handler am Ende der Kette auf.

async run_pipeline(context: TurnContext, callback: Callable[[TurnContext], Awaitable] = None)

Parameter

Name	Beschreibung
context Erforderlich	TurnContext Das Kontextobjekt für die Drehung.
callback	Callable[[<xref:TurnContext>],<xref: Awaitable>] Eine Rückrufmethode, die am Ende der Pipeline ausgeführt werden soll. Standardwert: None

send_activities

Sendet eine Reihe von Aktivitäten an den Benutzer. Ein Array von Antworten vom Server wird zurückgegeben.

abstract async send_activities(context: TurnContext, activities: List[Activity]) -> List[ResourceResponse]

Parameter

Name	Beschreibung
context Erforderlich	TurnContext Das Kontextobjekt für die Drehung.
activities Erforderlich	List[<xref:Activity>] Die zu sendenden Aktivitäten.

update_activity

Ersetzt eine vorhandene Aktivität.

abstract async update_activity(context: TurnContext, activity: Activity)

Parameter

Name	Beschreibung
context Erforderlich	TurnContext Das Kontextobjekt für die Drehung.
activity Erforderlich	Activity Neue Ersetzungsaktivität.

use

Registriert einen Middleware-Handler mit dem Adapter.

use(middleware)

Parameter

Name	Beschreibung
middleware Erforderlich	Die zu registrierende Middleware.

Attribute

BOT_CALLBACK_HANDLER_KEY

BOT_CALLBACK_HANDLER_KEY = 'BotCallbackHandler'

BOT_CONNECTOR_CLIENT_KEY

BOT_CONNECTOR_CLIENT_KEY = 'ConnectorClient'

BOT_IDENTITY_KEY

BOT_IDENTITY_KEY = 'BotIdentity'

BOT_OAUTH_SCOPE_KEY

BOT_OAUTH_SCOPE_KEY = 'botbuilder.core.BotAdapter.OAuthScope'

Feedback

War diese Seite hilfreich?