BotAdapter Klasa

Odwołanie

Konstruktor

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

Parametry

Nazwa	Opis
on_turn_error	Domyślna wartość: None

Metody

continue_conversation	Wysyła proaktywną wiadomość do konwersacji. Wywołaj tę metodę, aby proaktywnie wysłać wiadomość do konwersacji. Większość kanałów wymaga od użytkownika zainicjowania konwersacji z botem, zanim bot będzie mógł wysyłać działania do użytkownika. pojedyncza dzierżawa adapterów (konsola, test itp.), ale ma kluczowe znaczenie dla botFrameworkAdapter, który jest obsługujący wiele dzierżaw. :p aram reference: Odwołanie do konwersacji, aby kontynuować. :type reference: ConversationReference :p aram callback: metoda wywołania wynikowego bota turn. :type callback: Callable :p aram claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> konwersacji. :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A value signifying the odbiorca proaktywnej wiadomości. :type audience: str
create_conversation	Rozpoczyna nową konwersację z użytkownikiem. Służy do kierowania wiadomości do członka grupy.
delete_activity	Usuwa istniejące działanie.
run_pipeline	Wywoływana przez klasę nadrzędną w celu uruchomienia zestawu oprogramowania pośredniczącego adapterów i wywołuje przekazane w callback() obsługi na końcu łańcucha.
send_activities	Wysyła zestaw działań do użytkownika. Zostanie zwrócona tablica odpowiedzi z serwera.
update_activity	Zastępuje istniejące działanie.
use	Rejestruje program obsługi oprogramowania pośredniczącego za pomocą karty.

continue_conversation

Wysyła proaktywną wiadomość do konwersacji. Wywołaj tę metodę, aby proaktywnie wysłać wiadomość do konwersacji. Większość kanałów wymaga od użytkownika zainicjowania konwersacji z botem, zanim bot będzie mógł wysyłać działania do użytkownika.

pojedyncza dzierżawa adapterów (konsola, test itp.), ale ma kluczowe znaczenie dla botFrameworkAdapter, który jest obsługujący wiele dzierżaw. :p aram reference: Odwołanie do konwersacji, aby kontynuować. :type reference: ConversationReference :p aram callback: metoda wywołania wynikowego bota turn. :type callback: Callable :p aram claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> konwersacji. :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A value signifying the odbiorca proaktywnej wiadomości. :type audience: str

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

Parametry

Nazwa	Opis
bot_id	Identyfikator aplikacji bota. Ten parametr jest ignorowany w pliku Domyślna wartość: None
reference Wymagane
callback Wymagane
claims_identity	Domyślna wartość: None
audience	Domyślna wartość: None

create_conversation

Rozpoczyna nową konwersację z użytkownikiem. Służy do kierowania wiadomości do członka grupy.

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)

Parametry

Nazwa	Opis
reference Wymagane	ConversationReference Odwołanie do konwersacji zawierające dzierżawę
logic	Callable Logika używana do tworzenia konwersacji Domyślna wartość: None
conversation_parameters	Informacje używane do tworzenia konwersacji Domyślna wartość: None
channel_id	<xref:typing.str> Identyfikator kanału. Domyślna wartość: None
service_url	<xref:typing.str> Punkt końcowy adresu URL usługi kanału. Domyślna wartość: None
credentials	<xref:botframework.connector.auth.AppCredentials> Poświadczenia aplikacji bota. Domyślna wartość: None

Zwraca

Typ	Opis
	Zadanie reprezentujące pracę w kolejce do wykonania.

Wyjątki

Typ	Opis
It raises a generic exception error.

Uwagi

Aby rozpocząć konwersację, bot musi znać informacje o swoim koncie i informacje o koncie użytkownika w tym kanale. Większość kanałów obsługuje tylko inicjowanie bezpośredniej konwersacji (niegrupowej). Karta próbuje utworzyć nową konwersację w kanale, a następnie wysyła działanie aktualizacji konwersacji za pośrednictwem potoku oprogramowania pośredniczącego do metody wywołania zwrotnego. Jeśli konwersacja zostanie nawiązana z określonymi użytkownikami, identyfikator działania będzie zawierać identyfikator nowej konwersacji.

delete_activity

Usuwa istniejące działanie.

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

Parametry

Nazwa	Opis
context Wymagane	TurnContext Obiekt kontekstu dla kolei.
reference Wymagane	ConversationReference Odwołanie do konwersacji dla działania do usunięcia.

run_pipeline

Wywoływana przez klasę nadrzędną w celu uruchomienia zestawu oprogramowania pośredniczącego adapterów i wywołuje przekazane w callback() obsługi na końcu łańcucha.

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

Parametry

Nazwa	Opis
context Wymagane	TurnContext Obiekt kontekstu dla kolei.
callback	Callable[[<xref:TurnContext>],<xref: Awaitable>] Metoda wywołania zwrotnego uruchamiana na końcu potoku. Domyślna wartość: None

send_activities

Wysyła zestaw działań do użytkownika. Zostanie zwrócona tablica odpowiedzi z serwera.

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

Parametry

Nazwa	Opis
context Wymagane	TurnContext Obiekt kontekstu dla kolei.
activities Wymagane	List[<xref:Activity>] Działania do wysłania.

update_activity

Zastępuje istniejące działanie.

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

Parametry

Nazwa	Opis
context Wymagane	TurnContext Obiekt kontekstu dla kolei.
activity Wymagane	Activity Nowe działanie zastępcze.

use

Rejestruje program obsługi oprogramowania pośredniczącego za pomocą karty.

use(middleware)

Parametry

Nazwa	Opis
middleware Wymagane	Oprogramowanie pośredniczące do zarejestrowania.

Atrybuty

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'

Opinia

Czy ta strona była pomocna?