NotificationConfig

Configuration Object for notifications.

Methods

addUsersWithIds

addUsersWithIds(pUserIds): NotificationConfig

Add userIds of the users to get notified.

Parameters

pUserIds

string[]

Array of user ids. 'null' for notification to the current user (default behaviour).

Returns

NotificationConfig

NotificationConfig

---

addUserWithId

addUserWithId(pUserId): NotificationConfig

Add userIds of a user that is to be notified.

Parameters

pUserId

string | number | boolean

the user id to add

Returns

NotificationConfig

NotificationConfig

---

caption

caption(pCaption): NotificationConfig

Sets the caption of the notification.

Parameters

pCaption

string | number | boolean

the caption

Returns

NotificationConfig

NotificationConfig

---

contentId

contentId(pContentId): NotificationConfig

Sets the contentId that will point to the notification content. Using same ContentId will version-up the Notification. Null or empty contentid will create a new one.

Parameters

pContentId

string | number | boolean

the content id

Returns

NotificationConfig

NotificationConfig

---

daysToLive

daysToLive(pDaysToLive): NotificationConfig

Sets the days the notification is supposed lives. -1 is infinite.

Parameters

pDaysToLive

number

the number of days

Returns

NotificationConfig

NotificationConfig

---

description

description(pDescription): NotificationConfig

Sets the description of the notification.

Parameters

pDescription

string | number | boolean

the description

Returns

NotificationConfig

NotificationConfig

---

forcedPriority

forcedPriority(pForcedPriority): NotificationConfig

For example: ENotificationPriority.MAX (from MAX, HIGH, NORMAL, LOW, MIN, NONE); not changable from user. null and NONE have same effect -> userPrio or typeDefault take over. Defaultvalue for this is NONE.

Parameters

pForcedPriority

ForcedPriority

the priority

Returns

NotificationConfig

NotificationConfig

---

imageInfo

imageInfo(pImageInfo): NotificationConfig

Sets the image info. Option 1 (null): Notification takes Icon from its Type (recommended) Option 2 (for example: VAADIN:CHECK): Notification gets this icon Option 3 (Image): ???

Parameters

pImageInfo

string | number | boolean

the image info

Returns

NotificationConfig

NotificationConfig

---

initialState

initialState(pNotificationState): NotificationConfig

Sets the initial notification state ("UNSEEN", "SEEN" (user has seen the notification but not interacted with it), "CONFIRMED" (user has interacted with the notification), "DELETED", "ARCHIVE"). Default is UNSEEN.

Parameters

pNotificationState

NotificationState

the state

Returns

NotificationConfig

NotificationConfig

---

linkInfo

linkInfo(pLinkInfo): NotificationConfig

Sets the info parameter for the open-process (json format). Only possible with text.encodeMS(["contextName", "datasetid"]);

Parameters

pLinkInfo

string | number | boolean

the link info

Returns

NotificationConfig

NotificationConfig

---

notificationSubCategory

notificationSubCategory(pSubcategory): NotificationConfig

Sets the subcategory of the notification, can be any String.

Parameters

pSubcategory

string | number | boolean

the category

Returns

NotificationConfig

NotificationConfig

---

notificationType

notificationType(pType): NotificationConfig

Sets the type of the notification, can be any type, defined in notificationtypes.

Parameters

pType

string | number | boolean

the type

Returns

NotificationConfig

NotificationConfig

---

originatorName

originatorName(pOriginatorName): NotificationConfig

Sets the name of the originator in the notification popup.

Parameters

pOriginatorName

string | number | boolean

the name of the originator

Returns

NotificationConfig

NotificationConfig

---

remindAgainOnNewContent

remindAgainOnNewContent(pRemindAgainOnNewContent): NotificationConfig

Decide whether the notification should appear again when the contents are changed

Parameters

pRemindAgainOnNewContent

boolean

true to remind again on new content

Returns

NotificationConfig

NotificationConfig