MessageActionsPayload Class

Package:
com.microsoft.bot.schema.teams
Maven Artifact:
com.microsoft.bot:bot-schema:4.14.3
  • java.lang.Object
    • com.microsoft.bot.schema.teams.MessageActionsPayload

public class MessageActionsPayload

Represents the individual message within a chat or channel where a message actions is taken.

Constructor Summary

Constructor Description
MessageActionsPayload()

Method Summary

Modifier and Type Method and Description
java.lang.String getAttachmentLayout()

Gets how the attachment(s) are displayed in the message.
java.util.List<MessageActionsPayloadAttachment> getAttachments()

Gets attachments in the message - card, image, file, etc.
MessageActionsPayloadBody getBody()

Gets plaintext/HTML representation of the content of the message.
java.lang.String getCreatedDateTime()

Gets timestamp of when the message was created.
java.lang.Boolean getDeleted()

Indicates whether a message has been soft deleted.
MessageActionsPayloadFrom getFrom()

Gets sender of the message.
java.lang.String getId()

Gets unique id of the message.
java.lang.String getImportance()

Gets the importance of the message.
java.lang.String getLastModifiedDateTime()

Gets timestamp of when the message was edited or updated.
java.lang.String getLinkToMessage()

Gets the link back to the message.
java.lang.String getLocale()

Gets locale of the message set by the client.
java.util.List<MessageActionsPayloadMention> getMentions()

Gets list of entities mentioned in the message.
java.lang.String getMessageType()

Gets type of message - automatically set to message.
java.util.List<MessageActionsPayloadReaction> getReactions()

Gets reactions for the message.
java.lang.String getReplyToId()

Gets id of the parent/root message of the thread.
java.lang.String getSubject()

Gets subject line of the message.
java.lang.String getSummary()

Gets summary text of the message that could be used for notifications.
void setAttachmentLayout(String withAttachmentLayout)

Sets how the attachment(s) are displayed in the message.
void setAttachments(List<MessageActionsPayloadAttachment> withAttachments)

Sets attachments in the message - card, image, file, etc.
void setBody(MessageActionsPayloadBody withBody)

Sets plaintext/HTML representation of the content of the message.
void setCreatedDateTime(String withCreatedDateTime)

Sets timestamp of when the message was created.
void setDeleted(Boolean withDeleted)

Indicates whether a message has been soft deleted.
void setFrom(MessageActionsPayloadFrom withFrom)

Sets sender of the message.
void setId(String withId)

Sets unique id of the message.
void setImportance(String withImportance)

Sets the importance of the message.
void setLastModifiedDateTime(String withLastModifiedDateTime)

Sets timestamp of when the message was edited or updated.
void setLinkToMessage(String withLinkToMessage)

Sets link back to the message.
void setLocale(String withLocale)

Sets locale of the message set by the client.
void setMentions(List<MessageActionsPayloadMention> withMentions)

Sets list of entities mentioned in the message.
void setMessageType(String withMessageType)

Sets type of message.
void setReactions(List<MessageActionsPayloadReaction> withReactions)

Sets reactions for the message.
void setReplyToId(String withReplyToId)

Sets id of the parent/root message of the thread.
void setSubject(String withSubject)

Sets subject line of the message.
void setSummary(String withSummary)

Sets summary text of the message that could be used for notifications.

Methods inherited from 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

Constructor Details

MessageActionsPayload

public MessageActionsPayload()

Method Details

getAttachmentLayout

public String getAttachmentLayout()

Gets how the attachment(s) are displayed in the message.

Returns:

The attachment layout.

getAttachments

public List getAttachments()

Gets attachments in the message - card, image, file, etc.

Returns:

The message attachments.

getBody

public MessageActionsPayloadBody getBody()

Gets plaintext/HTML representation of the content of the message.

Returns:

The message body.

getCreatedDateTime

public String getCreatedDateTime()

Gets timestamp of when the message was created.

Returns:

The timestamp of the message.

getDeleted

public Boolean getDeleted()

