Interface MessageResponse<CustomFields>

interface MessageResponse {
    category: string;
    content: string;
    createdAt: string;
    customFields?: CustomFields;
    id: string;
    messageType: "private" | "channel";
    organizationId?: string;
    priority?: string;
    readStatus?: "read" | "unread";
    receiptId?: string;
    senderId?: string;
    senderType: string;
    title: string;
    topicId: string;
    typeId: string;
    updatedAt: string;
}

Type Parameters

  • CustomFields = unknown

Properties

category content createdAt customFields? id messageType organizationId? priority? readStatus? receiptId? senderId? senderType title topicId typeId updatedAt

Properties

category

category: string

Category of the message. Arbitrary string depending upon application

content

content: string

Message body

createdAt

createdAt: string

ISO datetime for when the message was created

Optional customFields

customFields?: CustomFields

Custom fields for the message

id

id: string

Message ID

messageType

messageType: "private" | "channel"

Message type. Either a private message or made in a subscribable channel

Optional organizationId

organizationId?: string

Associated organization with the message (for supply side)

Optional priority

priority?: string

Priority of the message. Arbitrary string depending upon application

Optional readStatus

readStatus?: "read" | "unread"

Read status for this message. Depending upon the input, this may be for the user, the org, or not returned. Read the messaging service api documentation for details

Optional receiptId

receiptId?: string

Receiver of the message. Only applicable for private type

Optional senderId

senderId?: string

Sender id of the message. Generally a user id

senderType

senderType: string

Sender type of the message. Generally 'normalUser', but may be an arbitrary value depending upon senderId's purpose

title

title: string

Message title

topicId

topicId: string

Topic ID for the message

typeId

typeId: string

Type ID for the message. Arbitrary string depending upon application

updatedAt

updatedAt: string

ISO datetime for when the message was last updated

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc