Activity Sınıf

Etkinlik, Bot Framework 3.0 protokolü için temel iletişim türüdür.

Oluşturucu

Activity(*, type=None, id: str = None, timestamp=None, local_timestamp=None, local_timezone: str = None, service_url: str = None, channel_id: str = None, from_property=None, conversation=None, recipient=None, text_format=None, attachment_layout=None, members_added=None, members_removed=None, reactions_added=None, reactions_removed=None, topic_name: str = None, history_disclosed: bool = None, locale: str = None, text: str = None, speak: str = None, input_hint=None, summary: str = None, suggested_actions=None, attachments=None, entities=None, channel_data=None, action: str = None, reply_to_id: str = None, label: str = None, value_type: str = None, value=None, name: str = None, relates_to=None, code=None, expiration=None, importance=None, delivery_mode=None, listen_for=None, text_highlights=None, semantic_action=None, caller_id: str = None, **kwargs)

Parametreler

Name Description
type
Gerekli
str veya <xref:botframework.connector.models.ActivityTypes>

Etkinlik türünü içerir. Olası değerler şunlardır: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'

id
Gerekli
str

Kanaldaki etkinliği benzersiz olarak tanımlayan bir kimlik içerir.

timestamp
Gerekli

İletinin UTC olarak gönderildiği, ISO-8601 biçiminde ifade edilen tarih ve saati içerir.

local_timestamp
Gerekli

iso-8601 biçiminde ifade edilen iletinin yerel tarih ve saatini içerir. Örneğin, 2016-09-23T13:07:49.4714686-07:00.

local_timezone
Gerekli
str

İletinin IANA Saat Dilimi veritabanı biçiminde ifade edilen yerel saat diliminin adını içerir. Örneğin, Amerika/Los_Angeles.

service_url
Gerekli
str

Kanalın hizmet uç noktasını belirten URL'yi içerir. Kanala göre ayarlayın.

channel_id
Gerekli
str

Kanalı benzersiz olarak tanımlayan bir kimlik içerir. Kanala göre ayarlayın.

from_property
Gerekli
<xref:botframework.connector.models.ChannelAccount>

İletinin gönderenini tanımlar.

conversation
Gerekli
<xref:botframework.connector.models.ConversationAccount>

Etkinliğin ait olduğu konuşmayı tanımlar.

recipient
Gerekli
<xref:botframework.connector.models.ChannelAccount>

İletinin alıcısını tanımlar.

text_format
Gerekli
str veya <xref:botframework.connector.models.TextFormatTypes>

Default:markdown metin alanlarının biçimi. Olası değerler şunlardır: 'markdown', 'plain', 'xml'

attachment_layout
Gerekli
str veya <xref:botframework.connector.models.AttachmentLayoutTypes>

Birden çok ek için düzen ipucu. Varsayılan: liste. Olası değerler şunlardır: 'list', 'carousel'

members_added
Gerekli
list[<xref:botframework.connector.models.ChannelAccount>]

Konuşmaya eklenen üye koleksiyonu.

members_removed
Gerekli
list[<xref:botframework.connector.models.ChannelAccount>]

Konuşmadan kaldırılan üye koleksiyonu.

reactions_added
Gerekli
list[<xref:botframework.connector.models.MessageReaction>]

Konuşmaya eklenen tepkilerin koleksiyonu.

reactions_removed
Gerekli
list[<xref:botframework.connector.models.MessageReaction>]

Tepkilerin toplanması konuşmadan kaldırıldı.

topic_name
Gerekli
str

Konuşmanın güncelleştirilmiş konu adı.

history_disclosed
Gerekli

Kanalın önceki geçmişinin açıklanıp açıklanmadığını gösterir.

locale
Gerekli
str

Metin alanının içeriği için bir yerel ayar adı. Yerel ayar adı, bir dille ilişkilendirilmiş iso 639 iki veya üç harfli kültür kodunun ve bir ülke veya bölgeyle ilişkilendirilmiş ISO 3166 iki harfli alt kültür kodunun birleşimidir. Yerel ayar adı geçerli bir BCP-47 dil etiketine de karşılık gelebilir.

text
Gerekli
str

İletinin metin içeriği.

speak
Gerekli
str

Konuşacak metin.

input_hint
Gerekli
str veya <xref:botframework.connector.models.InputHints>

İleti istemciye teslim edildikten sonra botunuzun kullanıcı girişini kabul edip etmediğini, beklediğini veya yoksaydığını gösterir. Olası değerler şunlardır: 'acceptingInput', 'ignoringInput', 'expectingInput'

summary
Gerekli
str

Kanal kartları işleyemezse görüntülenecek metin.

suggested_actions
Gerekli
<xref:botframework.connector.models.SuggestedActions>

Etkinlik için önerilen eylemler.

attachments
Gerekli
list[<xref:botframework.connector.models.Attachment>]

Ekleri

entities
Gerekli
list[<xref:botframework.connector.models.Entity>]

İletide bahsedilen varlıkları temsil eder.

channel_data
Gerekli

Kanala özgü içerik içerir.

action
Gerekli
str

Bir contactRelationUpdate alıcısının, gönderenin kişi listesinden eklenip eklenmediğini veya kaldırıldığını gösterir.

reply_to_id
Gerekli
str

Bu iletinin yanıt olduğu iletinin kimliğini içerir.

label
Gerekli
str

Etkinlik için açıklayıcı bir etiket.

value_type
Gerekli
str

Etkinliğin değer nesnesinin türü.

value
Gerekli

Etkinlikle ilişkili bir değer.

name
Gerekli
str

Bir çağırma veya olay etkinliğiyle ilişkili işlemin adı.

relates_to
Gerekli
<xref:botframework.connector.models.ConversationReference>

Başka bir konuşmaya veya etkinliğe başvuru.

code
Gerekli
str veya <xref:botframework.connector.models.EndOfConversationCodes>

Konuşmanın neden sona erdiğini gösteren endOfConversation etkinliklerinin kodu. Olası değerler şunlardır: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed'

expiration
Gerekli

Etkinliğin "süresi dolmuş" olarak kabul edilmesi ve alıcıya sunulmaması gereken saat.

importance
Gerekli
str veya <xref:botframework.connector.models.ActivityImportance>

Etkinliğin önemi. Olası değerler şunlardır: 'low', 'normal', 'high'

delivery_mode
Gerekli
str veya <xref:botframework.connector.models.DeliveryModes>

Alıcıya etkinliğin alternatif teslim yollarını belirten bir teslim ipucu. Varsayılan teslim modu "varsayılan"dır. Olası değerler şunlardır: 'normal', 'notification', 'expectReplies', 'ephemeral'

listen_for
Gerekli

Konuşma ve dil hazırlama sistemlerinin dinlemesi gereken tümceciklerin ve başvuruların listesi

text_highlights
Gerekli
list[<xref:botframework.connector.models.TextHighlight>]

Etkinlik bir ReplyToId değeri içerdiğinde vurgulamak için metin parçalarının koleksiyonu.

semantic_action
Gerekli
<xref:botframework.connector.models.SemanticAction>

Bu isteğe eşlik eden isteğe bağlı bir programlı eylem

caller_id
Gerekli
str

Bir botun çağıranı tanımlayan bir IRI içeren dize. Bu alan kablo üzerinden iletilmesi amaçlanmamıştır, bunun yerine çağıranların kimliğini onaylayan kriptografik olarak doğrulanabilir verilere (örn. belirteçler) dayalı olarak botlar ve istemciler tarafından doldurulur.

Yalnızca Anahtar Sözcük Parametreleri

Name Description
type
Gerekli
id
Gerekli
timestamp
Gerekli
local_timestamp
Gerekli
local_timezone
Gerekli
service_url
Gerekli
channel_id
Gerekli
from_property
Gerekli
conversation
Gerekli
recipient
Gerekli
text_format
Gerekli
attachment_layout
Gerekli
members_added
Gerekli
members_removed
Gerekli
reactions_added
Gerekli
reactions_removed
Gerekli
topic_name
Gerekli
history_disclosed
Gerekli
locale
Gerekli
text
Gerekli
speak
Gerekli
input_hint
Gerekli
summary
Gerekli
suggested_actions
Gerekli
attachments
Gerekli
entities
Gerekli
channel_data
Gerekli
action
Gerekli
reply_to_id
Gerekli
label
Gerekli
value_type
Gerekli
value
Gerekli
name
Gerekli
relates_to
Gerekli
code
Gerekli
expiration
Gerekli
importance
Gerekli
delivery_mode
Gerekli
listen_for
Gerekli
text_highlights
Gerekli
semantic_action
Gerekli
caller_id
Gerekli

