BotFrameworkAdapter الفصل

تعريف محول لتوصيل روبوت بنقطة نهاية خدمة.

تهيئة مثيل جديد لفئة BotFrameworkAdapter.

الدالمنشئ

BotFrameworkAdapter(settings: BotFrameworkAdapterSettings)

المعلمات

الاسم الوصف
settings
مطلوب

إعدادات تهيئة المحول

الملاحظات

يغلف محول الروبوت عمليات المصادقة ويرسل الأنشطة إلى خدمة Bot Connector ويتلقى الأنشطة منها. عندما يتلقى الروبوت نشاطا، ينشئ المحول كائن سياق، ويمرره إلى منطق تطبيق الروبوت الخاص بك، ويرسل الاستجابات مرة أخرى إلى قناة المستخدم. يعالج المحول الأنشطة الواردة ويوجهها من خلال مسار البرنامج الوسيط للروبوت إلى منطق الروبوت الخاص بك ثم يعود مرة أخرى. نظرا لأن كل نشاط يتدفق داخل الروبوت وخارجه، يمكن لكل جزء من البرامج الوسيطة فحص النشاط أو التصرف بناء عليه، قبل تشغيل منطق الروبوت وبعده.

الأساليب

can_process_outgoing_activity
continue_conversation

متابعة محادثة مع مستخدم.

ويتم العثور على و بشكل عام في المعلمة MicrosoftAppId في config.py. :اكتب bot_id: <xref:typing.str> :p aram claims_identity: يطالب الروبوت بهوية :اكتب claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p جمهور: :اكتب الجمهور: <xref:typing.str>

create_connector_client

تنفيذ ConnectorClientProvider.create_connector_client.

create_conversation

بدء محادثة جديدة مع مستخدم. يستخدم لتوجيه رسالة إلى عضو في مجموعة.

delete_activity

حذف نشاط تم إرساله مسبقا إلى قناة. تجدر الإشارة إلى أن جميع القنوات لا تدعم هذه الميزة.

ملاحظه

يحدد activity_id ConversationReference النشاط المراد حذفه.

delete_conversation_member

حذف عضو من المحادثة الحالية.

exchange_token
exchange_token_from_credentials
get_aad_tokens

استرداد رموز Azure Active Directory المميزة لموارد معينة على اتصال تم تكوينه.

من النشاط في TurnContext. :اكتب user_id: str :p aram oauth_app_credentials: (اختياري) AppCredentials ل OAuth. :اكتب oauth_app_credentials: <xref:botframework.connector.auth.AppCredential>

get_activity_members

يسرد أعضاء نشاط معين.

إذا لم يتم تحديد سيتم استخدام معرف الأنشطة الحالي.

get_conversation_member

استرداد عضو في محادثة حالية.

get_conversation_members

سرد أعضاء محادثة حالية.

get_conversations

يسرد المحادثات التي شارك فيها هذا الروبوت لخادم قناة معين.

context.activity.serviceUrl :اكتب service_url: str

get_oauth_sign_in_link

يحصل على ارتباط تسجيل الدخول الخام لإرساله إلى المستخدم لتسجيل الدخول لاسم اتصال.

get_sign_in_resource_from_user
get_sign_in_resource_from_user_and_credentials
get_token_status

استرداد حالة الرمز المميز لكل اتصال تم تكوينه للمستخدم المحدد.

سيرجع Blank حالة الرمز المميز لكافة الاتصالات المكونة. :اكتب include_filter: str :p aram oauth_app_credentials: (اختياري) AppCredentials ل OAuth. :اكتب oauth_app_credentials: <xref:botframework.connector.auth.AppCredential>

get_user_token

يحاول استرداد الرمز المميز لمستخدم في تدفق تسجيل الدخول.

:p aram magic_code" (اختياري) أدخل المستخدم التعليمات البرمجية للتحقق من صحة :str magic_code" str :p aram oauth_app_credentials: (اختياري) AppCredentials ل OAuth. :اكتب oauth_app_credentials: <xref:botframework.connector.auth.AppCredential>

key_for_app_credentials
key_for_connector_client
parse_request

تحليل الطلب والتحقق من صحته :p aram req: :return:

process_activity

إنشاء سياق منعطف وتشغيل البنية الأساسية لبرنامج ربط العمليات التجارية لبرنامج وسيط لنشاط وارد.

process_activity_with_identity
process_outgoing_activity
send_activities
sign_out_user

تسجيل خروج المستخدم باستخدام خادم الرمز المميز.

