BotFrameworkAdapter Classe

can_process_outgoing_activity(activity: Activity) -> bool

Parametri

Continua una conversazione con un utente.

e si trova in genere nel parametro MicrosoftAppId in config.py. :type bot_id: <xref:typing.str> :p aram claims_identity: l'identità delle attestazioni bot :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience: :type audience: <xref:typing.str>

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

Parametri

Restituisce

Eccezioni

Commenti

Questo viene spesso definito bot flusso di messaggistica proattiva perché consente al bot di inviare in modo proattivo messaggi a una conversazione o a un utente già in una comunicazione. Gli scenari, ad esempio l'invio di notifiche o coupon a un utente, sono abilitati da questa funzione.

Implementazione di ConnectorClientProvider.create_connector_client.

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

Parametri

Restituisce

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

Restituisce

Eccezioni

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.

Elimina un'attività precedentemente inviata a un canale. Si noti che non tutti i canali supportano questa funzionalità.

async delete_activity(context: TurnContext, reference: ConversationReference)

Parametri

Restituisce

Eccezioni

Elimina un membro dalla conversazione corrente.

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

Parametri

Restituisce

Eccezioni

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

Parametri

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

Parametri

Recupera i token di Azure Active Directory per determinate risorse in una connessione configurata.

dall'attività in TurnContext. :type user_id: str :p aram oauth_app_credentials: (facoltativo) AppCredentials per 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]

Parametri

Restituisce

Elenca i membri di una determinata attività.

Se non viene specificato l'ID attività corrente, verrà usato.

async get_activity_members(context: TurnContext, activity_id: str)

Parametri

Restituisce

Eccezioni

Recuperare un membro di una conversazione corrente.

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

Parametri

Restituisce

Eccezioni

Elenca i membri di una conversazione corrente.

async get_conversation_members(context: TurnContext)

Parametri

Restituisce

Eccezioni

Elenca le conversazioni in cui questo bot ha partecipato per un determinato server di canale.

context.activity.serviceUrl :type service_url: str

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

Parametri

Restituisce

Eccezioni

Commenti

Il server di canale restituisce i risultati nelle pagine e ogni pagina includerà una continuationToken che può essere usata per recuperare la pagina successiva dei risultati dal server. Se l'attività viene completata correttamente, il risultato contiene una pagina dei membri della conversazione corrente. Questo overload può essere chiamato dall'esterno del contesto di una conversazione, perché sono necessarie solo l'URL e le credenziali del servizio del bot.

Ottiene il collegamento di accesso non elaborato da inviare all'utente per l'accesso per un nome di connessione.

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

Parametri

Restituisce

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

Parametri

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

Parametri

Recupera lo stato del token per ogni connessione configurata per l'utente specificato.

Blank restituirà lo stato del token per tutte le connessioni configurate. :type include_filter: str :p aram oauth_app_credentials: (facoltativo) AppCredentials per 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]

Parametri

Restituisce

Tenta di recuperare il token per un utente che si trova in un flusso di accesso.

:p aram magic_code" (facoltativo) utente immesso codice per convalidare :str magic_code" str :p aram oauth_app_credentials: (facoltativo) AppCredentials per 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

Parametri

Restituisce

Eccezioni

static key_for_app_credentials(app_id: str, scope: str)

Parametri

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

Parametri

Analizza e convalida la richiesta :p aram req: :return:

async static parse_request(req)

Parametri

Crea un contesto di turno ed esegue la pipeline middleware per un'attività in ingresso.

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

Parametri

Restituisce

Commenti

Questa classe elabora un'attività ricevuta dal server Web bot. Sono inclusi tutti i messaggi inviati da un utente ed è il metodo che determina ciò che viene spesso definito bot flusso di messaggistica reattiva. Chiamare questo metodo per inviare in modo reattivo un messaggio a una conversazione. Se l'attività viene completata correttamente, viene restituito un InvokeResponse; altrimenti. viene restituito Null.

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

Parametri

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

Parametri

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

Parametri

Disconnette l'utente con il server token.

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

Parametri

Sostituisce un'attività precedentemente inviata a un canale. Si noti che non tutti i canali supportano questa funzionalità.

async update_activity(context: TurnContext, activity: Activity)

Parametri

Restituisce

Eccezioni

Commenti

Se l'attività viene inviata correttamente, il risultato dell'attività contiene un oggetto ResourceResponse contenente l'ID assegnato al canale ricevente all'attività. Prima di chiamare questa funzione, impostare l'ID dell'attività di sostituzione sull'ID dell'attività da sostituire.