Activity Classe

Pacote:

com.microsoft.bot.schema

Artefato Maven:

com.microsoft.bot:bot-schema:4.14.3

• java.lang.Object
• • com.microsoft.bot.schema.Activity

public class Activity

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

Resumo do Construtor

Modificador	Construtor	Description
protected	Activity()	Construtor padrão.
	Activity(String withType)	Construa uma atividade do tipo especificado.

Resumo do método

Modificador e tipo	Método e descrição
TypeT	<TypeT>getChannelData(Class<TypeT> classType) Obter dados dede canal como estrutura tipada.
ResultPair<TypeT>	<TypeT>tryGetChannelData(Class<TypeT> clsType) Obter dados dede canal como estrutura tipada.
final Activity	applyConversationReference(ConversationReference reference) Atualiza essa atividade com as informações de entrega de saída de um ConversationReferenceexistente.
final Activity	applyConversationReference(ConversationReference reference, boolean isIncoming) Atualiza essa atividade com as informações de entrega de um ConversationReferenceexistente.
static Activity	clone(Activity activity) Clone uma atividade.
static Activity	createContactRelationUpdateActivity() Criar uma atividade do tipo CONTACT_RELATION_UPDATE.
static Activity	createConversationUpdateActivity() Criar uma atividade do tipo CONVERSATION_UPDATE.
static Activity	createEndOfConversationActivity() Cria um tipo END_OF_CONVERSATION de Atividade.
static Activity	createEventActivity() Cria um tipo EVENT de Atividade.
static Activity	createHandoffActivity() Cria uma atividade do tipo HANDOFF.
static Activity	createInvokeActivity() Cria um tipo INVOKE de Atividade.
static Activity	createMessageActivity() Criar uma atividade de tipo MESSAGE.
Activity	createReply() Cria uma nova atividade de mensagem como uma resposta a essa atividade.
Activity	createReply(String withText) Cria uma nova atividade de mensagem como uma resposta a essa atividade.
Activity	createReply(String withText, String withLocale) Cria uma nova atividade de mensagem como uma resposta a essa atividade.
Activity	createTrace(String withName) Cria uma instância da classe Atividade como tipo TRACE.
Activity	createTrace(String withName, Object withValue, String withValueType, String withLabel) Cria uma instância da classe Atividade como tipo TRACE.
static Activity	createTraceActivity(String withName) Criar uma atividade de tipo TRACE.
static Activity	createTraceActivity(String withName, String withValueType, Object withValue, String withLabel) Criar uma atividade de tipo TRACE.
static Activity	createTypingActivity() Cria uma atividade do tipo TYPING.
java.lang.String	getAction() Indica se o destinatário de um contatoRelationUpdate foi adicionado ou removido da lista de contatos do remetente.
AttachmentLayoutTypes	getAttachmentLayout() A dica de layout para vários anexos.
java.util.List<Attachment>	getAttachments() Obtém os anexos para a Atividade.
java.lang.String	getCallerId() Obtém uma cadeia de caracteres que contém uma IRI que identifica o chamador de um bot.
java.lang.Object	getChannelData() Obtém conteúdo específico do canal.
java.lang.String	getChannelId() Obtém a ID que identifica exclusivamente o canal.
EndOfConversationCodes	getCode() Obtém o código para atividades de fimOfConversation que indica por que a conversa terminou.
ConversationAccount	getConversation() Identifica a conversa à qual a atividade pertence.
ConversationReference	getConversationReference() Cria um ConversationReference com base nessa atividade.
java.lang.String	getDeliveryMode() Uma dica de entrega para sinalizar para os caminhos de entrega alternativos do destinatário para a atividade.
java.util.List<Entity>	getEntities() Retorna a versão de conteúdo das Entidades em uma Atividade.
java.time.LocalDateTime	getExpiration() Obtém o tempo em que a atividade deve ser considerada expirada e não deve ser apresentada ao destinatário.
ChannelAccount	getFrom() Identifica o remetente da mensagem.
boolean	getHistoryDisclosed() Obtém se o histórico anterior do canal é divulgado.
java.lang.String	getId() Retorna a ID que identifica exclusivamente a atividade no canal.
java.lang.String	getImportance() Obtém a importância da atividade.
InputHints	getInputHint() Indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente.
java.lang.String	getLabel() Obtém o rótulo descritivo para a atividade.
java.util.List<java.lang.String>	getListenFor() Obtém a lista de frases e referências que os sistemas de preparação de fala e idioma devem escutar.
java.time.OffsetDateTime	getLocalTimestamp() Obtém a data e a hora locais da mensagem, expressa no formato ISO-8601.
java.lang.String	getLocalTimezone() Obtém o nome do fuso horário local da mensagem, expresso no formato de banco de dados de fuso horário IANA.
java.lang.String	getLocale() Um nome de localidade para o conteúdo do campo de texto.
java.util.List<ChannelAccount>	getMembersAdded() Obtém a coleção de membros adicionada à conversa.
java.util.List<ChannelAccount>	getMembersRemoved() Obtém a coleção de membros removidos da conversa.
java.util.List<Mention>	getMentions() Resolve as menções das entidades dessa atividade.
java.lang.String	getName() Obtém o nome da operação associada a uma atividade de invocação ou evento.
java.util.Map<java.lang.String,com.fasterxml.jackson.databind.JsonNode>	getProperties() Contém as propriedades de estouro que não são propriedades de primeira classe no objeto.
java.util.List<MessageReaction>	getReactionsAdded() Obtém a coleção de reações adicionadas à conversa.
java.util.List<MessageReaction>	getReactionsRemoved() Obtém a coleção de reações removidas da conversa.
ChannelAccount	getRecipient() Identifica o destinatário da mensagem.
ConversationReference	getRelatesTo() Uma referência a outra conversa ou atividade.
ConversationReference	getReplyConversationReference(ResourceResponse reply) Crie uma referência dede conversa com base nas informações de conversa dessa atividade e na resposta do resourcede enviar uma atividade.
java.lang.String	getReplyToId() Obtém a ID da mensagem à qual essa mensagem é uma resposta.
java.lang.String	getServiceUrl() Define a URL que especifica o ponto de extremidade de serviço do canal.
java.lang.String	getSpeak() O texto a ser falado.
SuggestedActions	getSuggestedActions() Obtém as ações sugeridas para a atividade.
java.lang.String	getSummary() Obtém o texto a ser exibido se o canal não puder renderizar cartões.
java.lang.String	getText() Obtém o conteúdo de texto da mensagem.
TextFormatTypes	getTextFormat() Formato dos campos de texto Padrão:markdown.
java.util.List<TextHighlight>	getTextHighlights() Obtém a coleção de fragmentos de texto a serem realçados quando a atividade contiver um valor de RespostaToId.
java.time.OffsetDateTime	getTimestamp() Obtém a data e a hora em que a mensagem foi enviada, em UTC, expressa no formato ISO-8601.
java.lang.String	getTopicName() Obtém o nome do tópico atualizado da conversa.
java.lang.String	getType() Obtém o ActivityTypes da atividade.
java.lang.Object	getValue() Obtém o valor associado à atividade.
java.lang.String	getValueType() Obtém o tipo do objeto de valor da atividade.
boolean	hasContent() Verifica se essa atividade (mensagem) tem conteúdo.
protected boolean	isActivity(String activityType) True se a Atividade for do tipo de atividade especificado.
java.lang.Boolean	isFromStreamingConnection() Determina se a atividade foi enviada por meio de uma conexão Http/Https ou streaming Isso pode ser determinado examinando a propriedade url do serviço: (1) Todos os canais que enviam mensagens por http/https não são streaming (2) Canais que enviam mensagens por streaming têm uma Url dede Serviço que não começa com http/https.
boolean	isTeamsActivity() Verifique se essa actvidade é do Microsoft Teams.
boolean	isType(String compareTo) Método de conveniência a ser retornado se a Atividade for do tipo especificado.
java.lang.String	removeMentionText(String withId) Remova qualquer texto de menção para determinada ID da Atividade. propriedadeText.
static java.lang.String	removeMentionTextImmutable(Activity activity, String id) Remove a menção da Atividade.Texto sem modificar a Atividade.
java.lang.String	removeRecipientMention() Remova o texto de menção do destinatário da propriedade Text.
static java.lang.String	removeRecipientMentionImmutable(Activity activity) Remove a menção do destinatário sem modificar a Atividade.
void	setAction(String withAction) Indica se o destinatário de um contatoRelationUpdate foi adicionado ou removido da lista de contatos do remetente.
void	setAttachment(Attachment withAttachment) Define um único anexo na Atividade.
void	setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout) Define a dica de layout para vários anexos.
void	setAttachments(List<Attachment> withAttachments) Define os anexos para a Atividade.
void	setCallerId(String withCallerId) Define a IRI que identifica o chamador de um bot.
void	setChannelData(Object withChannelData) Define o conteúdo específico do canal.
void	setChannelId(String withChannelId) Define a ID que identifica exclusivamente o canal.
void	setCode(EndOfConversationCodes withCode) Define o código para atividades de fimOfConversation que indica por que a conversa terminou.
void	setConversation(ConversationAccount withConversation) Identifica a conversa à qual a atividade pertence.
void	setDeliveryMode(String withDeliveryMode) Uma dica de entrega para sinalizar para os caminhos de entrega alternativos do destinatário para a atividade.
void	setEntities(List<Entity> withEntities) Define a versão de conteúdo das Entidades em uma Atividade.
void	setExpiration(LocalDateTime withExpiration) Define o momento em que a atividade deve ser considerada expirada e não deve ser apresentada ao destinatário.
void	setFrom(ChannelAccount withFrom) Identifica o remetente da mensagem.
void	setHistoryDisclosed(boolean withHistoryDisclosed) Define se o histórico anterior do canal é divulgado.
void	setId(String withId) Define a ID que identifica exclusivamente a atividade no canal.
void	setImportance(String withImportance) Define a importância da atividade.
void	setInputHint(InputHints withInputHint) Indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente.
void	setLabel(String withLabel) Define o rótulo descritivo para a atividade.
void	setListenFor(List<String> withListenFor) Define a lista de frases e referências que os sistemas de preparação de fala e idioma devem escutar.
void	setLocalTimeZone(String withLocalTimezone) Define o nome do fuso horário local da mensagem, expresso no formato de banco de dados de fuso horário IANA.
void	setLocalTimestamp(OffsetDateTime withLocalTimestamp) Contém a data e a hora locais da mensagem, expressa no formato ISO-8601.
void	setLocale(String withLocale) Um nome de localidade para o conteúdo do campo de texto.
void	setMembersAdded(List<ChannelAccount> withMembersAdded) Define a coleção de membros adicionados à conversa.
void	setMembersRemoved(List<ChannelAccount> withMembersRemoved) Define a coleção de membros removidos da conversa.
void	setMentions(List<Mention> withMentions) Define a versão de conteúdo das Menções em uma Atividade.
void	setName(String withName) Define o nome da operação associada a uma atividade de invocação ou evento.
void	setProperties(String key, JsonNode withValue) Contém as propriedades de estouro que não são propriedades de primeira classe no objeto.
void	setReactionsAdded(List<MessageReaction> withReactionsAdded) Define a coleção de reações adicionadas à conversa.
void	setReactionsRemoved(List<MessageReaction> withReactionsRemoved) Define a coleção de reações removidas da conversa.
void	setRecipient(ChannelAccount withRecipient) Identifica o destinatário da mensagem.
void	setRelatesTo(ConversationReference withRelatesTo) Uma referência a outra conversa ou atividade.
void	setReplyToId(String withReplyToId) Define a ID da mensagem à qual essa mensagem é uma resposta.
void	setServiceUrl(String withServiceUrl) Define a URL que especifica o ponto de extremidade de serviço do canal.
void	setSpeak(String withSpeak) Define o texto a ser falado.
void	setSuggestedActions(SuggestedActions withSuggestedActions) As ações sugeridas para a atividade.
void	setSummary(String withSummary) Define o texto a ser exibido se o canal não puder renderizar cartões.
void	setText(String withText) Define o conteúdo do texto da mensagem.
void	setTextFormat(TextFormatTypes withTextFormat) Formato de campos de texto.
void	setTextHighlights(List<TextHighlight> withTextHighlights) Define a coleção de fragmentos de texto a serem realçados quando a atividade contiver um valor de RespostaToId.
void	setTimestamp(OffsetDateTime withTimestamp) Define a data e a hora em que a mensagem foi enviada, em UTC, expressa no formato ISO-8601.
void	setTopicName(String withTopicName) Define o nome do tópico atualizado da conversa.
void	setType(String withType) Define o ActivityTypes da atividade.
void	setValue(Object withValue) Define o valor associado à atividade.
void	setValueType(String withValueType) Define o tipo do objeto de valor da atividade.
TeamsChannelData	teamsGetChannelData() Obtém os dados dede canal do Teams.
java.lang.String	teamsGetChannelId() Obtenha um identificador exclusivo que representa um canal.
TeamsMeetingInfo	teamsGetMeetingInfo() Obtém o objeto TeamsMeetingInfo da atividade atual.
java.lang.String	teamsGetTeamId() Obtenha um identificador exclusivo que representa uma equipe.
TeamInfo	teamsGetTeamInfo() Obtenha dados de informações deda equipe do Teams.
void	teamsNotifyUser() Define o valor da notificação no TeamsChannelData como true.
void	teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl) Define a notificação de uma reunião no TeamsChannelData.

