BotAdapter Classe

Héritage

ABC

BotAdapter

Constructeur

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

Paramètres

Nom	Description
on_turn_error	valeur par défaut: None

Méthodes

continue_conversation	Envoie un message proactif à une conversation. Appelez cette méthode pour envoyer de manière proactive 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. un seul locataire les adaptateurs (console, test, etc.), mais il est essentiel pour le BotFrameworkAdapter qui prend en charge les multilocataires. :p aram reference : référence à la conversation à poursuivre. :type reference : ConversationReference :p aram callback : méthode à appeler pour le tour de bot résultant. :type callback : Callable :p aram claims_identity : A <xref:botframework.connector.auth.ClaimsIdentity> pour la conversation. :type claims_identity : <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience :Valeur qui signifie le destinataire du message proactif. :type audience : str
create_conversation	Démarre une nouvelle conversation avec un utilisateur. Utilisé pour diriger un message vers un membre d’un groupe.
delete_activity	Supprime une activité existante.
run_pipeline	Appelé par la classe parente pour exécuter le jeu d’intergiciels d’adaptateurs et appelle le gestionnaire callback() passé à la fin de la chaîne.
send_activities	Envoie un ensemble d’activités à l’utilisateur. Un tableau de réponses du serveur sera retourné.
update_activity	Remplace une activité existante.
use	Inscrit un gestionnaire d’intergiciels avec l’adaptateur.

continue_conversation

Envoie un message proactif à une conversation. Appelez cette méthode pour envoyer de manière proactive 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.

un seul locataire les adaptateurs (console, test, etc.), mais il est essentiel pour le BotFrameworkAdapter qui prend en charge les multilocataires. :p aram reference : référence à la conversation à poursuivre. :type reference : ConversationReference :p aram callback : méthode à appeler pour le tour de bot résultant. :type callback : Callable :p aram claims_identity : A <xref:botframework.connector.auth.ClaimsIdentity> pour la conversation. :type claims_identity : <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience :Valeur qui signifie le destinataire du message proactif. :type audience : str

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

Paramètres

Nom	Description
bot_id	ID d’application du bot. Ce paramètre est ignoré dans valeur par défaut: None
reference Obligatoire
callback Obligatoire
claims_identity	valeur par défaut: None
audience	valeur par défaut: None

create_conversation

Démarre une nouvelle conversation avec un utilisateur. Utilisé pour diriger un message vers un membre d’un groupe.

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)

Paramètres

Nom	Description
reference Obligatoire	ConversationReference Référence de conversation qui contient le locataire
logic	Callable Logique à utiliser pour la création de la conversation valeur par défaut: None
conversation_parameters	Informations à utiliser pour créer la conversation valeur par défaut: None
channel_id	<xref:typing.str> ID du canal. valeur par défaut: None
service_url	<xref:typing.str> Point de terminaison d’URL de service du canal. valeur par défaut: None
credentials	<xref:botframework.connector.auth.AppCredentials> Informations d’identification de l’application pour le bot. valeur par défaut: None

Retours

Type	Description
	Tâche représentant le travail mis en file d’attente pour s’exécuter.

Exceptions

Type	Description
It raises a generic exception error.

Remarques

Pour démarrer une conversation, votre bot doit connaître les informations de son 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 par message direct (non-groupe). L’adaptateur tente de créer une nouvelle conversation sur le canal, puis envoie une activité de mise à jour de conversation via son pipeline middleware à la méthode de rappel. Si la conversation est établie avec les utilisateurs spécifiés, l’ID de l’activité contient l’ID de la nouvelle conversation.

delete_activity

Supprime une activité existante.

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

Paramètres

Nom	Description
context Obligatoire	<xref:botbuilder.core.bot_adapter.TurnContext> Objet de contexte pour le tour.
reference Obligatoire	ConversationReference Référence de conversation pour l’activité à supprimer.

run_pipeline

Appelé par la classe parente pour exécuter le jeu d’intergiciels d’adaptateurs et appelle le gestionnaire callback() passé à la fin de la chaîne.

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

Paramètres

Nom	Description
context Obligatoire	<xref:botbuilder.core.bot_adapter.TurnContext> Objet de contexte pour le tour.
callback	Callable[[<xref:TurnContext>],<xref: Awaitable>] Méthode de rappel à exécuter à la fin du pipeline. valeur par défaut: None

send_activities

Envoie un ensemble d’activités à l’utilisateur. Un tableau de réponses du serveur sera retourné.

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

Paramètres

Nom	Description
context Obligatoire	<xref:botbuilder.core.bot_adapter.TurnContext> Objet de contexte pour le tour.
activities Obligatoire	List[<xref:Activity>] Activités à envoyer.

update_activity

Remplace une activité existante.

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

Paramètres

Nom	Description
context Obligatoire	<xref:botbuilder.core.bot_adapter.TurnContext> Objet de contexte pour le tour.
activity Obligatoire	Activity Nouvelle activité de remplacement.

use

Inscrit un gestionnaire d’intergiciels avec l’adaptateur.

use(middleware)

Paramètres

Nom	Description
middleware Obligatoire	Intergiciel à inscrire.

Attributs

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'