CloudAdapterBase Classe

Constructeur

CloudAdapterBase(bot_framework_authentication: BotFrameworkAuthentication)

Paramètres

Nom Description
bot_framework_authentication
Obligatoire

Méthodes

continue_conversation

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

et est généralement trouvé dans le paramètre MicrosoftAppId dans config.py. :type bot_app_id : <xref:typing.str>

continue_conversation_with_claims
create_claims_identity
create_conversation
delete_activity
process_activity

Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante.

process_proactive
send_activities
update_activity

continue_conversation

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

et est généralement trouvé dans le paramètre MicrosoftAppId dans config.py. :type bot_app_id : <xref:typing.str>

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

Paramètres

Nom Description
reference
Obligatoire

Référence à la conversation pour continuer.

callback
Obligatoire

Méthode à appeler pour le tour de bot résultant.

bot_app_id

ID d’application du bot. Il s’agit de l’appId retourné par l’inscription du portail Azure,

Valeur par défaut: None
claims_identity
Valeur par défaut: None
audience
Valeur par défaut: None

continue_conversation_with_claims

async continue_conversation_with_claims(claims_identity: ClaimsIdentity, reference: ConversationReference, audience: str, logic: Callable[[TurnContext], Awaitable])

Paramètres

Nom Description
claims_identity
Obligatoire
reference
Obligatoire
audience
Obligatoire
logic
Obligatoire

create_claims_identity

create_claims_identity(bot_app_id: str = '') -> ClaimsIdentity

Paramètres

Nom Description
bot_app_id

create_conversation

async create_conversation(bot_app_id: str, callback: Callable[[TurnContext], Awaitable] = None, conversation_parameters: ConversationParameters = None, channel_id: str = None, service_url: str = None, audience: str = None)

Paramètres

Nom Description
bot_app_id
Obligatoire
callback
Valeur par défaut: None
conversation_parameters
Valeur par défaut: None
channel_id
Valeur par défaut: None
service_url
Valeur par défaut: None
audience
Valeur par défaut: None

delete_activity

async delete_activity(context: TurnContext, reference: ConversationReference)

Paramètres

Nom Description
context
Obligatoire
reference
Obligatoire

process_activity

Crée un contexte de tour et exécute le pipeline d’intergiciel pour une activité entrante.

async process_activity(auth_header_or_authenticate_request_result: str | AuthenticateRequestResult, activity: Activity, logic: Callable[[TurnContext], Awaitable])

Paramètres

Nom Description
auth_header
Obligatoire
Union[<xref:typing.str>,<xref: AuthenticateRequestResult>]

En-tête d’authentification HTTP de la requête

activity
Obligatoire
<xref:botbuilder.core.Activity>

Activité entrante

logic
Obligatoire

Logique à exécuter à la fin du pipeline d’intergiciel de l’adaptateur.

auth_header_or_authenticate_request_result
Obligatoire

Retours

Type Description

Tâche qui représente le travail mis en file d’attente à exécuter.

Remarques

Cette classe traite une activité reçue par le serveur web bots. Cela inclut tous les messages envoyés par un utilisateur et est la méthode qui pilote ce qui est souvent appelé bots flux de messagerie réactive. Appelez cette méthode pour envoyer un message de manière réactive à une conversation. Si la tâche se termine correctement, une InvokeResponse est retournée ; autrement. null est retourné.

process_proactive

async process_proactive(claims_identity: ClaimsIdentity, continuation_activity: Activity, audience: str, logic: Callable[[TurnContext], Awaitable])

Paramètres

Nom Description
claims_identity
Obligatoire
continuation_activity
Obligatoire
audience
Obligatoire
logic
Obligatoire

send_activities

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

Paramètres

Nom Description
context
Obligatoire
activities
Obligatoire

update_activity

async update_activity(context: TurnContext, activity: Activity)

Paramètres

Nom Description
context
Obligatoire
activity
Obligatoire

Attributs

CONNECTOR_FACTORY_KEY

CONNECTOR_FACTORY_KEY = 'ConnectorFactory'

USER_TOKEN_CLIENT_KEY

USER_TOKEN_CLIENT_KEY = 'UserTokenClient'