Activity Classe

Referência

Definição

Namespace:: Microsoft.Bot.Schema

Assembly:: Microsoft.Bot.Schema.dll

Pacote:: Microsoft.Bot.Schema v4.22.7

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Uma atividade é o tipo de comunicação básico para o protocolo Bot Framework 3.0.

public class Activity : Microsoft.Bot.Schema.ICommandActivity, Microsoft.Bot.Schema.ICommandResultActivity, Microsoft.Bot.Schema.IContactRelationUpdateActivity, Microsoft.Bot.Schema.IConversationUpdateActivity, Microsoft.Bot.Schema.IEndOfConversationActivity, Microsoft.Bot.Schema.IEventActivity, Microsoft.Bot.Schema.IHandoffActivity, Microsoft.Bot.Schema.IInstallationUpdateActivity, Microsoft.Bot.Schema.IInvokeActivity, Microsoft.Bot.Schema.IMessageDeleteActivity, Microsoft.Bot.Schema.IMessageReactionActivity, Microsoft.Bot.Schema.IMessageUpdateActivity, Microsoft.Bot.Schema.ISuggestionActivity, Microsoft.Bot.Schema.ITraceActivity, Microsoft.Bot.Schema.ITypingActivity

type Activity = class
    interface IActivity
    interface IConversationUpdateActivity
    interface IContactRelationUpdateActivity
    interface IInstallationUpdateActivity
    interface IMessageActivity
    interface IMessageUpdateActivity
    interface IMessageDeleteActivity
    interface IMessageReactionActivity
    interface ISuggestionActivity
    interface ITypingActivity
    interface IEndOfConversationActivity
    interface IEventActivity
    interface IInvokeActivity
    interface ITraceActivity
    interface IHandoffActivity
    interface ICommandActivity
    interface ICommandResultActivity

Public Class Activity
Implements ICommandActivity, ICommandResultActivity, IContactRelationUpdateActivity, IConversationUpdateActivity, IEndOfConversationActivity, IEventActivity, IHandoffActivity, IInstallationUpdateActivity, IInvokeActivity, IMessageDeleteActivity, IMessageReactionActivity, IMessageUpdateActivity, ISuggestionActivity, ITraceActivity, ITypingActivity

Herança: Object
Activity

Implementações: IActivity ICommandActivity ICommandResultActivity IContactRelationUpdateActivity IConversationUpdateActivity IEndOfConversationActivity IEventActivity IHandoffActivity IInstallationUpdateActivity IInvokeActivity IMessageActivity IMessageDeleteActivity IMessageReactionActivity IMessageUpdateActivity ISuggestionActivity ITraceActivity ITypingActivity

Comentários

A classe Atividade contém todas as propriedades que atividades individuais e mais específicas podem conter. É um tipo de superconjunto.

Construtores

Activity()

Inicializa uma nova instância da classe Activity.

Activity(String, String, Nullable<DateTimeOffset>, Nullable<DateTimeOffset>, String, String, ChannelAccount, ConversationAccount, ChannelAccount, String, String, IList<ChannelAccount>, IList<ChannelAccount>, IList<MessageReaction>, IList<MessageReaction>, String, Nullable<Boolean>, String, String, String, String, String, SuggestedActions, IList<Attachment>, IList<Entity>, Object, String, String, String, String, Object, String, ConversationReference, String, Nullable<DateTimeOffset>, String, String, IList<String>, IList<TextHighlight>, SemanticAction, String)

Inicializa uma nova instância da classe Activity.

Campos

ContentType

O cabeçalho de entidade Content-Type HTTP que identifica um recurso de tipo de mídia Activity.

Propriedades