Yöntemler

apply_conversation_reference

Bu etkinliği mevcut bir ConversationReference'tan gelen teslim bilgileriyle güncelleştirir

botunun alıcı olduğu gelen etkinlik; aksi takdirde, False. Varsayılan değer False'tur ve etkinlik botu gönderen olarak gösterir.

as_contact_relation_update_activity

Bu etkinliği ContactRelationUpdateActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_conversation_update_activity

Bu etkinliği ConversationUpdateActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_end_of_conversation_activity

Bu etkinliği EndOfConversationActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_event_activity

Bu etkinliği EventActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_handoff_activity

Bu etkinliği HandoffActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_installation_update_activity

Bu etkinliği bir InstallationUpdateActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_invoke_activity

Bu etkinliği InvokeActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_message_activity

Bu etkinliği MessageActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_message_delete_activity

Bu etkinliği MessageDeleteActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_message_reaction_activity

Bu etkinliği MessageReactionActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_message_update_activity

Bu etkinliği MessageUpdateActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_suggestion_activity

Bu etkinliği Bir SuggestionActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_trace_activity

Bu etkinliği TraceActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_typing_activity

Bu etkinliği Bir TypingActivity nesnesi olarak döndürür; veya null, bu tür bir etkinlik değilse.

create_contact_relation_update_activity

Activity sınıfının bir örneğini aContactRelationUpdateActivity nesnesi olarak oluşturur.

create_conversation_update_activity

Activity sınıfının bir örneğini ConversationUpdateActivity nesnesi olarak oluşturur.

create_end_of_conversation_activity

EndOfConversationActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

create_event_activity

eventActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

create_handoff_activity

handoffActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

create_invoke_activity

InvokeActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

create_message_activity

messageActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

create_reply

Bu etkinliğe yanıt olarak yeni bir ileti etkinliği oluşturur.

create_trace

Bu etkinliği temel alan yeni bir izleme etkinliği oluşturur.

Varsayılan değer türünün adıdır. :p aram etiketi: İsteğe bağlı, bu izleme işlemi için açıklayıcı bir etiket.

create_trace_activity

traceActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

Varsayılan değer türünün adıdır. :p aram etiketi: İsteğe bağlı, bu izleme işlemi için açıklayıcı bir etiket.

create_typing_activity

Activity sınıfının bir örneğini TypingActivity nesnesi olarak oluşturur.

get_conversation_reference

Bu etkinliği temel alan bir ConversationReference oluşturur.

get_mentions

Bu etkinliğin varlıklarından bahsetmeleri çözer.

get_reply_conversation_reference

Bu Etkinliğin Konuşma bilgilerini ve ResourceResponse'un etkinlik göndermesini temel alan bir ConversationReference oluşturun.

has_content

Bu etkinliğin içeriği olup olmadığını gösterir.

is_from_streaming_connection

Etkinliğin bir Http/Https bağlantısı veya Akış yoluyla gönderilip gönderilmediğini belirleme Bu, service_url özelliğine bakılarak belirlenebilir: (1) http/https üzerinden ileti gönderen tüm kanallar akış yapmaz (2) Akış yoluyla ileti gönderen kanalların http/https ile başlamayan bir ServiceUrl'ı vardır.

apply_conversation_reference

Bu etkinliği mevcut bir ConversationReference'tan gelen teslim bilgileriyle güncelleştirir

botunun alıcı olduğu gelen etkinlik; aksi takdirde, False. Varsayılan değer False'tur ve etkinlik botu gönderen olarak gösterir.

apply_conversation_reference(reference: ConversationReference, is_incoming: bool = False)

Parametreler

Name Description
reference
Gerekli
is_incoming
Default value: False

Döndürülenler

Tür Description

etkinliği, teslimat bilgileriyle güncelleştirildi.

Açıklamalar

