UserAnnouncementDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Data transfer object for a user's view of an announcement, including their personal interaction state.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) | The announcement ID.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
title
required |
string | The announcement title.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
body
required |
string | The announcement body content (Markdown).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
priority
required |
AnnouncementPriority AnnouncementPriority | The priority level.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
displayOptions
required |
AnnouncementDisplayOptions AnnouncementDisplayOptions | How the announcement should be displayed.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
externalLinkUrl
required |
string | Optional external link URL.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
externalLinkText
required |
string | Optional external link display text.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
creationTime
required |
string (date-time) | When the announcement was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
isRead
required |
boolean | Whether the user has read this announcement.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
isDismissed
required |
boolean | Whether the user has dismissed this announcement.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
popupShown
required |
boolean | Whether the popup has been shown for this announcement.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
readAt
required |
string (date-time) | When the user read this announcement.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
dismissedAt
required |
string (date-time) | When the user dismissed this announcement.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.