BotFrameworkAdapter Kelas

can_process_outgoing_activity(activity: Activity) -> bool

Parameter

Melanjutkan percakapan dengan pengguna.

dan umumnya ditemukan dalam parameter MicrosoftAppId di config.py. :type bot_id: <xref:typing.str> :p aram claims_identity: Identitas klaim bot :ketik claims_identity: audiens <xref:botframework.connector.auth.ClaimsIdentity> :p aram: :ketik audiens: <xref:typing.str>

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

Parameter

Mengembalikan

Pengecualian

Keterangan

Ini sering disebut sebagai bot olahpesan proaktif alur karena memungkinkan bot secara proaktif mengirim pesan ke percakapan atau pengguna yang sudah berada dalam komunikasi. Skenario seperti mengirim pemberitahuan atau kupon ke pengguna diaktifkan oleh fungsi ini.

Implementasi ConnectorClientProvider.create_connector_client.

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

Parameter

Mengembalikan

Memulai percakapan baru dengan pengguna. Digunakan untuk mengarahkan pesan ke anggota grup.

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)

Parameter

Mengembalikan

Pengecualian

Keterangan

Untuk memulai percakapan, bot Anda harus mengetahui informasi akunnya dan informasi akun pengguna di saluran tersebut. Sebagian besar saluran hanya mendukung memulai percakapan pesan langsung (non-grup). Adaptor mencoba membuat percakapan baru di saluran, lalu mengirim aktivitas pembaruan percakapan melalui alur middleware-nya ke metode panggilan balik. Jika percakapan dibuat dengan pengguna yang ditentukan, ID aktivitas akan berisi ID percakapan baru.

Menghapus aktivitas yang sebelumnya dikirim ke saluran. Perlu dicatat bahwa tidak semua saluran mendukung fitur ini.

async delete_activity(context: TurnContext, reference: ConversationReference)

Parameter

Mengembalikan

Pengecualian

Menghapus anggota dari percakapan saat ini.

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

Parameter

Mengembalikan

Pengecualian

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

Parameter

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

Parameter

Mengambil token Azure Active Directory untuk sumber daya tertentu pada koneksi yang dikonfigurasi.

dari Aktivitas di TurnContext. :type user_id: str :p aram oauth_app_credentials: (Opsional) AppCredentials untuk 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]

Parameter

Mengembalikan

Mencantumkan anggota aktivitas tertentu.

Jika tidak ditentukan, ID aktivitas saat ini akan digunakan.

async get_activity_members(context: TurnContext, activity_id: str)

Parameter

Mengembalikan

Pengecualian

Mengambil anggota percakapan saat ini.

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

Parameter

Mengembalikan

Pengecualian

Mencantumkan anggota percakapan saat ini.

async get_conversation_members(context: TurnContext)

Parameter

Mengembalikan

Pengecualian

Mencantumkan Percakapan di mana bot ini telah berpartisipasi untuk server saluran tertentu.

context.activity.serviceUrl :type service_url: str

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

Parameter

Mengembalikan

Pengecualian

Keterangan

Server saluran mengembalikan hasil di halaman dan setiap halaman akan menyertakan continuationToken yang dapat digunakan untuk mengambil halaman hasil berikutnya dari server. Jika tugas berhasil diselesaikan, hasilnya berisi halaman anggota percakapan saat ini. Kelebihan beban ini dapat dipanggil dari luar konteks percakapan, karena hanya URL layanan dan kredensial bot yang diperlukan.

Mendapatkan tautan masuk mentah untuk dikirim ke pengguna untuk masuk untuk nama koneksi.

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

Parameter

Mengembalikan

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

Parameter

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

Parameter

Mengambil status token untuk setiap koneksi yang dikonfigurasi untuk pengguna tertentu.

Kosong akan mengembalikan status token untuk semua koneksi yang dikonfigurasi. :type include_filter: str :p aram oauth_app_credentials: (Opsional) AppCredentials untuk 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]

Parameter

Mengembalikan

Mencoba mengambil token untuk pengguna yang berada dalam alur masuk.

pengguna :p aram magic_code" (Opsional) memasukkan kode untuk memvalidasi :str magic_code" str :p aram oauth_app_credentials: (Opsional) AppCredentials untuk 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

Parameter

Mengembalikan

Pengecualian

static key_for_app_credentials(app_id: str, scope: str)

Parameter

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

Parameter

Mengurai dan memvalidasi permintaan :p aram req: :return:

async static parse_request(req)

Parameter

Membuat konteks giliran dan menjalankan alur middleware untuk aktivitas masuk.

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

Parameter

Mengembalikan

Keterangan

Kelas ini memproses aktivitas yang diterima oleh server web bot. Ini termasuk pesan apa pun yang dikirim dari pengguna dan merupakan metode yang mendorong apa yang sering disebut sebagai bot olahpesan reaktif alur. Panggil metode ini untuk mengirim pesan ke percakapan secara reaktif. Jika tugas berhasil diselesaikan, maka InvokeResponse dikembalikan; Sebaliknya. null dikembalikan.

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

Parameter

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

Parameter

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

Parameter

Mengeluarkan pengguna dengan server token.

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

Parameter

Mengganti aktivitas yang sebelumnya dikirim ke saluran. Perlu dicatat bahwa tidak semua saluran mendukung fitur ini.

async update_activity(context: TurnContext, activity: Activity)

Parameter

Mengembalikan

Pengecualian

Keterangan

Jika aktivitas berhasil dikirim, hasil tugas berisi objek ResourceResponse yang berisi ID yang ditetapkan saluran penerima ke aktivitas. Sebelum memanggil fungsi ini, atur ID aktivitas pengganti ke ID aktivitas untuk diganti.