Daha sonra giden bir etkinliği doğru teslim bilgileriyle güncelleştirmek için kullanabileceğiniz bir konuşma başvurusu almak için gelen etkinlikte GetConversationReference'ı çağırın.

as_contact_relation_update_activity

Bu etkinliği ContactRelationUpdateActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_contact_relation_update_activity()

Döndürülenler

Tür Description

İleti etkinliği olarak bu etkinlik; veya Hiçbiri.

as_conversation_update_activity

Bu etkinliği ConversationUpdateActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_conversation_update_activity()

Döndürülenler

Tür Description

Konuşma güncelleştirme etkinliği olarak bu etkinlik; veya Hiçbiri.

as_end_of_conversation_activity

Bu etkinliği EndOfConversationActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_end_of_conversation_activity()

Döndürülenler

Tür Description

Konuşma sonu etkinliği olarak bu etkinlik; veya Hiçbiri.

as_event_activity

Bu etkinliği EventActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_event_activity()

Döndürülenler

Tür Description

Olay etkinliği olarak bu etkinlik; veya Hiçbiri.

as_handoff_activity

Bu etkinliği HandoffActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_handoff_activity()

Döndürülenler

Tür Description

Bu etkinlik bir iletim etkinliği olarak; veya Hiçbiri.

as_installation_update_activity

Bu etkinliği bir InstallationUpdateActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_installation_update_activity()

Döndürülenler

Tür Description

Yükleme güncelleştirme etkinliği olarak bu etkinlik; veya Hiçbiri.

as_invoke_activity

Bu etkinliği InvokeActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_invoke_activity()

Döndürülenler

Tür Description

Çağırma etkinliği olarak bu etkinlik; veya Hiçbiri.

as_message_activity

Bu etkinliği MessageActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_message_activity()

Döndürülenler

Tür Description

İleti etkinliği olarak bu etkinlik; veya Hiçbiri.

as_message_delete_activity

Bu etkinliği MessageDeleteActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_message_delete_activity()

Döndürülenler

Tür Description

İleti silme isteği olarak bu etkinlik; veya Hiçbiri.

as_message_reaction_activity

Bu etkinliği MessageReactionActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_message_reaction_activity()

Döndürülenler

Tür Description

İleti reaksiyon etkinliği olarak bu etkinlik; veya Hiçbiri.

as_message_update_activity

Bu etkinliği MessageUpdateActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_message_update_activity()

Döndürülenler

Tür Description

İleti güncelleştirme isteği olarak bu etkinlik; veya Hiçbiri.

as_suggestion_activity

Bu etkinliği Bir SuggestionActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_suggestion_activity()

Döndürülenler

Tür Description

Öneri etkinliği olarak bu etkinlik; veya Hiçbiri.

as_trace_activity

Bu etkinliği TraceActivity nesnesi olarak döndürür; veya Hiçbiri, bu tür bir etkinlik değilse.

as_trace_activity()

Döndürülenler

Tür Description

İzleme etkinliği olarak bu etkinlik; veya Hiçbiri.

as_typing_activity

Bu etkinliği Bir TypingActivity nesnesi olarak döndürür; veya null, bu tür bir etkinlik değilse.

as_typing_activity()

Döndürülenler

Tür Description

Yazma etkinliği olarak bu etkinlik; veya null.

create_contact_relation_update_activity

Activity sınıfının bir örneğini aContactRelationUpdateActivity nesnesi olarak oluşturur.

static create_contact_relation_update_activity()

Döndürülenler

Tür Description

Yeni kişi ilişkisi güncelleştirme etkinliği.

create_conversation_update_activity

Activity sınıfının bir örneğini ConversationUpdateActivity nesnesi olarak oluşturur.

static create_conversation_update_activity()

Döndürülenler

Tür Description

Yeni konuşma güncelleştirme etkinliği.

create_end_of_conversation_activity

EndOfConversationActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

static create_end_of_conversation_activity()

Döndürülenler

Tür Description

Yeni konuşma sonu etkinliği.

create_event_activity

eventActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

static create_event_activity()

Döndürülenler

Tür Description

Yeni olay etkinliği.

create_handoff_activity

handoffActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

static create_handoff_activity()

