BotAdapter Classe

Riferimento

Costruttore

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

Parametri

Nome	Descrizione
on_turn_error	Valore predefinito: None

Metodi

continue_conversation	Invia un messaggio proattivo a una conversazione. Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente. tenant singolo gli adapter (console, test e così via), ma è fondamentale per BotFrameworkAdapter, che è compatibile con più tenant. riferimento :p aram: riferimento alla conversazione da continuare. :type reference: callback ConversationReference :p aram: metodo da chiamare per il turno del bot risultante. :type callback: Callable :p aram claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> per la conversazione. :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A value che indica il destinatario del messaggio proattivo. :type audience: str
create_conversation	Avvia una nuova conversazione con un utente. Utilizzato per indirizzare il messaggio a un membro di un gruppo.
delete_activity	Elimina un'attività esistente.
run_pipeline	Chiamato dalla classe padre per eseguire il set di middleware adapters e chiama il metodo passato in callback() gestore alla fine della catena.
send_activities	Invia un set di attività all'utente. Verrà restituita una matrice di risposte dal server.
update_activity	Sostituisce un'attività esistente.
use	Registra un gestore middleware con l'adapter.

continue_conversation

Invia un messaggio proattivo a una conversazione. Chiamare questo metodo per inviare in modo proattivo un messaggio a una conversazione. La maggior parte dei canali richiede a un utente di avviare una conversazione con un bot prima che il bot possa inviare attività all'utente.

tenant singolo gli adapter (console, test e così via), ma è fondamentale per BotFrameworkAdapter, che è compatibile con più tenant. riferimento :p aram: riferimento alla conversazione da continuare. :type reference: callback ConversationReference :p aram: metodo da chiamare per il turno del bot risultante. :type callback: Callable :p aram claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> per la conversazione. :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience:A value che indica il destinatario del messaggio proattivo. :type audience: str

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

Parametri

Nome	Descrizione
bot_id	ID applicazione del bot. Questo parametro viene ignorato in Valore predefinito: None
reference Necessario
callback Necessario
claims_identity	Valore predefinito: None
audience	Valore predefinito: None

create_conversation

Avvia una nuova conversazione con un utente. Utilizzato per indirizzare il messaggio a un membro di un gruppo.

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)

Parametri

Nome	Descrizione
reference Necessario	ConversationReference Riferimento di conversazione che contiene il tenant
logic	Callable Logica da usare per la creazione della conversazione Valore predefinito: None
conversation_parameters	Informazioni da usare per creare la conversazione Valore predefinito: None
channel_id	<xref:typing.str> ID del canale. Valore predefinito: None
service_url	<xref:typing.str> Endpoint dell'URL del servizio del canale. Valore predefinito: None
credentials	<xref:botframework.connector.auth.AppCredentials> Credenziali dell'applicazione per il bot. Valore predefinito: None

Restituisce

Tipo	Descrizione
	Attività che rappresenta il lavoro in coda da eseguire.

Eccezioni

Tipo	Descrizione
It raises a generic exception error.

Commenti

Per avviare una conversazione, il bot deve conoscere le informazioni sull'account e le informazioni sull'account dell'utente su tale canale. La maggior parte dei canali supporta solo l'avvio di una conversazione diretta (non di gruppo). L'adapter tenta di creare una nuova conversazione sul canale e quindi invia un'attività di aggiornamento della conversazione tramite la pipeline middleware al metodo di callback. Se la conversazione viene stabilita con gli utenti specificati, l'ID dell'attività conterrà l'ID della nuova conversazione.

delete_activity

Elimina un'attività esistente.

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

Parametri

Nome	Descrizione
context Necessario	TurnContext Oggetto di contesto per il turno.
reference Necessario	ConversationReference Informazioni di riferimento sulla conversazione per l'attività da eliminare.

run_pipeline

Chiamato dalla classe padre per eseguire il set di middleware adapters e chiama il metodo passato in callback() gestore alla fine della catena.

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

Parametri

Nome	Descrizione
context Necessario	TurnContext Oggetto di contesto per il turno.
callback	Callable[[<xref:TurnContext>],<xref: Awaitable>] Metodo di callback da eseguire alla fine della pipeline. Valore predefinito: None

send_activities

Invia un set di attività all'utente. Verrà restituita una matrice di risposte dal server.

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

Parametri

Nome	Descrizione
context Necessario	TurnContext Oggetto di contesto per il turno.
activities Necessario	List[<xref:Activity>] Attività da inviare.

update_activity

Sostituisce un'attività esistente.

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

Parametri

Nome	Descrizione
context Necessario	TurnContext Oggetto di contesto per il turno.
activity Necessario	Activity Nuova attività sostitutiva.

use

Registra un gestore middleware con l'adapter.

use(middleware)

Parametri

Nome	Descrizione
middleware Necessario	Middleware da registrare.

Attributi

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'

Commenti e suggerimenti

Questa pagina è stata utile?