Métodos herdados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalhes do construtor

Activity

protected Activity()

Construtor padrão. Normalmente, isso não seria usado, pois o ActivityType normalmente é necessário.

Activity

public Activity(String withType)

Construa uma atividade do tipo especificado.

Parâmetros:

withType - O tipo de atividade.

Detalhes do método

<TypeT>getChannelData

public TypeT getChannelData(Class classType)

Obter channelData como estrutura tipada.

Parâmetros:

classType - Classe de TypeT a ser usada

Retornos:

typed Object or default(TypeT)

Gera:

com.fasterxml.jackson.core.JsonProcessingException - Se os dados do canal não puderem ser convertidos em TypeT.

<TypeT>tryGetChannelData

public ResultPair tryGetChannelData(Class clsType)

Obter channelData como estrutura tipada.

Parâmetros:

clsType - Classe de TypeT a ser usada

Retornos:

ChannelData como TypeT

applyConversationReference

public final Activity applyConversationReference(ConversationReference reference)

Atualiza essa atividade com as informações de entrega de saída de um ConversationReferenceexistente.

Parâmetros:

reference - A referência de conversa existente.

Retornos:

Essa atividade, atualizada com as informações de entrega.

applyConversationReference

public final Activity applyConversationReference(ConversationReference reference, boolean isIncoming)

