BotFrameworkAdapter Klasa

can_process_outgoing_activity(activity: Activity) -> bool

Parametry

Kontynuuje konwersację z użytkownikiem.

parametr MicrosoftAppId znajduje się w config.py. :type bot_id: <xref:typing.str> :p aram claims_identity: tożsamość oświadczenia bota: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)

Parametry

Zwraca

Wyjątki

Uwagi

Jest to często określane jako boty proaktywne komunikaty przepływ, ponieważ umożliwia botowi proaktywne wysyłanie wiadomości do konwersacji lub użytkownika, które są już w komunikacji. Scenariusze, takie jak wysyłanie powiadomień lub kuponów do użytkownika, są włączone przez tę funkcję.

Implementacja ConnectorClientProvider.create_connector_client.

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

Parametry

Zwraca

Rozpoczyna nową konwersację z użytkownikiem. Służy do kierowania wiadomości do członka grupy.

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)

Parametry

Zwraca

Wyjątki

Uwagi

Aby rozpocząć konwersację, bot musi znać informacje o swoim koncie i informacje o koncie użytkownika w tym kanale. Większość kanałów obsługuje tylko inicjowanie bezpośredniej konwersacji (niegrupowej). Karta próbuje utworzyć nową konwersację w kanale, a następnie wysyła działanie aktualizacji konwersacji za pośrednictwem potoku oprogramowania pośredniczącego do metody wywołania zwrotnego. Jeśli konwersacja zostanie nawiązana z określonymi użytkownikami, identyfikator działania będzie zawierać identyfikator nowej konwersacji.

Usuwa działanie, które zostało wcześniej wysłane do kanału. Należy zauważyć, że nie wszystkie kanały obsługują tę funkcję.

async delete_activity(context: TurnContext, reference: ConversationReference)

Parametry

Zwraca

Wyjątki

Usuwa członka z bieżącej konwersacji.

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

Parametry

Zwraca

Wyjątki

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

Parametry

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

Parametry

Pobiera tokeny usługi Azure Active Directory dla określonych zasobów w skonfigurowanym połączeniu.

z działania w obiekcie TurnContext. :type user_id: str :p aram oauth_app_credentials: (Opcjonalnie) AppCredentials for 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]

Parametry

Zwraca

Wyświetla listę członków danego działania.

Jeśli nie określono bieżącego identyfikatora działań, zostanie użyty.

async get_activity_members(context: TurnContext, activity_id: str)

Parametry

Zwraca

Wyjątki

Pobierz członka bieżącej konwersacji.

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

Parametry

Zwraca

Wyjątki

Wyświetla listę członków bieżącej konwersacji.

async get_conversation_members(context: TurnContext)

Parametry

Zwraca

Wyjątki

Wyświetla listę konwersacji, w których ten bot brał udział w danym serwerze kanału.

context.activity.serviceUrl :type service_url: str

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

Parametry

Zwraca

Wyjątki

Uwagi

Serwer kanału zwraca wyniki na stronach, a każda strona będzie zawierać kontynuacjiToken, których można użyć do pobrania następnej strony wyników z serwera. Jeśli zadanie zakończy się pomyślnie, wynik zawiera stronę członków bieżącej konwersacji. To przeciążenie może być wywoływane spoza kontekstu konwersacji, ponieważ wymagany jest tylko adres URL usługi bota i poświadczenia.

Pobiera nieprzetworzone łącze logowania, które ma zostać wysłane do użytkownika w celu zalogowania się w celu uzyskania nazwy połączenia.

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

Parametry

Zwraca

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

Parametry

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

Parametry

Pobiera stan tokenu dla każdego skonfigurowanego połączenia dla danego użytkownika.

Pole Puste zwróci stan tokenu dla wszystkich skonfigurowanych połączeń. :type include_filter: str :p aram oauth_app_credentials: (Opcjonalnie) AppCredentials for 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]

Parametry

Zwraca

Próbuje pobrać token dla użytkownika, który znajduje się w przepływie logowania.

:p aram magic_code" (opcjonalnie) użytkownik wprowadził kod w celu zweryfikowania ciągu :str magic_code" :p aram oauth_app_credentials: (opcjonalnie) AppCredentials for 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

Parametry

Zwraca

Wyjątki

static key_for_app_credentials(app_id: str, scope: str)

Parametry

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

Parametry

Analizuje i weryfikuje żądanie :p aram req: :return:

async static parse_request(req)

Parametry

Tworzy kontekst kolei i uruchamia potok oprogramowania pośredniczącego dla działania przychodzącego.

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

Parametry

Zwraca

Uwagi

Ta klasa przetwarza działanie odebrane przez serwer internetowy botów. Obejmuje to wszelkie komunikaty wysyłane przez użytkownika i jest metodą, która często określa to, co jest często określane jako boty reaktywne komunikaty przepływ. Wywołaj tę metodę, aby reaktywnie wysłać wiadomość do konwersacji. Jeśli zadanie zakończy się pomyślnie, zostanie zwrócona InvokeResponse; inaczej. jest zwracana o wartości null.

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

Parametry

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

Parametry

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

Parametry

Podpisuje użytkownika przy użyciu serwera tokenów.

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

Parametry

Zastępuje działanie, które zostało wcześniej wysłane do kanału. Należy zauważyć, że nie wszystkie kanały obsługują tę funkcję.

async update_activity(context: TurnContext, activity: Activity)

Parametry

Zwraca

Wyjątki

Uwagi

Jeśli działanie zostało pomyślnie wysłane, wynik zadania zawiera obiekt ResourceResponse zawierający identyfikator, który kanał odbierający został przypisany do działania. Przed wywołaniem tej funkcji ustaw identyfikator działania zastępczego na identyfikator działania, który ma zastąpić.