Action	Obtém ou define uma cadeia de caracteres que indica se o destinatário de um contactRelationUpdate foi adicionado ou removido da lista de contatos do remetente.
AttachmentLayout	Obtém ou define a dica de layout para vários anexos. Padrão: lista. Os valores possíveis são definidos por AttachmentLayoutTypes.
Attachments	Obtém ou define os anexos da atividade.
CallerId	Obtém ou define uma cadeia de caracteres que contém uma IRI que identifica o chamador de um bot. Esse campo não se destina a ser transmitido pela transmissão, mas é preenchido por bots e clientes com base em dados criptograficamente verificáveis que declaram a identidade dos chamadores (por exemplo, tokens).
ChannelData	Obtém ou define o conteúdo específico do canal.
ChannelId	Obtém ou define uma ID que identifica exclusivamente o canal. Definido pelo canal.
Code	Obtém ou define um código para atividades endOfConversation que indicam por que a conversa terminou. Os valores possíveis são definidos em EndOfConversationCodes.
Conversation	Obtém ou define a conversa à qual a atividade pertence.
DeliveryMode	Obtém ou define uma dica de entrega para sinalizar para os caminhos de entrega alternativos do destinatário para a atividade. O modo de entrega padrão é "padrão". Os valores possíveis são definidos em DeliveryModes.
Entities	Obtém ou define as entidades mencionadas na mensagem.
Expiration	Obtém ou define o momento em que a atividade deve ser considerada como "expirada" e não deve ser apresentada ao destinatário.
From	Obtém ou define o remetente da mensagem.
HistoryDisclosed	Obtém ou define um valor que indica se o histórico anterior do canal é divulgado.
Id	Obtém ou define uma ID que identifica exclusivamente a atividade no canal.
Importance	Obtém ou define a importância da atividade. Os valores possíveis são definidos em ActivityImportance.
InputHint	Obtém ou define uma cadeia de caracteres que indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente (consulte InputHints.
Label	Obtém ou define um rótulo descritivo para a atividade.
ListenFor	Obtém ou define a lista de frases e referências que os sistemas de fala e de preparação de idiomas devem escutar.
Locale	Obtém ou define um nome de localidade BCP-47 para o conteúdo do campo de texto.
LocalTimestamp	Obtém ou define a data e a hora em que a mensagem foi enviada, no horário local, expressa no formato ISO-8601. Por exemplo, 2016-09-23T13:07:49.4714686-07:00.
LocalTimezone	Obtém ou define o nome do fuso horário usado para definir a hora local da mensagem, expressa no formato de banco de dados de Fuso Horário IANA. Por exemplo, América/Los_Angeles.
MembersAdded	Obtém ou define a coleção de membros adicionados à conversa.
MembersRemoved	Obtém ou define a coleção de membros removidos da conversa.
Name	Obtém ou define o nome da operação associada a uma atividade de invocação ou evento.
Properties	Obtém ou define propriedades que não são definidas de outra forma pelo tipo Activity, mas que podem aparecer no objeto REST JSON serializado.
ReactionsAdded	Obtém ou define a coleção de reações adicionadas à conversa.
ReactionsRemoved	Obtém ou define a coleção de reações removidas da conversa.
Recipient	Obtém ou define o destinatário da mensagem.
RelatesTo	Obtém ou define um ConversationReference para outra conversa ou atividade.
ReplyToId	Obtém ou define a ID da mensagem à qual essa mensagem é uma resposta.
SemanticAction	Obtém ou define uma ação programática opcional que acompanha essa solicitação.
ServiceUrl	Obtém ou define a URL que especifica o ponto de extremidade de serviço do canal. Definido pelo canal.
Speak	Obtém ou define o texto a ser falado.
SuggestedActions	Obtém ou define as ações sugeridas para a atividade.
Summary	Obtém ou define o texto a ser exibido se o canal não puder renderizar cartões.
Text	Obtém ou define o conteúdo do texto da mensagem.
TextFormat	Obtém ou define o formato dos campos de texto. Padrão: markdown. Os valores possíveis são definidos por TextFormatTypes.
TextHighlights	Obtém ou define a coleção de fragmentos de texto a serem realçados quando a atividade contém um valor ReplyToId.
Timestamp	Obtém ou define a data e a hora em que a mensagem foi enviada, em UTC, expressa no formato ISO-8601.
TopicName	Obtém ou define o nome do tópico atualizado da conversa.
Type	Obtém ou define o tipo de atividade. Os valores possíveis incluem: 'message', 'contactRelationUpdate', 'conversationUpdate', 'typing', 'endOfConversation', 'event', 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate', 'messageReaction', 'suggestion', 'trace', 'handoff'.
Value	Obtém ou define um valor associado à atividade.
ValueType	Obtém ou define o tipo do objeto de valor da atividade.

Métodos

ApplyConversationReference(ConversationReference, Boolean)	Atualiza essa atividade com as informações de entrega de um ConversationReferenceexistente.
AsCommandActivity()	Retorna essa atividade como um objeto ICommandActivity; ou nulo, se esse não for esse tipo de atividade.
AsCommandResultActivity()	Retorna essa atividade como um objeto ICommandResultActivity; ou nulo, se esse não for esse tipo de atividade.
AsContactRelationUpdateActivity()	Retorna essa atividade como um objeto IContactRelationUpdateActivity; ou nulo, se esse não for esse tipo de atividade.
AsConversationUpdateActivity()	Retorna essa atividade como um objeto IConversationUpdateActivity; ou nulo, se esse não for esse tipo de atividade.
AsEndOfConversationActivity()	Retorna essa atividade como um objeto IEndOfConversationActivity; ou nulo, se esse não for esse tipo de atividade.
AsEventActivity()	Retorna essa atividade como um objeto IEventActivity; ou nulo, se esse não for esse tipo de atividade.
AsHandoffActivity()	Retorna essa atividade como um objeto IHandoffActivity; ou nulo, se esse não for esse tipo de atividade.
AsInstallationUpdateActivity()	Retorna essa atividade como um objeto IInstallationUpdateActivity; ou nulo, se esse não for esse tipo de atividade.
AsInvokeActivity()	Retorna essa atividade como um objeto IInvokeActivity; ou nulo, se esse não for esse tipo de atividade.
AsMessageActivity()	Retorna essa atividade como um objeto IMessageActivity; ou nulo, se esse não for esse tipo de atividade.
AsMessageDeleteActivity()	Retorna essa atividade como um objeto IMessageDeleteActivity; ou nulo, se esse não for esse tipo de atividade.
AsMessageReactionActivity()	Retorna essa atividade como um objeto IMessageReactionActivity; ou nulo, se esse não for esse tipo de atividade.
AsMessageUpdateActivity()	Retorna essa atividade como um objeto IMessageUpdateActivity; ou nulo, se esse não for esse tipo de atividade.
AsSuggestionActivity()	Retorna essa atividade como um objeto ISuggestionActivity; ou nulo, se esse não for esse tipo de atividade.
AsTraceActivity()	Retorna essa atividade como um objeto ITraceActivity; ou nulo, se esse não for esse tipo de atividade.
AsTypingActivity()	Retorna essa atividade como um objeto ITypingActivity; ou nulo, se esse não for esse tipo de atividade.
CreateContactRelationUpdateActivity()	Cria uma instância da classe Activity como um objeto IContactRelationUpdateActivity.
CreateConversationUpdateActivity()	Cria uma instância da classe Activity como um objeto IConversationUpdateActivity.
CreateEndOfConversationActivity()	Cria uma instância da classe Activity como um objeto IEndOfConversationActivity.
CreateEventActivity()	Cria uma instância da classe Activity como um objeto IEventActivity.
CreateHandoffActivity()	Cria uma instância da classe Activity como um objeto IHandoffActivity.
CreateInvokeActivity()	Cria uma instância da classe Activity como um objeto IInvokeActivity.
CreateMessageActivity()	Cria uma instância da classe Activity como um objeto IMessageActivity.
CreateReply(String, String)	Cria uma nova atividade de mensagem como uma resposta a essa atividade.
CreateTrace(String, Object, String, String)	Cria uma nova atividade de rastreamento com base nessa atividade.
CreateTraceActivity(String, String, Object, String)	Cria uma instância da classe Activity como um objeto ITraceActivity.
CreateTypingActivity()	Cria uma instância da classe Activity como um objeto ITypingActivity.
GetChannelData<TypeT>()	Obtém os dados de canal dessa atividade como um objeto fortemente tipado.
GetConversationReference()	Cria um ConversationReference com base nessa atividade.
GetMentions()	Resolve as menções das entidades dessa atividade.
GetReplyConversationReference(ResourceResponse)	Crie uma ConversationReference com base nas informações de conversa dessa atividade e no ResourceResponse enviando uma atividade.
HasContent()	Indica se essa atividade tem conteúdo.
IsActivity(String)	Indica se essa atividade é de um tipo de atividade especificado.
IsFromStreamingConnection()	Determine se a atividade foi enviada por meio de uma conexão Http/Https ou streaming Isso pode ser determinado examinando a propriedade ServiceUrl: (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.
TryGetChannelData<TypeT>(TypeT)	Obtém os dados de canal dessa atividade como um objeto fortemente tipado. Um valor retornado indica se a operação foi bem-sucedida.

Métodos de Extensão

TeamsGetChannelId(IActivity)	Obtém a ID do canal da equipe da atividade atual.
TeamsGetMeetingInfo(IActivity)	Obtém o objeto TeamsMeetingInfo da atividade atual.
TeamsGetSelectedChannelId(IActivity)	Obtém a ID de canal selecionada da equipe da atividade atual.
TeamsGetTeamInfo(IActivity)	Obtém o objeto TeamsInfo da atividade atual.
TeamsGetTeamOnBehalfOf(IActivity)	Obtém a lista OnBehalfOf do Teams da atividade atual.
TeamsNotifyUser(IActivity, Boolean, String)	Configura a atividade atual para gerar uma notificação no Teams.
TeamsNotifyUser(IActivity)	Configura a atividade atual para gerar uma notificação no Teams.
MentionsId(IMessageActivity, String)	Há uma menção de ID na propriedade Text.
MentionsRecipient(IMessageActivity)	Há uma menção de Recipient.Id na propriedade Text.
RemoveMentionText(IMessageActivity, String)	Remova qualquer texto de menção para determinada ID da propriedade Activity.Text. Por exemplo, dada a mensagem @echoBot Hi Bot, isso removerá "@echoBot", deixando "Oi Bot".
RemoveRecipientMention(IMessageActivity)	Remova o texto de menção do destinatário da propriedade Text. Use com cuidado porque essa função está alterando o texto na Atividade.
GetLocale(IActivity)	Obtém a localidade da atividade.
SetLocale(IActivity, String)	Define a localidade da atividade.

Aplica-se a

Compartilhar via