update_activity

استبدال نشاط تم إرساله مسبقا إلى قناة. تجدر الإشارة إلى أن جميع القنوات لا تدعم هذه الميزة.

can_process_outgoing_activity

can_process_outgoing_activity(activity: Activity) -> bool

المعلمات

الاسم الوصف
activity
مطلوب

continue_conversation

متابعة محادثة مع مستخدم.

ويتم العثور على و بشكل عام في المعلمة MicrosoftAppId في config.py. :اكتب bot_id: <xref:typing.str> :p aram claims_identity: يطالب الروبوت بهوية :اكتب claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p جمهور: :اكتب الجمهور: <xref:typing.str>

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

المعلمات

الاسم الوصف
reference
مطلوب
callback
مطلوب
bot_id
القيمة الافتراضية: None
claims_identity
القيمة الافتراضية: None
audience
القيمة الافتراضية: None

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار لتنفيذه.

استثناءات

النوع الوصف
It raises an argument null exception.

الملاحظات

غالبا ما يشار إلى هذا على أنه الروبوتات تدفق المراسلة الاستباقية لأنها تتيح للروبوت إرسال الرسائل بشكل استباقي إلى محادثة أو مستخدم موجود بالفعل في اتصال. يتم تمكين سيناريوهات مثل إرسال إعلامات أو قسائم إلى مستخدم بواسطة هذه الدالة.

create_connector_client

تنفيذ ConnectorClientProvider.create_connector_client.

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

المعلمات

الاسم الوصف
service_url
مطلوب

عنوان URL للخدمة

identity

هوية المطالبات

القيمة الافتراضية: None
audience
القيمة الافتراضية: None

المرتجعات

النوع الوصف

مثيل لفئة <xref:botbuilder.core.ConnectorClient>

create_conversation

بدء محادثة جديدة مع مستخدم. يستخدم لتوجيه رسالة إلى عضو في مجموعة.

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)

المعلمات

الاسم الوصف
reference
مطلوب

مرجع المحادثة الذي يحتوي على المستأجر

logic

المنطق الذي يجب استخدامه لإنشاء المحادثة

القيمة الافتراضية: None
conversation_parameters

المعلومات التي يجب استخدامها لإنشاء المحادثة

القيمة الافتراضية: None
channel_id
<xref:typing.str>

معرف القناة.

القيمة الافتراضية: None
service_url
<xref:typing.str>

نقطة نهاية عنوان URL لخدمة القناة.

القيمة الافتراضية: None
credentials
<xref:botframework.connector.auth.AppCredentials>

بيانات اعتماد التطبيق للروبوت.

القيمة الافتراضية: None

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ.

استثناءات

النوع الوصف
It raises a generic exception error.

الملاحظات

لبدء محادثة، يجب أن يعرف الروبوت معلومات حسابه ومعلومات حساب المستخدم على تلك القناة. تدعم معظم القنوات بدء محادثة مباشرة (بدون مجموعة) فقط. يحاول المحول إنشاء محادثة جديدة على القناة، ثم يرسل نشاط تحديث محادثة من خلال مسار البرنامج الوسيط الخاص به إلى أسلوب رد الاتصال. إذا تم تأسيس المحادثة مع المستخدمين المحددين، فسيحتوي معرف النشاط على معرف المحادثة الجديدة.

delete_activity

حذف نشاط تم إرساله مسبقا إلى قناة. تجدر الإشارة إلى أن جميع القنوات لا تدعم هذه الميزة.

ملاحظه

يحدد activity_id ConversationReference النشاط المراد حذفه.

async delete_activity(context: TurnContext, reference: ConversationReference)

المعلمات

الاسم الوصف
context
مطلوب

كائن السياق الخاص بدور

reference
مطلوب

مرجع المحادثة للنشاط المراد حذفه

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

استثناءات

النوع الوصف
A exception error

delete_conversation_member

حذف عضو من المحادثة الحالية.

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

المعلمات

الاسم الوصف
context
مطلوب

كائن السياق الخاص بدور

member_id
مطلوب
str

معرف العضو المراد إزالته من المحادثة

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار لتنفيذه.</إرجاع

استثناءات

النوع الوصف
A exception error

exchange_token

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

المعلمات

الاسم الوصف
turn_context
مطلوب
connection_name
مطلوب
user_id
مطلوب
exchange_request
مطلوب

exchange_token_from_credentials

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

المعلمات

