BotFrameworkAdapter Classe

can_process_outgoing_activity(activity: Activity) -> bool

Paramètres

Poursuit une conversation avec un utilisateur.

et est généralement trouvé dans le paramètre MicrosoftAppId dans config.py. :type bot_id : <xref:typing.str> :p aram claims_identity : L’identité de revendications du bot :type claims_identity : audience <xref:botframework.connector.auth.ClaimsIdentity> :p aram : :type audience : :type audience : <xref:typing.str>

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

Paramètres

Retours

Exceptions

Remarques

Il s’agit souvent de bots flux de messagerie proactive, car il permet au bot d’envoyer de manière proactive des messages à une conversation ou à un utilisateur déjà dans une communication. Les scénarios tels que l’envoi de notifications ou de coupons à un utilisateur sont activés par cette fonction.

Implémentation de ConnectorClientProvider.create_connector_client.

async create_connector_client(service_url: str, identity: ClaimsIdentity = None, audience: str = None) -> ConnectorClient

Paramètres

Retours

Démarre une nouvelle conversation avec un utilisateur. Utilisé pour diriger le 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

Retours

Exceptions

Remarques

Pour démarrer une conversation, votre bot doit connaître ses informations de 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 de message direct (non-groupe). L’adaptateur tente de créer une 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.

Supprime une activité précédemment envoyée à un canal. Il convient de noter que tous les canaux ne prennent pas en charge cette fonctionnalité.

async delete_activity(context: TurnContext, reference: ConversationReference)

Paramètres

Retours

Exceptions

Supprime un membre de la conversation actuelle.

async delete_conversation_member(context: TurnContext, member_id: str) -> None

Paramètres

Retours

Exceptions

async exchange_token(turn_context: TurnContext, connection_name: str, user_id: str, exchange_request: TokenExchangeRequest) -> TokenResponse

Paramètres

async exchange_token_from_credentials(turn_context: TurnContext, oauth_app_credentials: AppCredentials, connection_name: str, user_id: str, exchange_request: TokenExchangeRequest) -> TokenResponse

Paramètres

Récupère des jetons Azure Active Directory pour des ressources particulières sur une connexion configurée.

à partir de l’activité dans TurnContext. :type user_id : str :p aram oauth_app_credentials : (Facultatif) AppCredentials pour OAuth. :type oauth_app_credentials : <xref:botframework.connector.auth.AppCredential>

async get_aad_tokens(context: TurnContext, connection_name: str, resource_urls: List[str], user_id: str = None, oauth_app_credentials: AppCredentials = None) -> Dict[str, TokenResponse]

Paramètres

Retours

Répertorie les membres d’une activité donnée.

S’il n’est pas spécifié, l’ID d’activité actuel est utilisé.

async get_activity_members(context: TurnContext, activity_id: str)

Paramètres

Retours

Exceptions

Récupérez un membre d’une conversation actuelle.

async get_conversation_member(context: TurnContext, member_id: str) -> ChannelAccount

Paramètres

Retours

Exceptions

Répertorie les membres d’une conversation actuelle.

async get_conversation_members(context: TurnContext)

Paramètres

Retours

Exceptions

Répertorie les conversations dans lesquelles ce bot a participé pour un serveur de canal donné.

context.activity.serviceUrl :type service_url : str

async get_conversations(service_url: str, credentials: AppCredentials, continuation_token: str = None)

Paramètres

Retours

Exceptions

Remarques

Le serveur de canal retourne les résultats dans les pages et chaque page inclut une continuationToken qui peut être utilisée pour extraire la page suivante des résultats à partir du serveur. Si la tâche se termine correctement, le résultat contient une page des membres de la conversation active. Cette surcharge peut être appelée en dehors du contexte d’une conversation, car seules l’URL et les informations d’identification du service du bot sont requises.

Obtient le lien de connexion brut à envoyer à l’utilisateur pour la connexion pour un nom de connexion.

async get_oauth_sign_in_link(context: TurnContext, connection_name: str, final_redirect: str = None, oauth_app_credentials: AppCredentials = None) -> str

Paramètres

Retours

async get_sign_in_resource_from_user(turn_context: TurnContext, connection_name: str, user_id: str, final_redirect: str = None) -> SignInUrlResponse

Paramètres

async get_sign_in_resource_from_user_and_credentials(turn_context: TurnContext, oauth_app_credentials: AppCredentials, connection_name: str, user_id: str, final_redirect: str = None) -> SignInUrlResponse

Paramètres

Récupère l’état du jeton pour chaque connexion configurée pour l’utilisateur donné.

Vide retourne l’état du jeton pour toutes les connexions configurées. :type include_filter : str :p aram oauth_app_credentials : (Facultatif) AppCredentials pour OAuth. :type oauth_app_credentials : <xref:botframework.connector.auth.AppCredential>

async get_token_status(context: TurnContext, connection_name: str = None, user_id: str = None, include_filter: str = None, oauth_app_credentials: AppCredentials = None) -> List[TokenStatus]

Paramètres

Retours

Tente de récupérer le jeton d’un utilisateur qui se trouve dans un flux de connexion.

utilisateur :p aram magic_code » (facultatif) entré du code pour valider :str magic_code » str :p aram oauth_app_credentials : (Facultatif) AppCredentials pour OAuth. :type oauth_app_credentials : <xref:botframework.connector.auth.AppCredential>

async get_user_token(context: TurnContext, connection_name: str, magic_code: str = None, oauth_app_credentials: AppCredentials = None) -> TokenResponse

Paramètres

Retours

Exceptions

static key_for_app_credentials(app_id: str, scope: str)

Paramètres

static key_for_connector_client(service_url: str, app_id: str, scope: str)

Paramètres

Analyse et valide la requête :p aram req : :return :

async static parse_request(req)

Paramètres

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

async process_activity(req, auth_header: str, logic: Callable)

Paramètres

Retours

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é.

async process_activity_with_identity(activity: Activity, identity: ClaimsIdentity, logic: Callable)

Paramètres

async process_outgoing_activity(turn_context: TurnContext, activity: Activity) -> ResourceResponse

Paramètres

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

Paramètres

Déconnecte l’utilisateur avec le serveur de jetons.

async sign_out_user(context: TurnContext, connection_name: str = None, user_id: str = None, oauth_app_credentials: AppCredentials = None)

Paramètres

Remplace une activité précédemment envoyée à un canal. Il convient de noter que tous les canaux ne prennent pas en charge cette fonctionnalité.

async update_activity(context: TurnContext, activity: Activity)

Paramètres

Retours

Exceptions

Remarques

Si l’activité est correctement envoyée, le résultat de la tâche contient un objet ResourceResponse contenant l’ID que le canal de réception affecté à l’activité. Avant d’appeler cette fonction, définissez l’ID de l’activité de remplacement sur l’ID de l’activité à remplacer.