Module: notification

API address: /api/notifications

Functionality for Notifications

Module	Services	Data types	Constants
notification	NotificationService getSettings getSettingsV2 index markAllRead markRead markUnread toggle	Category Notification NotificationEvent NotificationResponse NotificationSetting NotificationTypes Setting SettingGroup

Enumerations

`NamedMentionMessage`	`1`
`RoleMentionMessage`	`2`
`AllMentionMessage`	`3`
`ActionRequired`	`4`
`AddRole`	`5`
`RemoveRole`	`6`
`JobStart`	`7`
`JobComplete`	`8`
`JobReopen`	`9`
`JobCancel`	`19`
`IssueCreate`	`10`
`IssueResolve`	`11`
`IssueReopen`	`12`
`StandaloneIssueCreate`	`13`
`StandaloneIssueResolve`	`14`
`StandaloneIssueReopen`	`15`
`ThreadNamedMentionMessage`	`16`
`Deviation`	`17`
`Generic`	`18`

Key	Field	Type	Requiredness
1	id	`string`	default
2	event	`NotificationEvent`	default
3	metadata	`map<string, string>`	default
4	sequenceId	`i64`	default
5	readAt	`i64`	default
6	createdAt	`i64`	default
7	structuredBody	`messaging.StructuredBody`	default

Key	Field	Type	Requiredness
1	unreadNotifications	`i64`	default
2	notifications	`list<Notification>`	default
3	totalNotifications	`i64`	default
4	remainingNotifications	`i64`	default

Key	Field	Type	Requiredness
1	regular	`bool`	optional
2	push	`bool`	optional
3	email	`bool`	optional

Key	Field	Type	Description	Requiredness	Default value
1	types	`NotificationTypes`		default
2	subCategories	`map<Category, NotificationTypes>`		optional

Key	Field	Type	Requiredness
1	category	`Category`	default
2	description	`string`	default
3	types	`NotificationTypes`	default

Key	Field	Type	Description	Requiredness	Default value
1	name	`string`		default
2	settings	`list<Setting>`		default

NotificationResponse index(i32 pageNum,
                           bool includeRead)
    throws common.SystemException

void markRead(string notificationId)
    throws common.SystemException

void markUnread(string notificationId)
    throws common.SystemException

void markAllRead()
    throws common.SystemException

void toggle(Category category,
            NotificationTypes types)
    throws common.SystemException

map<Category, NotificationSetting> getSettings()
    throws common.SystemException

list<SettingGroup> getSettingsV2()
    throws common.SystemException