Atualiza essa atividade com as informações de entrega de um ConversationReferenceexistente. 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.

Parâmetros:

reference - A referência de conversa existente.

isIncoming - true para tratar a atividade como uma atividade de entrada, em que o bot é o destinatário; caso contrário, false.

Retornos:

Essa atividade, atualizada com as informações de entrega.

clone

public static Activity clone(Activity activity)

Clone uma atividade.

Parâmetros:

activity - A atividade a ser clonada.

Retornos:

nova atividade clonada

createContactRelationUpdateActivity

public static Activity createContactRelationUpdateActivity()

Criar uma atividade do tipo CONTACT_RELATION_UPDATE.

Retornos:

Uma atividade de tipo de atualização de relação de contato.

createConversationUpdateActivity

public static Activity createConversationUpdateActivity()

Criar uma atividade do tipo CONVERSATION_UPDATE.

Retornos:

Uma atividade de tipo de atualização de conversa.

createEndOfConversationActivity

public static Activity createEndOfConversationActivity()

Cria um tipo END_OF_CONVERSATION de Atividade.

Retornos:

O novo fim da atividade de conversa.

createEventActivity

public static Activity createEventActivity()

Cria um tipo EVENT de Atividade.

Retornos:

A nova atividade de evento.

createHandoffActivity

