Class MessageEntity

Hierarchy

  • BaseMongoEntity
    • MessageEntity

Implements

Constructors

constructor

Properties

category content customFields? priority publications readBy? readStatus? senderId senderType shouldSendMail? title topicId typeId

Constructors

constructor

Properties

category

category: string

Category of the message

content

content: string

Message content

Optional customFields

customFields?: Record<string, unknown>

Custom fields

priority

priority: string

Priority of the message

publications

publications: {
    since?: number;
    until?: number;
}

The message can be accessed during publication times

Type declaration

  • Optional since?: number

    Publication displayed since

  • Optional until?: number

    Publication displayed until

Optional readBy

readBy?: {
    readAt: Date;
    userId: string;
}[]

Read by list

Type declaration

  • readAt: Date

    Date of read at

  • userId: string

    User ID of the read

Optional readStatus

readStatus?: "read" | "unread"

Read status

senderId

senderId: string

Message sender ID

senderType

senderType: string

Message sender type

Optional shouldSendMail

shouldSendMail?: boolean

Should email be sent

title

title: string

Message title

topicId

topicId: string

Topic ID of the message

typeId

typeId: string

Type ID of the message

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc