NotificationConfig
Configuration Object for notifications.
Methods
addUsersWithIds
addUsersWithIds(
pUserIds):NotificationConfig
Add userIds of the users to get notified.
Parameters
string[]Array of user ids. 'null' for notification to the current user (default behaviour).
Returns
NotificationConfigNotificationConfig
addUserWithId
addUserWithId(
pUserId):NotificationConfig
Add userIds of a user that is to be notified.
Parameters
string | number | booleanthe user id to add
Returns
NotificationConfigNotificationConfig
caption
caption(
pCaption):NotificationConfig
Sets the caption of the notification.
Parameters
string | number | booleanthe caption
Returns
NotificationConfigNotificationConfig
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
string | number | booleanthe content id
Returns
NotificationConfigNotificationConfig
daysToLive
daysToLive(
pDaysToLive):NotificationConfig
Sets the days the notification is supposed lives. -1 is infinite.
Parameters
numberthe number of days
Returns
NotificationConfigNotificationConfig
description
description(
pDescription):NotificationConfig
Sets the description of the notification.
Parameters
string | number | booleanthe description
Returns
NotificationConfigNotificationConfig
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
Returns
NotificationConfigNotificationConfig
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
string | number | booleanthe image info
Returns
NotificationConfigNotificationConfig
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
Returns
NotificationConfigNotificationConfig
linkInfo
linkInfo(
pLinkInfo):NotificationConfig
Sets the info parameter for the open-process (json format). Only possible with text.encodeMS(["contextName", "datasetid"]);
Parameters
string | number | booleanthe link info
Returns
NotificationConfigNotificationConfig
notificationSubCategory
notificationSubCategory(
pSubcategory):NotificationConfig
Sets the subcategory of the notification, can be any String.
Parameters
string | number | booleanthe category
Returns
NotificationConfigNotificationConfig
notificationType
notificationType(
pType):NotificationConfig
Sets the type of the notification, can be any type, defined in notificationtypes.
Parameters
string | number | booleanthe type
Returns
NotificationConfigNotificationConfig
originatorName
originatorName(
pOriginatorName):NotificationConfig
Sets the name of the originator in the notification popup.
Parameters
string | number | booleanthe name of the originator
Returns
NotificationConfigNotificationConfig
remindAgainOnNewContent
remindAgainOnNewContent(
pRemindAgainOnNewContent):NotificationConfig
Decide whether the notification should appear again when the contents are changed
Parameters
booleantrue to remind again on new content
Returns
NotificationConfigNotificationConfig