public static Activity createHandoffActivity()

Cria uma atividade do tipo HANDOFF.

Retornos:

A nova atividade de entrega.

createInvokeActivity

public static Activity createInvokeActivity()

Cria um tipo INVOKE de Atividade.

Retornos:

A nova atividade de invocação.

createMessageActivity

public static Activity createMessageActivity()

Criar uma atividade de tipo MESSAGE.

Retornos:

Um tipo de atividade de mensagem.

createReply

public Activity createReply()

Cria uma nova atividade de mensagem como uma resposta a essa atividade.

Retornos:

A nova atividade de mensagem.

createReply

public Activity createReply(String withText)

Cria uma nova atividade de mensagem como uma resposta a essa atividade. Essa sobrecarga usa a Localidade desta Atividade.

Parâmetros:

withText - O texto da resposta.

Retornos:

A nova atividade de mensagem.

createReply

public Activity createReply(String withText, String withLocale)

Cria uma nova atividade de mensagem como uma resposta a essa atividade.

Parâmetros:

withText - O texto da resposta.

withLocale - O código de idioma do texto.

Retornos:

A nova atividade de mensagem.

createTrace

public Activity createTrace(String withName)

Cria uma instância da classe Atividade como tipo TRACE.

Parâmetros:

withName - O nome da operação de rastreamento a ser criada.

Retornos:

A nova atividade de rastreamento.

createTrace

public Activity createTrace(String withName, Object withValue, String withValueType, String withLabel)

Cria uma instância da classe Atividade como tipo TRACE.

Parâmetros:

withName - O nome da operação de rastreamento a ser criada.

withValue - Opcional, o conteúdo dessa operação de rastreamento.

withValueType - Opcional, identificador para o formato de withValue. O padrão é o nome do tipo do withValue.

withLabel - Opcional, um rótulo descritivo para esta operação de rastreamento.

Retornos:

A nova atividade de rastreamento.

createTraceActivity

public static Activity createTraceActivity(String withName)

Criar uma atividade de tipo TRACE.

Parâmetros:

withName - Nome da operação

Retornos:

Uma atividade de tipo de rastreamento.

createTraceActivity

public static Activity createTraceActivity(String withName, String withValueType, Object withValue, String withLabel)

Criar uma atividade de tipo TRACE.

Parâmetros:

withName - Nome da operação

withValueType - valueType se útil para identificar o esquema de valor (o padrão é o valor. GetType(). Nome)

withValue - O conteúdo dessa operação de rastreamento.

withLabel - Um rótulo descritivo para esta operação de rastreamento.

Retornos:

Uma atividade de tipo de rastreamento.

createTypingActivity

public static Activity createTypingActivity()

Cria uma atividade do tipo TYPING.

Retornos:

A nova atividade de digitação.

getAction

public String getAction()

Indica se o destinatário de um contactRelationUpdate foi adicionado ou removido da lista de contatos do remetente.

Retornos:

Ação do destinatário.

getAttachmentLayout

public AttachmentLayoutTypes getAttachmentLayout()

A dica de layout para vários anexos.

Retornos:

O tipo anexo.

getAttachments

public List getAttachments()

Obtém os anexos para a Atividade.

Retornos:

Uma lista de Attachment.

getCallerId

public String getCallerId()

Obtém 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).

Retornos:

A IRI do chamador.

getChannelData

