Share via


MessageActionsPayload Class

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

Constructor

pydantic model MessageActionsPayload

Parameters

Name Description
id
Required
str

Unique id of the message.

reply_to_id
Required
str

Id of the parent/root message of the thread.

message_type
Required
str

Type of message - automatically set to message.

created_date_time
Required
str

Timestamp of when the message was created.

last_modified_date_time
Required
str

Timestamp of when the message was edited or updated.

deleted
Required

Indicates whether a message has been soft deleted.

subject
Required
str

Subject line of the message.

summary
Required
str

Summary text of the message that could be used for notifications.

importance
Required
Annotated[str, <xref:Field>(<xref:pattern=r"^>(<xref:normal>|<xref:high>|<xref:urgent>)<xref:$">)]

The importance of the message. Possible values include: 'normal', 'high', 'urgent'

locale
Required
str

Locale of the message set by the client.

link_to_message
Required
str

Link back to the message.

from_property
Required

Sender of the message.

body
Required

Plaintext/HTML representation of the content of the message.

attachment_layout
Required
str

How the attachment(s) are displayed in the message.

attachments
Required

Attachments in the message - card, image, file, etc.

mentions
Required

List of entities mentioned in the message.

reactions
Required

Reactions for the message.

Keyword-Only Parameters

Name Description
id
Default value: None
replyToId
Default value: None
messageType
Default value: None
createdDateTime
Default value: None
lastModifiedDateTime
Default value: None
deleted
Default value: None
subject
Default value: None
summary
Default value: None
importance
Default value: None
locale
Default value: None
linkToMessage
Default value: None
fromProperty
Default value: None
body
Default value: None
attachmentLayout
Default value: None
attachments
Default value: None
mentions
Default value: None
reactions
Default value: None

Attributes

attachment_layout

field attachment_layout: str = None (alias 'attachmentLayout')

attachments

field attachments: List[MessageActionsPayloadAttachment] = None

body

field body: MessageActionsPayloadBody = None

created_date_time

field created_date_time: str = None (alias 'createdDateTime')

deleted

field deleted: bool = None

from_property

field from_property: MessageActionsPayloadFrom = None (alias 'fromProperty')

id

field id: str = None

importance

field importance: str = None

last_modified_date_time

field last_modified_date_time: str = None (alias 'lastModifiedDateTime')
field link_to_message: str = None (alias 'linkToMessage')

locale

field locale: str = None

mentions

field mentions: List[MessageActionsPayloadMention] = None

message_type

field message_type: str = None (alias 'messageType')

reactions

field reactions: List[MessageActionsPayloadReaction] = None

reply_to_id

field reply_to_id: str = None (alias 'replyToId')

subject

field subject: str = None

summary

field summary: str = None