BotFrameworkAdapter Sınıf
Botu hizmet uç noktasına bağlamak için bir bağdaştırıcı tanımlar.
BotFrameworkAdapter sınıfının yeni bir örneğini başlatır.
Oluşturucu
BotFrameworkAdapter(settings: BotFrameworkAdapterSettings)
Parametreler
| Name | Description |
|---|---|
|
settings
Gerekli
|
Bağdaştırıcıyı başlatma ayarları |
Açıklamalar
Bot bağdaştırıcısı, kimlik doğrulama işlemlerini kapsüller ve Bot Bağlayıcı Hizmeti'ne etkinlik gönderir ve bu hizmetten etkinlik alır. Botunuz bir etkinlik aldığında bağdaştırıcı bir bağlam nesnesi oluşturur, bunu botunuzun uygulama mantığına geçirir ve yanıtları kullanıcının kanalına geri gönderir. Bağdaştırıcı, bot ara yazılım işlem hattı aracılığıyla gelen etkinlikleri işler ve botunuzun mantığına yönlendirir ve ardından yeniden geri gider. Her etkinlik botun içine ve dışına aktıkça, her ara yazılım parçası bot mantığı çalışmadan önce ve çalıştırıldıktan sonra etkinliği inceleyebilir veya üzerinde işlem yapabilir.
Yöntemler
| can_process_outgoing_activity | |
| continue_conversation |
Bir kullanıcıyla konuşmaya devam eder. ve genellikle config.pyMicrosoftAppId parametresinde bulunur. :type bot_id: <xref:typing.str> :p aram claims_identity: Bot talep kimliği :type claims_identity: <xref:botframework.connector.auth.ClaimsIdentity> :p aram audience: :type audience: <xref:typing.str> |
| create_connector_client |
ConnectorClientProvider.create_connector_client uygulaması. |
| create_conversation |
Bir kullanıcıyla yeni bir konuşma başlatır. İletiyi bir grubun üyesine yönlendirmek için kullanılır. |
| delete_activity |
Daha önce kanala gönderilen bir etkinliği siler. Tüm kanalların bu özelliği desteklemediği belirtilmelidir. Not ConversationReference activity_id silinecek etkinliği tanımlar. |
| delete_conversation_member |
Bir üyeyi geçerli konuşmadan siler. |
| exchange_token | |
| exchange_token_from_credentials | |
| get_aad_tokens |
Yapılandırılmış bir bağlantıdaki belirli kaynaklar için Azure Active Directory belirteçlerini alır. seçeneğini seçin. :type user_id: str :p aram oauth_app_credentials: (İsteğe bağlı) OAuth için AppCredentials. :type oauth_app_credentials: <xref:botframework.connector.auth.AppCredential> |
| get_activity_members |
Belirli bir etkinliğin üyelerini listeler. Belirtilmezse geçerli etkinlik kimliği kullanılır. |
| get_conversation_member |
Geçerli bir konuşmanın üyesini alma. |
| get_conversation_members |
Geçerli bir konuşmanın üyelerini listeler. |
| get_conversations |
Bu botunun belirli bir kanal sunucusu için katıldığı Konuşmaları listeler. context.activity.serviceUrl :type service_url: str |
| get_oauth_sign_in_link |
Bağlantı adı için oturum açmak üzere kullanıcıya gönderilecek ham oturum açma bağlantısını alır. |
| get_sign_in_resource_from_user | |
| get_sign_in_resource_from_user_and_credentials | |
| get_token_status |
Belirli bir kullanıcı için yapılandırılmış her bağlantı için belirteç durumunu alır. Boş değer, yapılandırılan tüm bağlantılar için belirteç durumunu döndürür. :type include_filter: str :p aram oauth_app_credentials: (İsteğe bağlı) OAuth için AppCredentials. :type oauth_app_credentials: <xref:botframework.connector.auth.AppCredential> |
| get_user_token |
Oturum açma akışında olan bir kullanıcının belirtecini almaya çalışır. :p aram magic_code" (İsteğe bağlı) kullanıcısı :str magic_code" str :p aram oauth_app_credentials: (İsteğe bağlı) OAuth için AppCredentials'ı doğrulamak için kod girdi. :type oauth_app_credentials: <xref:botframework.connector.auth.AppCredential> |
| key_for_app_credentials | |
| key_for_connector_client | |
| parse_request |
İsteği ayrıştırıp doğrular :p aram req: :return: |
| process_activity |
Bir dönüş bağlamı oluşturur ve gelen etkinlik için ara yazılım işlem hattını çalıştırır. |
| process_activity_with_identity | |
| process_outgoing_activity | |
| send_activities | |
| sign_out_user |
Kullanıcıyı belirteç sunucusuyla imzalar. |
| update_activity |
Daha önce bir kanala gönderilen etkinliğin yerini alır. Tüm kanalların bu özelliği desteklemediği belirtilmelidir. |
can_process_outgoing_activity
can_process_outgoing_activity(activity: Activity) -> bool
Parametreler
| Name | Description |
|---|---|
|
activity
Gerekli
|
|
continue_conversation
Bir kullanıcıyla konuşmaya devam eder.
ve genellikle config.pyMicrosoftAppId parametresinde bulunur. :type bot_id: <xref:typing.str> :p aram claims_identity: Bot talep kimliği :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)
Parametreler
| Name | Description |
|---|---|
|
reference
Gerekli
|
|
|
callback
Gerekli
|
|
|
bot_id
|
Default value: None
|
|
claims_identity
|
Default value: None
|
|
audience
|
Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev. |
Özel durumlar
| Tür | Description |
|---|---|
|
It raises an argument null exception.
|
Açıklamalar
Bu genellikle botların iletişimde olan bir konuşmaya veya kullanıcıya proaktif olarak ileti göndermesine olanak sağlayan proaktif mesajlaşma akışı botlar olarak adlandırılır. Kullanıcıya bildirim veya kupon gönderme gibi senaryolar bu işlev tarafından etkinleştirilir.
create_connector_client
ConnectorClientProvider.create_connector_client uygulaması.
async create_connector_client(service_url: str, identity: ClaimsIdentity = None, audience: str = None) -> ConnectorClient
Parametreler
| Name | Description |
|---|---|
|
service_url
Gerekli
|
Hizmet URL'si |
|
identity
|
Talep kimliği Default value: None
|
|
audience
|
Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
<xref:botbuilder.core.ConnectorClient> sınıfının bir örneği |
create_conversation
Bir kullanıcıyla yeni bir konuşma başlatır. İletiyi bir grubun üyesine yönlendirmek için kullanılır.
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)
Parametreler
| Name | Description |
|---|---|
|
reference
Gerekli
|
Kiracıyı içeren konuşma başvurusu |
|
logic
|
Konuşmanın oluşturulması için kullanılacak mantık Default value: None
|
|
conversation_parameters
|
Konuşmayı oluşturmak için kullanılacak bilgiler Default value: None
|
|
channel_id
|
<xref:typing.str>
Kanalın kimliği. Default value: None
|
|
service_url
|
<xref:typing.str>
Kanalın hizmet URL'si uç noktası. Default value: None
|
|
credentials
|
<xref:botframework.connector.auth.AppCredentials>
Bot için uygulama kimlik bilgileri. Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden bir görev. |
Özel durumlar
| Tür | Description |
|---|---|
|
It raises a generic exception error.
|
Açıklamalar
Bir konuşma başlatmak için botunuzun bu kanaldaki hesap bilgilerini ve kullanıcının hesap bilgilerini bilmesi gerekir. Kanalların çoğu yalnızca doğrudan ileti (grup dışı) konuşma başlatmayı destekler. Bağdaştırıcı kanalda yeni bir konuşma oluşturmayı dener ve ardından ara yazılım işlem hattı aracılığıyla geri çağırma yöntemine bir konuşma güncelleştirme etkinliği gönderir. Belirtilen kullanıcılarla konuşma oluşturulursa, etkinliğin kimliği yeni konuşmanın kimliğini içerir.
delete_activity
Daha önce kanala gönderilen bir etkinliği siler. Tüm kanalların bu özelliği desteklemediği belirtilmelidir.
Not
ConversationReference activity_id silinecek etkinliği tanımlar.
async delete_activity(context: TurnContext, reference: ConversationReference)
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
Dönüş için bağlam nesnesi |
|
reference
Gerekli
|
Silinecek etkinlik için konuşma başvurusu |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Özel durumlar
| Tür | Description |
|---|---|
|
A exception error
|
delete_conversation_member
Bir üyeyi geçerli konuşmadan siler.
async delete_conversation_member(context: TurnContext, member_id: str) -> None
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
Dönüş için bağlam nesnesi |
|
member_id
Gerekli
|
Konuşmadan kaldırılacak üyenin kimliği |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev.</returns |
Özel durumlar
| Tür | Description |
|---|---|
|
A exception error
|
exchange_token
async exchange_token(turn_context: TurnContext, connection_name: str, user_id: str, exchange_request: TokenExchangeRequest) -> TokenResponse
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
|
|
connection_name
Gerekli
|
|
|
user_id
Gerekli
|
|
|
exchange_request
Gerekli
|
|
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
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
|
|
oauth_app_credentials
Gerekli
|
|
|
connection_name
Gerekli
|
|
|
user_id
Gerekli
|
|
|
exchange_request
Gerekli
|
|
get_aad_tokens
Yapılandırılmış bir bağlantıdaki belirli kaynaklar için Azure Active Directory belirteçlerini alır.
seçeneğini seçin. :type user_id: str :p aram oauth_app_credentials: (İsteğe bağlı) OAuth için AppCredentials. :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]
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
|
|
connection_name
Gerekli
|
|
|
resource_urls
Gerekli
|
|
|
user_id
|
Default value: None
|
|
oauth_app_credentials
|
Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Karşılık gelen :class:'botbuilder.schema.TokenResponse' kaynak URL'lerinin sözlüğü |
get_activity_members
Belirli bir etkinliğin üyelerini listeler.
Belirtilmezse geçerli etkinlik kimliği kullanılır.
async get_activity_members(context: TurnContext, activity_id: str)
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
|
|
activity_id
Gerekli
|
|
Döndürülenler
| Tür | Description |
|---|---|
|
Etkinliğin Üyeleri Listesi |
Özel durumlar
| Tür | Description |
|---|---|
|
An exception error
|
get_conversation_member
Geçerli bir konuşmanın üyesini alma.
async get_conversation_member(context: TurnContext, member_id: str) -> ChannelAccount
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
Dönüş için bağlam nesnesi |
|
member_id
Gerekli
|
Üye kimliği |
Döndürülenler
| Tür | Description |
|---|---|
|
Geçerli konuşmanın bir üyesi |
Özel durumlar
| Tür | Description |
|---|---|
|
<xref:A TypeError if missing member_id>, <xref:service_url>, <xref:or conversation.id>
|
get_conversation_members
Geçerli bir konuşmanın üyelerini listeler.
async get_conversation_members(context: TurnContext)
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
Dönüş için bağlam nesnesi |
Döndürülenler
| Tür | Description |
|---|---|
|
Geçerli konuşmanın üyeleri listesi |
Özel durumlar
| Tür | Description |
|---|---|
|
TypeError if missing service_url or conversation.id
|
get_conversations
Bu botunun belirli bir kanal sunucusu için katıldığı Konuşmaları listeler.
context.activity.serviceUrl :type service_url: str
async get_conversations(service_url: str, credentials: AppCredentials, continuation_token: str = None)
Parametreler
| Name | Description |
|---|---|
|
continuation_token
|
Önceki sonuç sayfasından devam belirteci Default value: None
|
|
service_url
Gerekli
|
|
|
credentials
Gerekli
|
|
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Özel durumlar
| Tür | Description |
|---|---|
|
A generic exception error
|
Açıklamalar
Kanal sunucusu sonuçları sayfa olarak döndürür ve her sayfada sunucudan bir sonraki sonuç sayfasını getirmek için kullanılabilecek bir continuationToken bulunur. Görev başarıyla tamamlanırsa, sonuç geçerli konuşmanın üyelerinin bir sayfasını içerir. Yalnızca botun hizmet URL'si ve kimlik bilgileri gerektiğinden, bu aşırı yükleme konuşma bağlamının dışından çağrılabilir.
get_oauth_sign_in_link
Bağlantı adı için oturum açmak üzere kullanıcıya gönderilecek ham oturum açma bağlantısını alır.
async get_oauth_sign_in_link(context: TurnContext, connection_name: str, final_redirect: str = None, oauth_app_credentials: AppCredentials = None) -> str
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
Kullanıcıyla konuşmanın geçerli dönüşünün bağlamı |
|
connection_name
Gerekli
|
Kullanılacak kimlik doğrulama bağlantısının adı |
|
final_redirect
|
OAuth akışının yeniden yönlendireceği son URL. Default value: None
|
|
oauth_app_credentials
|
<xref:botframework.connector.auth.AppCredential>
(İsteğe bağlı) OAuth için AppCredentials. Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
Görev başarıyla tamamlanırsa, sonuç ham oturum açma bağlantısını içerir |
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
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
|
|
connection_name
Gerekli
|
|
|
user_id
Gerekli
|
|
|
final_redirect
|
Default value: 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
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
|
|
oauth_app_credentials
Gerekli
|
|
|
connection_name
Gerekli
|
|
|
user_id
Gerekli
|
|
|
final_redirect
|
Default value: None
|
get_token_status
Belirli bir kullanıcı için yapılandırılmış her bağlantı için belirteç durumunu alır.
Boş değer, yapılandırılan tüm bağlantılar için belirteç durumunu döndürür. :type include_filter: str :p aram oauth_app_credentials: (İsteğe bağlı) OAuth için AppCredentials. :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]
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
|
|
connection_name
|
Default value: None
|
|
user_id
|
Default value: None
|
|
include_filter
|
Default value: None
|
|
oauth_app_credentials
|
Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
<xref:botframework.connector.token_api.modelsTokenStatus> dizisi |
get_user_token
Oturum açma akışında olan bir kullanıcının belirtecini almaya çalışır.
:p aram magic_code" (İsteğe bağlı) kullanıcısı :str magic_code" str :p aram oauth_app_credentials: (İsteğe bağlı) OAuth için AppCredentials'ı doğrulamak için kod girdi. :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
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
|
|
connection_name
Gerekli
|
|
|
magic_code
|
Default value: None
|
|
oauth_app_credentials
|
Default value: None
|
Döndürülenler
| Tür | Description |
|---|---|
|
:<xref:class>:’TokenResponse`
|
Belirteç Yanıtı |
Özel durumlar
| Tür | Description |
|---|---|
|
An exception error
|
key_for_app_credentials
static key_for_app_credentials(app_id: str, scope: str)
Parametreler
| Name | Description |
|---|---|
|
app_id
Gerekli
|
|
|
scope
Gerekli
|
|
key_for_connector_client
static key_for_connector_client(service_url: str, app_id: str, scope: str)
Parametreler
| Name | Description |
|---|---|
|
service_url
Gerekli
|
|
|
app_id
Gerekli
|
|
|
scope
Gerekli
|
|
parse_request
İsteği ayrıştırıp doğrular :p aram req: :return:
async static parse_request(req)
Parametreler
| Name | Description |
|---|---|
|
req
Gerekli
|
|
process_activity
Bir dönüş bağlamı oluşturur ve gelen etkinlik için ara yazılım işlem hattını çalıştırır.
async process_activity(req, auth_header: str, logic: Callable)
Parametreler
| Name | Description |
|---|---|
|
req
Gerekli
|
<xref:typing.str>
Gelen etkinlik |
|
auth_header
Gerekli
|
<xref:typing.str>
İsteğin HTTP kimlik doğrulaması üst bilgisi |
|
logic
Gerekli
|
Bağdaştırıcının ara yazılım işlem hattının sonunda yürütülecek mantık. |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev. |
Açıklamalar
Bu sınıf, botlar web sunucusu tarafından alınan bir etkinliği işler. Bu, bir kullanıcıdan gönderilen iletileri içerir ve genellikle botlar reaktif mesajlaşma akışı olarak adlandırılanları yönlendiren yöntemdir. Konuşmaya reaktif olarak ileti göndermek için bu yöntemi çağırın. Görev başarıyla tamamlanırsa bir InvokeResponse döndürülür; yoksa. null döndürülür.
process_activity_with_identity
async process_activity_with_identity(activity: Activity, identity: ClaimsIdentity, logic: Callable)
Parametreler
| Name | Description |
|---|---|
|
activity
Gerekli
|
|
|
identity
Gerekli
|
|
|
logic
Gerekli
|
|
process_outgoing_activity
async process_outgoing_activity(turn_context: TurnContext, activity: Activity) -> ResourceResponse
Parametreler
| Name | Description |
|---|---|
|
turn_context
Gerekli
|
|
|
activity
Gerekli
|
|
send_activities
async send_activities(context: TurnContext, activities: List[Activity]) -> List[ResourceResponse]
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
|
|
activities
Gerekli
|
|
sign_out_user
Kullanıcıyı belirteç sunucusuyla imzalar.
async sign_out_user(context: TurnContext, connection_name: str = None, user_id: str = None, oauth_app_credentials: AppCredentials = None)
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
Kullanıcıyla konuşmanın geçerli dönüşünün bağlamı |
|
connection_name
|
Kullanılacak kimlik doğrulama bağlantısının adı Default value: None
|
|
user_id
|
Oturumu kapatacak kullanıcının kullanıcı kimliği Default value: None
|
|
oauth_app_credentials
|
<xref:botframework.connector.auth.AppCredential>
(İsteğe bağlı) OAuth için AppCredentials. Default value: None
|
update_activity
Daha önce bir kanala gönderilen etkinliğin yerini alır. Tüm kanalların bu özelliği desteklemediği belirtilmelidir.
async update_activity(context: TurnContext, activity: Activity)
Parametreler
| Name | Description |
|---|---|
|
context
Gerekli
|
Dönüş için bağlam nesnesi |
|
activity
Gerekli
|
Yeni değiştirme etkinliği |
Döndürülenler
| Tür | Description |
|---|---|
|
Yürütülmek üzere kuyruğa alınan çalışmayı temsil eden görev |
Özel durumlar
| Tür | Description |
|---|---|
|
A generic exception error
|
Açıklamalar
Etkinlik başarıyla gönderilirse, görev sonucu, alıcı kanalın etkinliğe atadığı kimliği içeren bir ResourceResponse nesnesi içerir. Bu işlevi çağırmadan önce, değiştirme etkinliğinin kimliğini değiştirilecek etkinliğin kimliği olarak ayarlayın.