public Object getChannelData()

Obtém conteúdo específico do canal.

Retornos:

Canalize dados específicos.

getChannelId

public String getChannelId()

Obtém a ID que identifica exclusivamente o canal. Definido pelo canal.

Retornos:

A ID do canal.

getCode

public EndOfConversationCodes getCode()

Obtém o código para atividades endOfConversation que indica por que a conversa terminou.

Retornos:

O código endOfConversation.

getConversation

public ConversationAccount getConversation()

Identifica a conversa à qual a atividade pertence.

Retornos:

O ConversationAccount.

getConversationReference

public ConversationReference getConversationReference()

Cria um ConversationReference com base nessa atividade.

Retornos:

Uma referência de conversa para a conversa que contém essa atividade.

getDeliveryMode

public String getDeliveryMode()

Uma dica de entrega para sinalizar para os caminhos de entrega alternativos do destinatário para a atividade.

O modo de entrega padrão é \"default\". Consulte DeliveryModes.

Retornos:

A dica do modo de entrega.

getEntities

public List getEntities()

Retorna a versão de conteúdo das Entidades em uma Atividade. As entidades podem variar no número de campos. A classe Entity contém os campos adicionais em getProperties(). Para converter em outros tipos de entidade, use <T>getAs(Class<T> classType).

Retornos:

Uma lista de Entity.

getExpiration

public LocalDateTime getExpiration()

Obtém o tempo em que a atividade deve ser considerada expirada e não deve ser apresentada ao destinatário.

Retornos:

a expiração da atividade.

getFrom

public ChannelAccount getFrom()

Identifica o remetente da mensagem.

Retornos:

O ChannelAccount do remetente.

getHistoryDisclosed

public boolean getHistoryDisclosed()

Obtém se o histórico anterior do canal é divulgado.

Retornos:

True se o histórico for divulgado.

getId

public String getId()

Retorna a ID que identifica exclusivamente a atividade no canal.

Retornos:

A ID da atividade.

getImportance

public String getImportance()

Obtém a importância da atividade.

Retornos:

A importância da atividade.

getInputHint

public InputHints getInputHint()

Indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente.

Retornos:

A dica de entrada para a atividade.

getLabel

public String getLabel()

Obtém o rótulo descritivo para a atividade.

Retornos:

O rótulo da atividade.

getListenFor

public List getListenFor()

Obtém a lista de frases e referências que os sistemas de preparação de fala e idioma devem escutar.

Retornos:

Lista de frases a serem ouvidas.

getLocalTimestamp

public OffsetDateTime getLocalTimestamp()

Obtém a data e a hora locais da mensagem, expressa no formato ISO-8601. Por exemplo, 2016-09-23T13:07:49.4714686-07:00.

Retornos:

O carimbo de data/hora local da atividade.

getLocalTimezone

public String getLocalTimezone()

Obtém o nome do fuso horário local da mensagem, expresso no formato de banco de dados de fuso horário IANA. Por exemplo, América/Los_Angeles.

Retornos:

O fuso horário local.

getLocale

public String getLocale()

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 uma linguagem 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.

Retornos:

A localidade do conteúdo.

getMembersAdded

public List getMembersAdded()

Obtém a coleção de membros adicionada à conversa.

Retornos:

Lista de ChannelAccount de membros adicionados.

getMembersRemoved

public List getMembersRemoved()

Obtém a coleção de membros removidos da conversa.

Retornos:

Lista de ChannelAccount de membros removidos.

getMentions

public List getMentions()

Resolve as menções das entidades dessa atividade. Esse método é definido na classe Activity, mas destina-se apenas ao uso com uma atividade de mensagem, em que a atividade Activity#type está definida como MESSAGE.

Retornos:

A matriz de menções; ou uma matriz vazia, se nenhuma for encontrada.

getName

public String getName()

Obtém o nome da operação associada a uma atividade de invocação ou evento.

Retornos:

O nome da atividade.

getProperties

public Map getProperties()

Contém as propriedades de estouro que não são propriedades de primeira classe no objeto. Isso permite extensibilidade ao manter o objeto.

Retornos:

Mapa de propriedades adicionais.

getReactionsAdded

public List getReactionsAdded()

Obtém a coleção de reações adicionadas à conversa.

Retornos:

Uma lista de MessageReaction.

getReactionsRemoved

public List getReactionsRemoved()

Obtém a coleção de reações removidas da conversa.

Retornos:

Uma lista de MessageReaction.

getRecipient

public ChannelAccount getRecipient()

Identifica o destinatário da mensagem.

Retornos:

O ChannelAccount do destinatário.

getRelatesTo

public ConversationReference getRelatesTo()

Uma referência a outra conversa ou atividade.

Retornos:

A referência da conversa.

getReplyConversationReference

public ConversationReference getReplyConversationReference(ResourceResponse reply)

Crie uma ConversationReference com base nas informações de conversa dessa atividade e no ResourceResponse enviando uma atividade.