الاسم الوصف
turn_context
مطلوب
oauth_app_credentials
مطلوب
connection_name
مطلوب
user_id
مطلوب
exchange_request
مطلوب

get_aad_tokens

استرداد رموز Azure Active Directory المميزة لموارد معينة على اتصال تم تكوينه.

من النشاط في TurnContext. :اكتب user_id: str :p aram oauth_app_credentials: (اختياري) AppCredentials ل OAuth. :اكتب 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]

المعلمات

الاسم الوصف
context
مطلوب
connection_name
مطلوب
resource_urls
مطلوب
user_id
القيمة الافتراضية: None
oauth_app_credentials
القيمة الافتراضية: None

المرتجعات

النوع الوصف

قاموس عناوين URL للمورد إلى :class:'botbuilder.schema.TokenResponse'

get_activity_members

يسرد أعضاء نشاط معين.

إذا لم يتم تحديد سيتم استخدام معرف الأنشطة الحالي.

async get_activity_members(context: TurnContext, activity_id: str)

المعلمات

الاسم الوصف
context
مطلوب
activity_id
مطلوب

المرتجعات

النوع الوصف

قائمة أعضاء النشاط

استثناءات

النوع الوصف
An exception error

get_conversation_member

استرداد عضو في محادثة حالية.

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

المعلمات

الاسم الوصف
context
مطلوب

كائن السياق الخاص بدور

member_id
مطلوب
str

معرف العضو

المرتجعات

النوع الوصف

عضو في المحادثة الحالية

استثناءات

النوع الوصف
<xref:A TypeError if missing member_id>, <xref:service_url>, <xref:or conversation.id>

get_conversation_members

سرد أعضاء محادثة حالية.

async get_conversation_members(context: TurnContext)

المعلمات

الاسم الوصف
context
مطلوب

كائن السياق الخاص بدور

المرتجعات

النوع الوصف

قائمة أعضاء المحادثة الحالية

استثناءات

النوع الوصف
TypeError if missing service_url or conversation.id

get_conversations

يسرد المحادثات التي شارك فيها هذا الروبوت لخادم قناة معين.

context.activity.serviceUrl :اكتب service_url: str

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

المعلمات

الاسم الوصف
continuation_token
str

رمز المتابعة المميز من الصفحة السابقة للنتائج

القيمة الافتراضية: None
service_url
مطلوب
credentials
مطلوب

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

استثناءات

النوع الوصف
A generic exception error

الملاحظات

يقوم خادم القناة بإرجاع النتائج في الصفحات وستتضمن كل صفحة continuationToken التي يمكن استخدامها لإحضار الصفحة التالية من النتائج من الخادم. إذا اكتملت المهمة بنجاح، تحتوي النتيجة على صفحة لأعضاء المحادثة الحالية. قد يتم استدعاء هذا التحميل الزائد من خارج سياق المحادثة، حيث لا يلزم سوى عنوان URL لخدمة الروبوت وبيانات الاعتماد.

يحصل على ارتباط تسجيل الدخول الخام لإرساله إلى المستخدم لتسجيل الدخول لاسم اتصال.

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

المعلمات

الاسم الوصف
context
مطلوب

سياق الدور الحالي للمحادثة مع المستخدم

connection_name
مطلوب
str

اسم اتصال المصادقة المراد استخدامه

final_redirect

عنوان URL النهائي الذي سيعاد توجيه تدفق OAuth إليه.

القيمة الافتراضية: None
oauth_app_credentials
<xref:botframework.connector.auth.AppCredential>

(اختياري) AppCredentials ل OAuth.

القيمة الافتراضية: None

المرتجعات

النوع الوصف

إذا اكتملت المهمة بنجاح، تحتوي النتيجة على ارتباط تسجيل الدخول الخام

get_sign_in_resource_from_user

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

المعلمات

الاسم الوصف
turn_context
مطلوب
connection_name
مطلوب
user_id
مطلوب
final_redirect
القيمة الافتراضية: None

get_sign_in_resource_from_user_and_credentials

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

المعلمات

الاسم الوصف
turn_context
مطلوب
oauth_app_credentials
مطلوب
connection_name
مطلوب
user_id
مطلوب
final_redirect
القيمة الافتراضية: None

get_token_status

استرداد حالة الرمز المميز لكل اتصال تم تكوينه للمستخدم المحدد.

سيرجع Blank حالة الرمز المميز لكافة الاتصالات المكونة. :اكتب include_filter: str :p aram oauth_app_credentials: (اختياري) AppCredentials ل OAuth. :اكتب 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]

