Class NotificationServiceNotification

A structure that represents a notification within the NotificationService web API.

Index

Constructors

Accessors

discussionMessage isRead markAsReadDate notificationUUID projectUUID text

Constructors

constructor

new NotificationServiceNotification(
isInternalConstructor?: boolean,
): NotificationServiceNotification
Parameters
- OptionalisInternalConstructor: boolean
Returns NotificationServiceNotification

Overrides FrameworkObject.constructor

Accessors

discussionMessage

get discussionMessage(): NotificationServiceNotificationMentionInformation

If the notification corresponds to a mention on a discussion, contains a link to the discussion the mention has occurred on.

Returns NotificationServiceNotificationMentionInformation

isRead

get isRead(): boolean

Specifies whether the notification was marked as read or not.

Returns boolean
set isRead(value: boolean): void
Parameters
- value: boolean
Returns void

markAsReadDate

get markAsReadDate(): string

Specifies the date when the notification was marked as read.

Returns string
set markAsReadDate(value: string): void
Parameters
- value: string
Returns void

notificationUUID

get notificationUUID(): UUID

Specifies the unique ID of the notification. Can be used to mark the notification as read.

Returns UUID
set notificationUUID(value: UUID): void
Parameters
- value: UUID
Returns void

projectUUID

get projectUUID(): UUID

The UUID of the project where the notification was sent to.

Returns UUID
set projectUUID(value: UUID): void
Parameters
- value: UUID
Returns void

text

get text(): string

The text of the notification. This can be anything and is set by the server. It describes what the notification is.

Returns string
set text(value: string): void
Parameters
- value: string
Returns void