Indicates whether a message has been soft deleted.

Returns:

True if deleted.

getFrom

public MessageActionsPayloadFrom getFrom()

Gets sender of the message.

Returns:

The message sender.

getId

public String getId()

Gets unique id of the message.

Returns:

The unique id.

getImportance

public String getImportance()

Gets the importance of the message.

Returns:

Possible values include: 'normal', 'high', 'urgent'

getLastModifiedDateTime

public String getLastModifiedDateTime()

Gets timestamp of when the message was edited or updated.

Returns:

The timestamp of the message.

getLinkToMessage

public String getLinkToMessage()

Gets the link back to the message.

Returns:

The link back to the message.

getLocale

public String getLocale()

Gets locale of the message set by the client.

Returns:

The message locale.

getMentions

public List getMentions()

Gets list of entities mentioned in the message.

Returns:

The list of mentions.

getMessageType

public String getMessageType()

Gets type of message - automatically set to message.

Returns:

Possible values include: 'message'

getReactions

public List getReactions()

Gets reactions for the message.

Returns:

Message reactions.

getReplyToId

public String getReplyToId()

Gets id of the parent/root message of the thread.

Returns:

The id of the parent/root message.

getSubject

public String getSubject()

Gets subject line of the message.

Returns:

The message subject line.

getSummary

public String getSummary()

Gets summary text of the message that could be used for notifications.

Returns:

The summary text.

setAttachmentLayout

public void setAttachmentLayout(String withAttachmentLayout)

Sets how the attachment(s) are displayed in the message.

Parameters:

withAttachmentLayout - The attachment layout.

setAttachments

public void setAttachments(List withAttachments)

Sets attachments in the message - card, image, file, etc.

Parameters:

withAttachments - The message attachments.

setBody

public void setBody(MessageActionsPayloadBody withBody)

Sets plaintext/HTML representation of the content of the message.

Parameters:

withBody - The message body.

setCreatedDateTime

public void setCreatedDateTime(String withCreatedDateTime)

Sets timestamp of when the message was created.

Parameters:

withCreatedDateTime - The message timestamp.

setDeleted

public void setDeleted(Boolean withDeleted)

Indicates whether a message has been soft deleted.

Parameters:

withDeleted - True if deleted.

setFrom

public void setFrom(MessageActionsPayloadFrom withFrom)

Sets sender of the message.

Parameters:

withFrom - The message sender.

setId

public void setId(String withId)

Sets unique id of the message.

Parameters:

withId - The new id of the message.

setImportance

public void setImportance(String withImportance)

Sets the importance of the message.

Parameters:

withImportance - Possible values include: 'normal', 'high', 'urgent'

setLastModifiedDateTime

public void setLastModifiedDateTime(String withLastModifiedDateTime)

Sets timestamp of when the message was edited or updated.

Parameters:

withLastModifiedDateTime - The message timestamp.

setLinkToMessage

public void setLinkToMessage(String withLinkToMessage)

Sets link back to the message.

Parameters:

withLinkToMessage - The link back to the message.

setLocale

public void setLocale(String withLocale)

Sets locale of the message set by the client.

Parameters:

withLocale - The message locale.

setMentions

public void setMentions(List withMentions)

Sets list of entities mentioned in the message.

Parameters:

withMentions - The list of mentions.

setMessageType

public void setMessageType(String withMessageType)

Sets type of message.

Parameters:

withMessageType - Possible values include: 'message'

setReactions

public void setReactions(List withReactions)

Sets reactions for the message.

Parameters:

withReactions - Message reactions.

setReplyToId

public void setReplyToId(String withReplyToId)

Sets id of the parent/root message of the thread.

Parameters:

withReplyToId - The id of the parent/root message.

setSubject

public void setSubject(String withSubject)

Sets subject line of the message.

Parameters:

withSubject - The message subject line.

setSummary

public void setSummary(String withSummary)

Sets summary text of the message that could be used for notifications.

Parameters:

withSummary - The summary text.

Applies to