Activity Classe

Definição

Espaço de Nomes:: Microsoft.Bot.Schema

Assemblagem:: Microsoft.Bot.Schema.dll

Pacote:: Microsoft.Bot.Schema v4.22.7

Importante

Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.

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

Observações

A classe Activity contém todas as propriedades que atividades individuais e mais específicas poderiam conter. É um tipo de superset.

Construtores

Name	Descrição
Activity()	Inicializa uma nova instância da Activity classe.
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 Activity classe.

Name

Descrição

Activity()

Inicializa uma nova instância da Activity classe.

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 Activity classe.

Campos

Name	Descrição
ContentType	O cabeçalho da entidade HTTP `Content-Type` que identifica um Activity recurso de tipo de media.

Propriedades

Name	Descrição
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 para a atividade.
CallerId	Obtém ou define uma cadeia de caracteres contendo um IRI que identifica o chamador de um bot. Este campo não se destina a ser transmitido através do fio, mas é preenchido por bots e clientes com base em dados criptograficamente verificáveis que afirmam a identidade dos chamadores (por exemplo, tokens).
ChannelData	Obtém ou define 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 indica 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 ao destinatário caminhos de entrega alternativos 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 que foram mencionadas na mensagem.
Expiration	Obtém ou define o momento em que a atividade deve ser considerada "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 um 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	Recebe ou define uma cadeia que indica se o seu bot está a aceitar, esperar ou ignorar a entrada do utilizador após a mensagem ser entregue ao cliente (ver InputHints.
Label	Obtém ou define um rótulo descritivo para a atividade.
ListenFor	Obtém ou define uma lista de frases e referências que os sistemas de preparação de fala e linguagem devem ouvir.
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, em hora 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, expresso 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 chamada ou evento.
Properties	Obtém ou define propriedades que não são definidas pelo Activity tipo, mas que podem aparecer no objeto JSON REST 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	Recebe ou define outra ConversationReference conversa ou atividade.
ReplyToId	Obtém ou define a ID da mensagem para a qual esta 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 para falar.
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 de 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 para realçar 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

Name	Descrição
ApplyConversationReference(ConversationReference, Boolean)	Atualiza esta atividade com a informação de entrega de um .ConversationReference
AsCommandActivity()	Devolve esta atividade como um ICommandActivity objeto; ou nulo, se não for esse tipo de atividade.
AsCommandResultActivity()	Devolve esta atividade como um ICommandResultActivity objeto; ou nulo, se não for esse tipo de atividade.
AsContactRelationUpdateActivity()	Devolve esta atividade como um IContactRelationUpdateActivity objeto; ou nulo, se não for esse tipo de atividade.
AsConversationUpdateActivity()	Devolve esta atividade como um IConversationUpdateActivity objeto; ou nulo, se não for esse tipo de atividade.
AsEndOfConversationActivity()	Devolve esta atividade como um IEndOfConversationActivity objeto; ou nulo, se não for esse tipo de atividade.
AsEventActivity()	Devolve esta atividade como um IEventActivity objeto; ou nulo, se não for esse tipo de atividade.
AsHandoffActivity()	Devolve esta atividade como um IHandoffActivity objeto; ou nulo, se não for esse tipo de atividade.
AsInstallationUpdateActivity()	Devolve esta atividade como um IInstallationUpdateActivity objeto; ou nulo, se não for esse tipo de atividade.
AsInvokeActivity()	Devolve esta atividade como um IInvokeActivity objeto; ou nulo, se não for esse tipo de atividade.
AsMessageActivity()	Devolve esta atividade como um IMessageActivity objeto; ou nulo, se não for esse tipo de atividade.
AsMessageDeleteActivity()	Devolve esta atividade como um IMessageDeleteActivity objeto; ou nulo, se não for esse tipo de atividade.
AsMessageReactionActivity()	Devolve esta atividade como um IMessageReactionActivity objeto; ou nulo, se não for esse tipo de atividade.
AsMessageUpdateActivity()	Devolve esta atividade como um IMessageUpdateActivity objeto; ou nulo, se não for esse tipo de atividade.
AsSuggestionActivity()	Devolve esta atividade como um ISuggestionActivity objeto; ou nulo, se não for esse tipo de atividade.
AsTraceActivity()	Devolve esta atividade como um ITraceActivity objeto; ou nulo, se não for esse tipo de atividade.
AsTypingActivity()	Devolve esta atividade como um ITypingActivity objeto; ou nulo, se não for esse tipo de atividade.
CreateContactRelationUpdateActivity()	Cria uma instância da Activity classe como um IContactRelationUpdateActivity objeto.
CreateConversationUpdateActivity()	Cria uma instância da Activity classe como um IConversationUpdateActivity objeto.
CreateEndOfConversationActivity()	Cria uma instância da Activity classe como um IEndOfConversationActivity objeto.
CreateEventActivity()	Cria uma instância da Activity classe como um IEventActivity objeto.
CreateHandoffActivity()	Cria uma instância da Activity classe como um IHandoffActivity objeto.
CreateInvokeActivity()	Cria uma instância da Activity classe como um IInvokeActivity objeto.
CreateMessageActivity()	Cria uma instância da Activity classe como um IMessageActivity objeto.
CreateReply(String, String)	Cria uma nova atividade de mensagem como 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 Activity classe como um ITraceActivity objeto.
CreateTypingActivity()	Cria uma instância da Activity classe como um ITypingActivity objeto.
GetChannelData<TypeT>()	Obtém os dados do canal para essa atividade como um objeto fortemente tipado.
GetConversationReference()	Cria um ConversationReference baseado nesta atividade.
GetMentions()	Resolve as menções das entidades desta atividade.
GetReplyConversationReference(ResourceResponse)	Crie uma ConversationReference com base nas informações de Conversação desta Atividade e na ResourceResponse do envio de 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 observando a propriedade ServiceUrl: (1) Todos os canais que enviam mensagens via http/https não são streaming (2) Os canais que enviam mensagens via streaming têm um ServiceUrl que não começa com http/https.
TryGetChannelData<TypeT>(TypeT)	Obtém os dados do canal para essa atividade como um objeto fortemente tipado. Um valor de retorno determina se a operação foi bem-sucedida.

Métodos da Extensão

Name	Descrição
GetLocale(IActivity)	Obtém a localidade para a atividade.
MentionsId(IMessageActivity, String)	Há uma menção de Id na propriedade Text.
MentionsRecipient(IMessageActivity)	Há uma menção a 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, isto remove "@echoBot", ficando "Hi Bot".
RemoveRecipientMention(IMessageActivity)	Remova o texto da menção do destinatário da propriedade Text. Use com cuidado porque esta função está alterando o texto na Atividade.
SetLocale(IActivity, String)	Define a localidade da atividade.
TeamsGetChannelId(IActivity)	Obtém o ID do canal da Equipe da atividade atual.
TeamsGetMeetingInfo(IActivity)	Obtém o objeto TeamsMeetingInfo da atividade atual.
TeamsGetSelectedChannelId(IActivity)	Obtém o ID de canal selecionado da Equipe da atividade atual.
TeamsGetTeamInfo(IActivity)	Obtém o objeto TeamsInfo da atividade atual.
TeamsGetTeamOnBehalfOf(IActivity)	Obtém a lista Teams OnBehalfOf 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.

Aplica-se a