المعلمات

الاسم الوصف
context
مطلوب
connection_name
القيمة الافتراضية: None
user_id
القيمة الافتراضية: None
include_filter
القيمة الافتراضية: None
oauth_app_credentials
القيمة الافتراضية: None

المرتجعات

النوع الوصف

صفيف <xref:botframework.connector.token_api.modelsTokenStatus>

get_user_token

يحاول استرداد الرمز المميز لمستخدم في تدفق تسجيل الدخول.

:p aram magic_code" (اختياري) أدخل المستخدم التعليمات البرمجية للتحقق من صحة :str magic_code" str :p aram oauth_app_credentials: (اختياري) AppCredentials ل OAuth. :اكتب 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

المعلمات

الاسم الوصف
context
مطلوب
connection_name
مطلوب
magic_code
القيمة الافتراضية: None
oauth_app_credentials
القيمة الافتراضية: None

المرتجعات

النوع الوصف
:<xref:class>:’TokenResponse`

استجابة الرمز المميز

استثناءات

النوع الوصف
An exception error

key_for_app_credentials

static key_for_app_credentials(app_id: str, scope: str)

المعلمات

الاسم الوصف
app_id
مطلوب
scope
مطلوب

key_for_connector_client

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

المعلمات

الاسم الوصف
service_url
مطلوب
app_id
مطلوب
scope
مطلوب

parse_request

تحليل الطلب والتحقق من صحته :p aram req: :return:

async static parse_request(req)

المعلمات

الاسم الوصف
req
مطلوب

process_activity

إنشاء سياق منعطف وتشغيل البنية الأساسية لبرنامج ربط العمليات التجارية لبرنامج وسيط لنشاط وارد.

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

المعلمات

الاسم الوصف
req
مطلوب
<xref:typing.str>

النشاط الوارد

auth_header
مطلوب
<xref:typing.str>

عنوان مصادقة HTTP للطلب

logic
مطلوب

المنطق الذي يجب تنفيذه في نهاية خط أنابيب البرنامج الوسيط للمحول.

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار لتنفيذه.

الملاحظات

تعالج هذه الفئة نشاطا يتلقاه خادم الويب للروبوتات. يتضمن ذلك أي رسائل يتم إرسالها من مستخدم وهو الطريقة التي تدفع ما يشار إليه غالبا باسم الروبوتات تدفق المراسلة التفاعلية. اتصل بهذه الطريقة لإرسال رسالة إلى محادثة بشكل تفاعلي. إذا اكتملت المهمة بنجاح، إرجاع InvokeResponse؛ خلاف ذلك. يتم إرجاع فارغة.

process_activity_with_identity

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

المعلمات

الاسم الوصف
activity
مطلوب
identity
مطلوب
logic
مطلوب

process_outgoing_activity

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

المعلمات

الاسم الوصف
turn_context
مطلوب
activity
مطلوب

send_activities

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

المعلمات

الاسم الوصف
context
مطلوب
activities
مطلوب

sign_out_user

تسجيل خروج المستخدم باستخدام خادم الرمز المميز.

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

المعلمات

الاسم الوصف
context
مطلوب

سياق الدور الحالي للمحادثة مع المستخدم

connection_name
str

اسم اتصال المصادقة المراد استخدامه

القيمة الافتراضية: None
user_id
str

معرف المستخدم للمستخدم لتسجيل الخروج

القيمة الافتراضية: None
oauth_app_credentials
<xref:botframework.connector.auth.AppCredential>

(اختياري) AppCredentials ل OAuth.

القيمة الافتراضية: None

update_activity

استبدال نشاط تم إرساله مسبقا إلى قناة. تجدر الإشارة إلى أن جميع القنوات لا تدعم هذه الميزة.

async update_activity(context: TurnContext, activity: Activity)

المعلمات

الاسم الوصف
context
مطلوب

كائن السياق الخاص بدور

activity
مطلوب

نشاط استبدال جديد

المرتجعات

النوع الوصف

مهمة تمثل العمل في قائمة الانتظار للتنفيذ

استثناءات

النوع الوصف
A generic exception error

الملاحظات

إذا تم إرسال النشاط بنجاح، تحتوي نتيجة المهمة على كائن ResourceResponse يحتوي على المعرف الذي عينته القناة المتلقية للنشاط. قبل استدعاء هذه الدالة، قم بتعيين معرف نشاط الاستبدال إلى معرف النشاط لاستبداله.