Parâmetros:

reply - ResourceResponse retornado de sendActivity.

Retornos:

Uma ConversationReference que pode ser armazenada e usada posteriormente para excluir ou atualizar a atividade.

getReplyToId

public String getReplyToId()

Obtém a ID da mensagem à qual essa mensagem é uma resposta.

Retornos:

A resposta à ID.

getServiceUrl

public String getServiceUrl()

Define a URL que especifica o ponto de extremidade de serviço do canal. Definido pelo canal.

Retornos:

A URL do serviço.

getSpeak

public String getSpeak()

O texto a ser falado.

Retornos:

O texto SSML a ser falado.

getSuggestedActions

public SuggestedActions getSuggestedActions()

Obtém as ações sugeridas para a atividade.

Retornos:

As SuggestedActions para a atividade.

getSummary

public String getSummary()

Obtém o texto a ser exibido se o canal não puder renderizar cartões.

Retornos:

O texto de resumo.

getText

public String getText()

Obtém o conteúdo de texto da mensagem.

Retornos:

O conteúdo do texto.

getTextFormat

public TextFormatTypes getTextFormat()

Formato dos campos de texto Padrão:markdown. Os valores possíveis incluem: 'markdown', 'plain', 'xml'.

Retornos:

O tipo TextFormatTypes.

getTextHighlights

public List getTextHighlights()

Obtém a coleção de fragmentos de texto a ser realçada quando a atividade contém um valor ReplyToId.

Retornos:

Lista de TextHighlight.

getTimestamp

public OffsetDateTime getTimestamp()

Obtém a data e a hora em que a mensagem foi enviada, em UTC, expressa no formato ISO-8601.

Retornos:

O carimbo de data/hora UTC da atividade.

getTopicName

public String getTopicName()

Obtém o nome do tópico atualizado da conversa.

Retornos:

O nome do tópico.

getType

public String getType()

Obtém o ActivityTypes da atividade.

Retornos:

O tipo de atividade.

getValue

public Object getValue()

Obtém o valor associado à atividade.

Retornos:

O valor da atividade.

getValueType

public String getValueType()

Obtém o tipo do objeto de valor da atividade.

Retornos:

O tipo de valor.

hasContent

public boolean hasContent()

Verifica se essa atividade (mensagem) tem conteúdo.

Retornos:

Retornará true, se essa mensagem tiver algum conteúdo a ser enviado. False caso contrário.

isActivity

protected boolean isActivity(String activityType)

True se a Atividade for do tipo de atividade especificado.

Parâmetros:

activityType - O tipo ao qual comparar.

Retornos:

true se a atividade for do tipo específico.

isFromStreamingConnection

public Boolean isFromStreamingConnection()

Determina 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.

Retornos:

True se a Atividade foi originada de uma conexão de streaming.

isTeamsActivity

public boolean isTeamsActivity()

Verifique se essa actvidade é do Microsoft Teams.

Retornos:

true se a atividade for do Microsoft Teams.

isType

public boolean isType(String compareTo)

Método de conveniência a ser retornado se a Atividade for do tipo especificado.

Parâmetros:

compareTo - O tipo ao qual comparar.

Retornos:

True se a atividade for do tipo especificado.

removeMentionText

public String removeMentionText(String withId)

Remova qualquer texto de menção para determinada ID da propriedade Activity.Text. Por exemplo, dada a mensagem "@echoBot Oi Bot", isso removerá "@echoBot", deixando "Oi Bot". Normalmente, isso seria usado para remover o texto de menção para o destinatário de destino (o bot geralmente), embora ele pudesse ser chamado para cada membro. Por exemplo: turnContext.Activity.RemoveMentionText(turnContext.Activity.Recipient.Id); O formato de uma menção Activity.Entity depende do Canal. Mas, em todos os casos, esperamos que o Mention.Text contenha o texto exato para o usuário como ele aparece em Activity.Text. Por exemplo, o Teams usade nome de usuário, enquanto o uso de slack @username. Espera-se que o texto esteja em Activity.Text e esse método remova esse valor de Activity.Text.

Parâmetros:

withId - Menção à ID para corresponder.

Retornos:

novo valor da propriedade Activity.Text.

removeMentionTextImmutable

public static String removeMentionTextImmutable(Activity activity, String id)

Remove a menção de Activity.Text sem modificar a Atividade.

Parâmetros:

activity - A Atividade na qual remover o texto de menção.

id - A ID do destinatário.

Retornos:

O Activity.Text com a menção removida.

removeRecipientMention

public String removeRecipientMention()

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.

Retornos:

Novo. Valor da propriedade de texto.

removeRecipientMentionImmutable

public static String removeRecipientMentionImmutable(Activity activity)

Remove a menção do destinatário sem modificar a Atividade.

Parâmetros:

activity - A Atividade da qual remover menções.

Retornos:

O Activity.Text com menções removidas.

setAction

public void setAction(String withAction)

