Class: NotificationEntry

Extends

• otris.notifications.Notification

Methods

delete()

Delete entry

getStatus(){otris.notifications.NotificationStatus}

Returns the status of the notification entry.

Returns:

Type	Description
otris.notifications.NotificationStatus	current status

getTimestamp(){Number}

Returns the timestamp of the notification entry.

Returns:

Type	Description
Number	timestamp (number of milliseconds elapsed since January 1, 1970 00:00:00 UTC)

publish()

Alias for save().

save()

Persists the notification entry

inherited setAction(action)

Set the click action of the notification

Name	Type	Description
action	otris.ScriptReturn	notification onclick action

inherited setMessage(message)

Set the notification message

Name	Type	Description
message	string	message

inherited setOnloadAction(onloadAction)

Set the onload action of the notification

Name	Type	Description
onloadAction	otris.ScriptReturn	notification onload action

inherited setProducer(user)

Set the user who produced the notification (e.g. the author of a file message)
Defaults to the current system user

Name	Type	Description
user	SystemUser	optional system user

• Since:

  • Documents 5.0d HF2

inherited setProgressValue(progressValue)

Set the current progress value for a long running task. Set a value between 0 and 100.
A value over 100 means the task is done and was successful.
A negative value indicates that the task failed.
The notification type must be set to progress.
It is also necessary to set a referenceId as a identifier for the task.

Name	Type	Description
progressValue	Number	current progress

• Since:

  • Documents 5.0e

inherited setReferenceId(referenceId)

Set a referenceId for the notification

Name	Type	Description
referenceId	string	reference id

inherited setRemoveOnAction(removeOnAction)

Remove the notification if action is executed

Name	Type	Description
removeOnAction	boolean	remove on action flag

setStatus(status)

Change the status of the notification entry.

Name	Type	Description
status	otris.notifications.NotificationStatus	new status

inherited setSticky(sticky)

Remove notification only if closed or clicked (otris.notifications.NotificationDefaults.sticky)

Name	Type	Description
sticky	boolean	sticky flag

inherited setTimeout(timeout)

Set the timeout for this notification

Name	Type	Description
timeout	number	notification timeout

inherited setTitle(title)

Set the notification title

Name	Type	Description
title	string	notification title

inherited setType(type)

Set the type of the notification

Name	Type	Description
type	string	notification type