Activity Classe
Uma Atividade é o tipo de comunicação básico para o protocolo Bot Framework 3.0.
- Herança
-
msrest.serialization.ModelActivity
Construtor
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)Parâmetros
| Nome | Description |
|---|---|
|
type
Obrigatório
|
str ou
<xref:botframework.connector.models.ActivityTypes>
Contém o tipo de atividade. Os valores possíveis incluem: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff' |
|
id
Obrigatório
|
Contém uma ID que identifica exclusivamente a atividade no canal. |
|
timestamp
Obrigatório
|
Contém a data e a hora em que a mensagem foi enviada, em UTC, expressa no formato ISO-8601. |
|
local_timestamp
Obrigatório
|
Contém a data e a hora locais da mensagem expressa no formato ISO-8601. Por exemplo, 2016-09-23T13:07:49.4714686-07:00. |
|
local_timezone
Obrigatório
|
Contém o nome do fuso horário local da mensagem, expresso no formato de banco de dados de fuso horário IANA. Por exemplo, America/Los_Angeles. |
|
service_url
Obrigatório
|
Contém a URL que especifica o ponto de extremidade de serviço do canal. Definida pelo canal. |
|
channel_id
Obrigatório
|
Contém uma ID que identifica exclusivamente o canal. Definida pelo canal. |
|
from_property
Obrigatório
|
<xref:botframework.connector.models.ChannelAccount>
Identifica o remetente da mensagem. |
|
conversation
Obrigatório
|
<xref:botframework.connector.models.ConversationAccount>
Identifica a conversa à qual a atividade pertence. |
|
recipient
Obrigatório
|
<xref:botframework.connector.models.ChannelAccount>
Identifica o destinatário da mensagem. |
|
text_format
Obrigatório
|
str ou
<xref:botframework.connector.models.TextFormatTypes>
Formato dos campos de texto Padrão:markdown. Os valores possíveis incluem: 'markdown', 'plain', 'xml' |
|
attachment_layout
Obrigatório
|
str ou
<xref:botframework.connector.models.AttachmentLayoutTypes>
A dica de layout para vários anexos. Padrão: lista. Os valores possíveis incluem: 'list', 'carrossel' |
|
members_added
Obrigatório
|
list[<xref:botframework.connector.models.ChannelAccount>]
A coleção de membros adicionada à conversa. |
|
members_removed
Obrigatório
|
list[<xref:botframework.connector.models.ChannelAccount>]
A coleção de membros removidos da conversa. |
|
reactions_added
Obrigatório
|
list[<xref:botframework.connector.models.MessageReaction>]
A coleção de reações adicionadas à conversa. |
|
reactions_removed
Obrigatório
|
list[<xref:botframework.connector.models.MessageReaction>]
A coleção de reações removidas da conversa. |
|
topic_name
Obrigatório
|
O nome do tópico atualizado da conversa. |
|
history_disclosed
Obrigatório
|
Indica se o histórico anterior do canal é divulgado. |
|
locale
Obrigatório
|
Um nome de localidade para o conteúdo do campo de texto. O nome da localidade é uma combinação de um código de cultura ISO 639 de duas ou três letras associado a um idioma e um código de subcultura iso 3166 de duas letras associado a um país ou região. O nome da localidade também pode corresponder a uma marca de idioma BCP-47 válida. |
|
text
Obrigatório
|
O conteúdo do texto da mensagem. |
|
speak
Obrigatório
|
O texto para fala. |
|
input_hint
Obrigatório
|
str ou
<xref:botframework.connector.models.InputHints>
Indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente. Os valores possíveis incluem: 'acceptingInput', 'ignoringInput', 'expectingInput' |
|
summary
Obrigatório
|
O texto a ser exibido se o canal não puder renderizar cartões. |
|
suggested_actions
Obrigatório
|
<xref:botframework.connector.models.SuggestedActions>
As ações sugeridas para a atividade. |
|
attachments
Obrigatório
|
list[<xref:botframework.connector.models.Attachment>]
Anexos |
|
entities
Obrigatório
|
list[<xref:botframework.connector.models.Entity>]
Representa as entidades que foram mencionadas na mensagem. |
|
channel_data
Obrigatório
|
Contém conteúdo específico do canal. |
|
action
Obrigatório
|
Indica se o destinatário de um contactRelationUpdate foi adicionado ou removido da lista de contatos do remetente. |
|
reply_to_id
Obrigatório
|
Contém a ID da mensagem à qual essa mensagem é uma resposta. |
|
label
Obrigatório
|
Um rótulo descritivo da atividade. |
|
value_type
Obrigatório
|
O tipo do objeto de valor da atividade. |
|
value
Obrigatório
|
Um valor associado à atividade. |
|
name
Obrigatório
|
O nome da operação associada a uma atividade de invocação ou evento. |
|
relates_to
Obrigatório
|
<xref:botframework.connector.models.ConversationReference>
Uma referência a outra conversa ou atividade. |
|
code
Obrigatório
|
str ou
<xref:botframework.connector.models.EndOfConversationCodes>
O código para atividades endOfConversation que indica por que a conversa terminou. Os valores possíveis incluem: 'unknown', 'completedSuccessfully', 'userCancelled', 'botTimedOut', 'botIssuedInvalidMessage', 'channelFailed' |
|
expiration
Obrigatório
|
A hora na qual a atividade deve ser considerada "expirada" e não deve ser apresentada ao destinatário. |
|
importance
Obrigatório
|
str ou
<xref:botframework.connector.models.ActivityImportance>
A importância da atividade. Os valores possíveis incluem: 'low', 'normal', 'high' |
|
delivery_mode
Obrigatório
|
str ou
<xref:botframework.connector.models.DeliveryModes>
Uma dica de entrega para sinalizar os caminhos de entrega alternativos do destinatário para a atividade. O modo de entrega padrão é "padrão". Os valores possíveis incluem: 'normal', 'notification', 'expectReplies', 'efêmero' |
|
listen_for
Obrigatório
|
Lista de frases e referências que os sistemas de priming de fala e idioma devem escutar |
|
text_highlights
Obrigatório
|
list[<xref:botframework.connector.models.TextHighlight>]
A coleção de fragmentos de texto a serem realçados quando a atividade contiver um valor ReplyToId. |
|
semantic_action
Obrigatório
|
<xref:botframework.connector.models.SemanticAction>
Uma ação programática opcional que acompanha essa solicitação |
|
caller_id
Obrigatório
|
Uma cadeia de caracteres que contém um IRI que identifica o chamador de um bot. Este campo não se destina a ser transmitido eletronicamente; em vez disso, ele é preenchido por bots e clientes com base em dados verificáveis criptograficamente que declara a identidade dos chamadores (por exemplo, tokens). |
Parâmetros somente de palavra-chave
| Nome | Description |
|---|---|
|
type
Obrigatório
|
|
|
id
Obrigatório
|
|
|
timestamp
Obrigatório
|
|
|
local_timestamp
Obrigatório
|
|
|
local_timezone
Obrigatório
|
|
|
service_url
Obrigatório
|
|
|
channel_id
Obrigatório
|
|
|
from_property
Obrigatório
|
|
|
conversation
Obrigatório
|
|
|
recipient
Obrigatório
|
|
|
text_format
Obrigatório
|
|
|
attachment_layout
Obrigatório
|
|
|
members_added
Obrigatório
|
|
|
members_removed
Obrigatório
|
|
|
reactions_added
Obrigatório
|
|
|
reactions_removed
Obrigatório
|
|
|
topic_name
Obrigatório
|
|
|
history_disclosed
Obrigatório
|
|
|
locale
Obrigatório
|
|
|
text
Obrigatório
|
|
|
speak
Obrigatório
|
|
|
input_hint
Obrigatório
|
|
|
summary
Obrigatório
|
|
|
suggested_actions
Obrigatório
|
|
|
attachments
Obrigatório
|
|
|
entities
Obrigatório
|
|
|
channel_data
Obrigatório
|
|
|
action
Obrigatório
|
|
|
reply_to_id
Obrigatório
|
|
|
label
Obrigatório
|
|
|
value_type
Obrigatório
|
|
|
value
Obrigatório
|
|
|
name
Obrigatório
|
|
|
relates_to
Obrigatório
|
|
|
code
Obrigatório
|
|
|
expiration
Obrigatório
|
|
|
importance
Obrigatório
|
|
|
delivery_mode
Obrigatório
|
|
|
listen_for
Obrigatório
|
|
|
text_highlights
Obrigatório
|
|
|
semantic_action
Obrigatório
|
|
|
caller_id
Obrigatório
|
|
Métodos
| apply_conversation_reference |
Atualizações essa atividade com as informações de entrega de uma ConversationReference existente atividade de entrada, em que o bot é o destinatário; caso contrário, False. O padrão é False e a atividade mostrará o bot como o remetente. |
| as_contact_relation_update_activity |
Retorna essa atividade como um objeto ContactRelationUpdateActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_conversation_update_activity |
Retorna essa atividade como um objeto ConversationUpdateActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_end_of_conversation_activity |
Retorna essa atividade como um objeto EndOfConversationActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_event_activity |
Retorna essa atividade como um objeto EventActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_handoff_activity |
Retorna essa atividade como um objeto HandoffActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_installation_update_activity |
Retorna essa atividade como um objeto InstallationUpdateActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_invoke_activity |
Retorna essa atividade como um objeto InvokeActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_message_activity |
Retorna essa atividade como um objeto MessageActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_message_delete_activity |
Retorna essa atividade como um objeto MessageDeleteActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_message_reaction_activity |
Retorna essa atividade como um objeto MessageReactionActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_message_update_activity |
Retorna essa atividade como um objeto MessageUpdateActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_suggestion_activity |
Retorna essa atividade como um objeto SuggestionActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_trace_activity |
Retorna essa atividade como um objeto TraceActivity; ou Nenhum, se esse não for esse tipo de atividade. |
| as_typing_activity |
Retorna essa atividade como um objeto TypingActivity; ou nulo, se esse não for esse tipo de atividade. |
| create_contact_relation_update_activity |
Cria uma instância da Activity classe como um objetoContactRelationUpdateActivity. |
| create_conversation_update_activity |
Cria uma instância da Activity classe como um objeto ConversationUpdateActivity. |
| create_end_of_conversation_activity |
Cria uma instância da Activity classe como um objeto EndOfConversationActivity. |
| create_event_activity |
Cria uma instância da Activity classe como um objeto EventActivity. |
| create_handoff_activity |
Cria uma instância da Activity classe como um objeto HandoffActivity. |
| create_invoke_activity |
Cria uma instância da Activity classe como um objeto InvokeActivity. |
| create_message_activity |
Cria uma instância da Activity classe como um objeto MessageActivity. |
| create_reply |
Cria uma nova atividade de mensagem como uma resposta a essa atividade. |
| create_trace |
Cria uma nova atividade de rastreamento com base nessa atividade. Padrão é o nome do tipo do valor. rótulo :p aram: opcional, um rótulo descritivo para esta operação de rastreamento. |
| create_trace_activity |
Cria uma instância da Activity classe como um objeto TraceActivity. Padrão é o nome do tipo do valor. rótulo :p aram: opcional, um rótulo descritivo para esta operação de rastreamento. |
| create_typing_activity |
Cria uma instância da Activity classe como um objeto TypingActivity. |
| get_conversation_reference |
Cria uma ConversationReference com base nessa atividade. |
| get_mentions |
Resolve as menções das entidades dessa atividade. |
| get_reply_conversation_reference |
Crie uma ConversationReference com base nas informações de conversa dessa atividade e no ResourceResponse do envio de uma atividade. |
| has_content |
Indica se essa atividade tem conteúdo. |
| is_from_streaming_connection |
Determine se a Atividade foi enviada por meio de uma conexão Http/Https ou streaming Isso pode ser determinado examinando a propriedade service_url: (1) Todos os canais que enviam mensagens por http/https não estão transmitindo (2) Canais que enviam mensagens por streaming têm um ServiceUrl que não começa com http/https. |
apply_conversation_reference
Atualizações essa atividade com as informações de entrega de uma ConversationReference existente
atividade de entrada, em que o bot é o destinatário; caso contrário, False. O padrão é False e a atividade mostrará o bot como o remetente.
apply_conversation_reference(reference: ConversationReference, is_incoming: bool = False)Parâmetros
| Nome | Description |
|---|---|
|
reference
Obrigatório
|
|
|
is_incoming
|
Valor padrão: False
|
Retornos
| Tipo | Description |
|---|---|
|
sua atividade, atualizada com as informações de entrega. |
Comentários
Chame GetConversationReference em uma atividade de entrada para obter uma referência de conversa que você pode usar para atualizar uma atividade de saída com as informações de entrega corretas.
as_contact_relation_update_activity
Retorna essa atividade como um objeto ContactRelationUpdateActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_contact_relation_update_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de mensagem; ou Nenhum. |
as_conversation_update_activity
Retorna essa atividade como um objeto ConversationUpdateActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_conversation_update_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de atualização de conversa; ou Nenhum. |
as_end_of_conversation_activity
Retorna essa atividade como um objeto EndOfConversationActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_end_of_conversation_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como um fim da atividade de conversa; ou Nenhum. |
as_event_activity
Retorna essa atividade como um objeto EventActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_event_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de evento; ou Nenhum. |
as_handoff_activity
Retorna essa atividade como um objeto HandoffActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_handoff_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de entrega; ou Nenhum. |
as_installation_update_activity
Retorna essa atividade como um objeto InstallationUpdateActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_installation_update_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de atualização de instalação; ou Nenhum. |
as_invoke_activity
Retorna essa atividade como um objeto InvokeActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_invoke_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de invocação; ou Nenhum. |
as_message_activity
Retorna essa atividade como um objeto MessageActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_message_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de mensagem; ou Nenhum. |
as_message_delete_activity
Retorna essa atividade como um objeto MessageDeleteActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_message_delete_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma solicitação de exclusão de mensagem; ou Nenhum. |
as_message_reaction_activity
Retorna essa atividade como um objeto MessageReactionActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_message_reaction_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de reação de mensagem; ou Nenhum. |
as_message_update_activity
Retorna essa atividade como um objeto MessageUpdateActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_message_update_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma solicitação de atualização de mensagem; ou Nenhum. |
as_suggestion_activity
Retorna essa atividade como um objeto SuggestionActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_suggestion_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de sugestão; ou Nenhum. |
as_trace_activity
Retorna essa atividade como um objeto TraceActivity; ou Nenhum, se esse não for esse tipo de atividade.
as_trace_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de rastreamento; ou Nenhum. |
as_typing_activity
Retorna essa atividade como um objeto TypingActivity; ou nulo, se esse não for esse tipo de atividade.
as_typing_activity()Retornos
| Tipo | Description |
|---|---|
|
Essa atividade como uma atividade de digitação; ou nulo. |
create_contact_relation_update_activity
Cria uma instância da Activity classe como um objetoContactRelationUpdateActivity.
static create_contact_relation_update_activity()Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de atualização de relação de contato. |
create_conversation_update_activity
Cria uma instância da Activity classe como um objeto ConversationUpdateActivity.
static create_conversation_update_activity()Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de atualização de conversa. |
create_end_of_conversation_activity
Cria uma instância da Activity classe como um objeto EndOfConversationActivity.
static create_end_of_conversation_activity()Retornos
| Tipo | Description |
|---|---|
|
O novo fim da atividade de conversa. |
create_event_activity
Cria uma instância da Activity classe como um objeto EventActivity.
static create_event_activity()Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de evento. |
create_handoff_activity
Cria uma instância da Activity classe como um objeto HandoffActivity.
static create_handoff_activity()Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de entrega. |
create_invoke_activity
Cria uma instância da Activity classe como um objeto InvokeActivity.
static create_invoke_activity()Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de invocação. |
create_message_activity
Cria uma instância da Activity classe como um objeto MessageActivity.
static create_message_activity()Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de mensagem. |
create_reply
Cria uma nova atividade de mensagem como uma resposta a essa atividade.
create_reply(text: str = None, locale: str = None)Parâmetros
| Nome | Description |
|---|---|
|
text
|
O texto da resposta. Valor padrão: None
|
|
locale
|
O código de idioma do texto. Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de mensagem. |
Comentários
A nova atividade configura informações de roteamento com base nessa atividade.
create_trace
Cria uma nova atividade de rastreamento com base nessa atividade.
Padrão é o nome do tipo do valor. rótulo :p aram: opcional, um rótulo descritivo para esta operação de rastreamento.
create_trace(name: str, value: object = None, value_type: str = None, label: str = None)Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
|
|
value
|
Valor padrão: None
|
|
value_type
|
Valor padrão: None
|
|
label
|
Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de rastreamento. |
create_trace_activity
Cria uma instância da Activity classe como um objeto TraceActivity.
Padrão é o nome do tipo do valor. rótulo :p aram: opcional, um rótulo descritivo para esta operação de rastreamento.
static create_trace_activity(name: str, value: object = None, value_type: str = None, label: str = None)Parâmetros
| Nome | Description |
|---|---|
|
name
Obrigatório
|
|
|
value
|
Valor padrão: None
|
|
value_type
|
Valor padrão: None
|
|
label
|
Valor padrão: None
|
Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de rastreamento. |
create_typing_activity
Cria uma instância da Activity classe como um objeto TypingActivity.
static create_typing_activity()Retornos
| Tipo | Description |
|---|---|
|
A nova atividade de digitação. |
get_conversation_reference
Cria uma ConversationReference com base nessa atividade.
get_conversation_reference()Retornos
| Tipo | Description |
|---|---|
|
Uma referência de conversa para a conversa que contém essa atividade. |
get_mentions
Resolve as menções das entidades dessa atividade.
get_mentions() -> List[Mention]Retornos
| Tipo | Description |
|---|---|
|
A matriz de menções; ou uma matriz vazia, se nenhuma for encontrada. |
Comentários
Esse método é definido na Activity classe , mas destina-se apenas ao uso com uma atividade de mensagem, em que a atividade Activity.Type é definida como ActivityTypes.Message.
get_reply_conversation_reference
Crie uma ConversationReference com base nas informações de conversa dessa atividade e no ResourceResponse do envio de uma atividade.
get_reply_conversation_reference(reply: ResourceResponse) -> ConversationReferenceParâmetros
| Nome | Description |
|---|---|
|
reply
Obrigatório
|
ResourceResponse retornado de send_activity. |
Retornos
| Tipo | Description |
|---|---|
|
Uma ConversationReference que pode ser armazenada e usada posteriormente para excluir ou atualizar a atividade. |
has_content
Indica se essa atividade tem conteúdo.
has_content() -> boolRetornos
| Tipo | Description |
|---|---|
|
True, se essa atividade tiver algum conteúdo a ser enviado; caso contrário, false. |
Comentários
Esse método é definido na Activity classe , mas destina-se apenas ao uso com uma atividade de mensagem, em que a atividade Activity.Type é definida como ActivityTypes.Message.
is_from_streaming_connection
Determine se a Atividade foi enviada por meio de uma conexão Http/Https ou streaming Isso pode ser determinado examinando a propriedade service_url: (1) Todos os canais que enviam mensagens por http/https não estão transmitindo (2) Canais que enviam mensagens por streaming têm um ServiceUrl que não começa com http/https.
is_from_streaming_connection() -> boolRetornos
| Tipo | Description |
|---|---|
|
True se a Atividade se originou de uma conexão de streaming. |