Indica se o destinatário de um contactRelationUpdate foi adicionado ou removido da lista de contatos do remetente.

Parâmetros:

withAction - Ação do destinatário.

setAttachment

public void setAttachment(Attachment withAttachment)

Define um único anexo na Atividade.

Parâmetros:

withAttachment - O objeto Attachment.

setAttachmentLayout

public void setAttachmentLayout(AttachmentLayoutTypes withAttachmentLayout)

Define a dica de layout para vários anexos.

Parâmetros:

withAttachmentLayout - O tipo de anexo.

setAttachments

public void setAttachments(List withAttachments)

Define os anexos para a Atividade.

Parâmetros:

withAttachments - Uma lista de Attachment.

setCallerId

public void setCallerId(String withCallerId)

Define a 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).

Parâmetros:

withCallerId - A ID do chamador.

setChannelData

public void setChannelData(Object withChannelData)

Define o conteúdo específico do canal.

Parâmetros:

withChannelData - Canalize dados específicos como um JsonNode.

setChannelId

public void setChannelId(String withChannelId)

Define a ID que identifica exclusivamente o canal. Definido pelo canal.

Parâmetros:

withChannelId - A ID do canal.

setCode

public void setCode(EndOfConversationCodes withCode)

Define o código para atividades endOfConversation que indica por que a conversa terminou.

Parâmetros:

withCode - O código endOfConversation.

setConversation

public void setConversation(ConversationAccount withConversation)

Identifica a conversa à qual a atividade pertence.

Parâmetros:

withConversation - O ConversationAccount.

setDeliveryMode

public void setDeliveryMode(String withDeliveryMode)

Uma dica de entrega para sinalizar para os caminhos de entrega alternativos do destinatário para a atividade.

O modo de entrega padrão é \"default\".

Parâmetros:

withDeliveryMode - A dica do modo de entrega.

setEntities

public void setEntities(List withEntities)

Define a versão de conteúdo das Entidades em uma Atividade.

Parâmetros:

withEntities - As entidades de conteúdo.

setExpiration

public void setExpiration(LocalDateTime withExpiration)

Define o momento em que a atividade deve ser considerada expirada e não deve ser apresentada ao destinatário.

Parâmetros:

withExpiration - A expiração da atividade.

setFrom

public void setFrom(ChannelAccount withFrom)

Identifica o remetente da mensagem.

Parâmetros:

withFrom - O ChannelAccount do remetente.

setHistoryDisclosed

public void setHistoryDisclosed(boolean withHistoryDisclosed)

Define se o histórico anterior do canal é divulgado.

Parâmetros:

withHistoryDisclosed - True se o histórico for divulgado.

setId

public void setId(String withId)

Define a ID que identifica exclusivamente a atividade no canal.

Parâmetros:

withId - A ID da atividade.

setImportance

public void setImportance(String withImportance)

Define a importância da atividade.

Parâmetros:

withImportance - A importância da atividade.

setInputHint

public void setInputHint(InputHints withInputHint)

Indica se o bot está aceitando, esperando ou ignorando a entrada do usuário depois que a mensagem é entregue ao cliente.

Parâmetros:

withInputHint - A dica de entrada para a atividade.

setLabel

public void setLabel(String withLabel)

Define o rótulo descritivo para a atividade.

Parâmetros:

withLabel - O rótulo da atividade.

setListenFor

public void setListenFor(List withListenFor)

Define a lista de frases e referências que os sistemas de preparação de fala e idioma devem escutar.

Parâmetros:

withListenFor - Lista de frases a serem ouvidas.

setLocalTimeZone

public void setLocalTimeZone(String withLocalTimezone)

Define o nome do fuso horário local da mensagem, expresso no formato de banco de dados de fuso horário IANA. Por exemplo, América/Los_Angeles.

Parâmetros:

withLocalTimezone - O fuso horário local.

setLocalTimestamp

public void setLocalTimestamp(OffsetDateTime withLocalTimestamp)

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.

Parâmetros:

withLocalTimestamp - O carimbo de data/hora local da atividade.

setLocale

public void setLocale(String withLocale)

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 uma linguagem 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.

Parâmetros:

withLocale - A localidade do conteúdo.

setMembersAdded

public void setMembersAdded(List withMembersAdded)

Define a coleção de membros adicionados à conversa.

Parâmetros:

withMembersAdded - Lista de ChannelAccount de membros adicionados.

setMembersRemoved

public void setMembersRemoved(List withMembersRemoved)

Define a coleção de membros removidos da conversa.

Parâmetros:

withMembersRemoved - Lista de ChannelAccount de membros removidos.

setMentions

public void setMentions(List withMentions)

Define a versão de conteúdo das Menções em uma Atividade.

Parâmetros:

withMentions - As entidades de conteúdo.

setName

public void setName(String withName)

Define o nome da operação associada a uma atividade de invocação ou evento.

Parâmetros:

withName - O nome da atividade.

