BotFrameworkAdapter Klass

can_process_outgoing_activity(activity: Activity) -> bool

Parametrar

Fortsätter en konversation med en användare.

och finns vanligtvis i parametern MicrosoftAppId i config.py. :type bot_id: <xref:typing.str> :p aram claims_identity: Roboten hävdar identitet :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)

Parametrar

Returer

Undantag

Kommentarer

Detta kallas ofta för robotar proaktiva meddelanden flöde eftersom roboten proaktivt kan skicka meddelanden till en konversation eller användare som redan är i en kommunikation. Scenarier som att skicka meddelanden eller kuponger till en användare aktiveras av den här funktionen.

Implementering av ConnectorClientProvider.create_connector_client.

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

Parametrar

Returer

Startar en ny konversation med en användare. Används för att dirigera meddelanden till en medlem i en grupp.

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)

Parametrar

Returer

Undantag

Kommentarer

För att starta en konversation måste roboten känna till kontoinformationen och användarens kontoinformation på kanalen. De flesta kanaler har endast stöd för att initiera en direktmeddelandekonversation (icke-grupp). Adaptern försöker skapa en ny konversation i kanalen och skickar sedan en konversationsuppdateringsaktivitet via sin mellanprogramspipeline till motringningsmetoden. Om konversationen upprättas med de angivna användarna innehåller aktivitetens ID ID för den nya konversationen.

Tar bort en aktivitet som tidigare skickades till en kanal. Det bör noteras att inte alla kanaler stöder den här funktionen.

async delete_activity(context: TurnContext, reference: ConversationReference)

Parametrar

Returer

Undantag

Tar bort en medlem från den aktuella konversationen.

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

Parametrar

Returer

Undantag

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

Parametrar

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

Parametrar

Hämtar Azure Active Directory-token för specifika resurser på en konfigurerad anslutning.

från aktiviteten i TurnContext. :type user_id: str :p aram oauth_app_credentials: (Valfritt) AppCredentials för 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]

Parametrar

Returer

Visar en lista över medlemmar i en viss aktivitet.

Om det inte anges används det aktuella aktivitets-ID:t.

async get_activity_members(context: TurnContext, activity_id: str)

Parametrar

Returer

Undantag

Hämta en medlem i en aktuell konversation.

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

Parametrar

Returer

Undantag

Visar en lista över medlemmar i en aktuell konversation.

async get_conversation_members(context: TurnContext)

Parametrar

Returer

Undantag

Visar en lista över konversationer där den här roboten har deltagit för en viss kanalserver.

context.activity.serviceUrl :type service_url: str

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

Parametrar

Returer

Undantag

Kommentarer

Kanalservern returnerar resultat på sidor och varje sida innehåller en fortsättningToken som kan användas för att hämta nästa sida med resultat från servern. Om uppgiften slutförs innehåller resultatet en sida med medlemmarna i den aktuella konversationen. Den här överlagringen kan anropas utanför kontexten för en konversation eftersom endast robotens tjänst-URL och autentiseringsuppgifter krävs.

Hämtar den råa inloggningslänken som ska skickas till användaren för inloggning för ett anslutningsnamn.

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

Parametrar

Returer

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

Parametrar

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

Parametrar

Hämtar tokenstatusen för varje konfigurerad anslutning för den angivna användaren.

Tom returnerar tokenstatus för alla konfigurerade anslutningar. :type include_filter: str :p aram oauth_app_credentials: (Valfritt) AppCredentials för 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]

Parametrar

Returer

Försöker hämta token för en användare som finns i ett inloggningsflöde.

:p aram magic_code" (Valfritt) har användaren angett kod för att verifiera :str magic_code" str :p aram oauth_app_credentials: (Valfritt) AppCredentials för 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

Parametrar

Returer

Undantag

static key_for_app_credentials(app_id: str, scope: str)

Parametrar

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

Parametrar

Parsar och validerar begäran :p aram req: :return:

async static parse_request(req)

Parametrar

Skapar en turkontext och kör pipelinen för mellanprogram för en inkommande aktivitet.

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

Parametrar

Returer

Kommentarer

Den här klassen bearbetar en aktivitet som tas emot av robotwebbservern. Detta omfattar alla meddelanden som skickas från en användare och är den metod som driver det som ofta kallas robotar reaktiva meddelanden flöde. Anropa den här metoden för att skicka ett meddelande till en konversation reaktivt. Om uppgiften har slutförts returneras en InvokeResponse. annars. null- returneras.

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

Parametrar

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

Parametrar

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

Parametrar

Loggar ut användaren med tokenservern.

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

Parametrar

Ersätter en aktivitet som tidigare skickades till en kanal. Det bör noteras att inte alla kanaler stöder den här funktionen.

async update_activity(context: TurnContext, activity: Activity)

Parametrar

Returer

Undantag

Kommentarer

Om aktiviteten har skickats innehåller aktivitetsresultatet ett ResourceResponse objekt som innehåller det ID som den mottagande kanalen tilldelade aktiviteten. Innan du anropar den här funktionen anger du ID för ersättningsaktiviteten till ID:t för aktiviteten som ska ersättas.