Döndürülenler

Tür Description

Yeni iletim etkinliği.

create_invoke_activity

InvokeActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

static create_invoke_activity()

Döndürülenler

Tür Description

Yeni çağırma etkinliği.

create_message_activity

messageActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

static create_message_activity()

Döndürülenler

Tür Description

Yeni ileti etkinliği.

create_reply

Bu etkinliğe yanıt olarak yeni bir ileti etkinliği oluşturur.

create_reply(text: str = None, locale: str = None)

Parametreler

Name Description
text

Yanıtın metni.

Default value: None
locale

Metnin dil kodu.

Default value: None

Döndürülenler

Tür Description

Yeni ileti etkinliği.

Açıklamalar

Yeni etkinlik, bu etkinliğe göre yönlendirme bilgilerini ayarlar.

create_trace

Bu etkinliği temel alan yeni bir izleme etkinliği oluşturur.

Varsayılan değer türünün adıdır. :p aram etiketi: İsteğe bağlı, bu izleme işlemi için açıklayıcı bir etiket.

create_trace(name: str, value: object = None, value_type: str = None, label: str = None)

Parametreler

Name Description
name
Gerekli
value
Default value: None
value_type
Default value: None
label
Default value: None

Döndürülenler

Tür Description

Yeni izleme etkinliği.

create_trace_activity

traceActivity nesnesi olarak Activity sınıfının bir örneğini oluşturur.

Varsayılan değer türünün adıdır. :p aram etiketi: İsteğe bağlı, bu izleme işlemi için açıklayıcı bir etiket.

static create_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None)

Parametreler

Name Description
name
Gerekli
value
Default value: None
value_type
Default value: None
label
Default value: None

Döndürülenler

Tür Description

Yeni izleme etkinliği.

create_typing_activity

Activity sınıfının bir örneğini TypingActivity nesnesi olarak oluşturur.

static create_typing_activity()

Döndürülenler

Tür Description

Yeni yazma etkinliği.

get_conversation_reference

Bu etkinliği temel alan bir ConversationReference oluşturur.

get_conversation_reference()

Döndürülenler

Tür Description

Bu etkinliği içeren konuşma için konuşma başvurusu.

get_mentions

Bu etkinliğin varlıklarından bahsetmeleri çözer.

get_mentions() -> List[Mention]

Döndürülenler

Tür Description

Bahsetme dizisi; veya boş bir dizi( yoksa).

Açıklamalar

Bu yöntem Activity sınıfında tanımlanır, ancak yalnızca activity.Type değerinin ActivityTypes.Message olarak ayarlandığı bir ileti etkinliğiyle kullanılmak üzere tasarlanmıştır.

get_reply_conversation_reference

Bu Etkinliğin Konuşma bilgilerini ve ResourceResponse'un etkinlik göndermesini temel alan bir ConversationReference oluşturun.

get_reply_conversation_reference(reply: ResourceResponse) -> ConversationReference

Parametreler

Name Description
reply
Gerekli

ResourceResponse, send_activity'dan döndürüldü.

Döndürülenler

Tür Description

Etkinliği silmek veya güncelleştirmek için depolanabilen ve daha sonra kullanılabilen bir ConversationReference.

has_content

Bu etkinliğin içeriği olup olmadığını gösterir.

has_content() -> bool

Döndürülenler

Tür Description

Doğru, bu etkinliğin gönderilecek içeriği varsa; aksi takdirde false.

Açıklamalar

Bu yöntem Activity sınıfında tanımlanır, ancak yalnızca activity.Type değerinin ActivityTypes.Message olarak ayarlandığı bir ileti etkinliğiyle kullanılmak üzere tasarlanmıştır.

is_from_streaming_connection

Etkinliğin bir Http/Https bağlantısı veya Akış yoluyla gönderilip gönderilmediğini belirleme Bu, service_url özelliğine bakılarak belirlenebilir: (1) http/https üzerinden ileti gönderen tüm kanallar akış yapmaz (2) Akış yoluyla ileti gönderen kanalların http/https ile başlamayan bir ServiceUrl'ı vardır.

is_from_streaming_connection() -> bool

Döndürülenler

Tür Description

Etkinlik bir akış bağlantısından geliyorsa true.