setProperties

public void setProperties(String key, JsonNode withValue)

Contém as propriedades de estouro que não são propriedades de primeira classe no objeto. Isso permite extensibilidade ao manter o objeto.

Parâmetros:

key - A chave da propriedade a ser definida.

withValue - O valor da propriedade.

setReactionsAdded

public void setReactionsAdded(List withReactionsAdded)

Define a coleção de reações adicionadas à conversa.

Parâmetros:

withReactionsAdded - Uma lista de MessageReaction.

setReactionsRemoved

public void setReactionsRemoved(List withReactionsRemoved)

Define a coleção de reações removidas da conversa.

Parâmetros:

withReactionsRemoved - Uma lista de MessageReaction.

setRecipient

public void setRecipient(ChannelAccount withRecipient)

Identifica o destinatário da mensagem.

Parâmetros:

withRecipient - O ChannelAccount do destinatário.

setRelatesTo

public void setRelatesTo(ConversationReference withRelatesTo)

Uma referência a outra conversa ou atividade.

Parâmetros:

withRelatesTo - A referência da conversa.

setReplyToId

public void setReplyToId(String withReplyToId)

Define a ID da mensagem à qual essa mensagem é uma resposta.

Parâmetros:

withReplyToId - A resposta à ID.

setServiceUrl

public void setServiceUrl(String withServiceUrl)

Define a URL que especifica o ponto de extremidade de serviço do canal. Definido pelo canal.

Parâmetros:

withServiceUrl - A URL de serviço da Atividade.

setSpeak

public void setSpeak(String withSpeak)

Define o texto a ser falado.

Parâmetros:

withSpeak - O texto SSML a ser falado.

setSuggestedActions

public void setSuggestedActions(SuggestedActions withSuggestedActions)

As ações sugeridas para a atividade.

Parâmetros:

withSuggestedActions - As SuggestedActions para a atividade.

setSummary

public void setSummary(String withSummary)

Define o texto a ser exibido se o canal não puder renderizar cartões.

Parâmetros:

withSummary - O texto de resumo.

setText

public void setText(String withText)

Define o conteúdo do texto da mensagem.

Parâmetros:

withText - O conteúdo do texto.

setTextFormat

public void setTextFormat(TextFormatTypes withTextFormat)

Formato de campos de texto.

Parâmetros:

withTextFormat - O tipo TextFormatTypes.

setTextHighlights

public void setTextHighlights(List withTextHighlights)

Define a coleção de fragmentos de texto a ser realçada quando a atividade contém um valor ReplyToId.

Parâmetros:

withTextHighlights - Lista de TextHighlight.

setTimestamp

public void setTimestamp(OffsetDateTime withTimestamp)

Define a data e a hora em que a mensagem foi enviada, em UTC, expressa no formato ISO-8601.

Parâmetros:

withTimestamp - O carimbo de data/hora UTC da atividade.

setTopicName

public void setTopicName(String withTopicName)

Define o nome do tópico atualizado da conversa.

Parâmetros:

withTopicName - O nome do tópico.

setType

public void setType(String withType)

Define o ActivityTypes da atividade.

Parâmetros:

withType - O tipo da Atividade.

setValue

public void setValue(Object withValue)

Define o valor associado à atividade.

Parâmetros:

withValue - O valor da atividade.

setValueType

public void setValueType(String withValueType)

Define o tipo do objeto de valor da atividade.

Parâmetros:

withValueType - O tipo de valor de atividade.

teamsGetChannelData

public TeamsChannelData teamsGetChannelData()

Obtém o TeamsChannelData.

Retornos:

TeamsChannelData

teamsGetChannelId

public String teamsGetChannelId()

Obtenha um identificador exclusivo que representa um canal.

Retornos:

Se essa for uma Atividade do Teams com dados válidos, o identificador exclusivo que representa um canal.

teamsGetMeetingInfo

public TeamsMeetingInfo teamsGetMeetingInfo()

Obtém o objeto TeamsMeetingInfo da atividade atual.

Retornos:

A reunião da equipe da atividade atual ou nula.

teamsGetTeamId

public String teamsGetTeamId()

Obtenha um identificador exclusivo que representa uma equipe.

Retornos:

Se esta for uma Atividade do Teams com dados válidos, o identificador exclusivo que representa uma equipe.

teamsGetTeamInfo

public TeamInfo teamsGetTeamInfo()

Obter dados do TeamInfo do Teams.

Retornos:

Se esta for uma Atividade do Teams com dados válidos, o objeto TeamInfo.

teamsNotifyUser

public void teamsNotifyUser()

Define o valor da notificação no TeamsChannelData como true.

teamsNotifyUser

public void teamsNotifyUser(boolean alertInMeeting, String externalResourceUrl)

Define a notificação de uma reunião no TeamsChannelData.

Parâmetros:

alertInMeeting - True se este for um alerta de reunião.

externalResourceUrl - A URL do recurso externo.