virtualcityMAP 3.6

Class: Notifier

vcs.ui.notifications.Notifier

A Notifier keeps track of notifications called on it. There is a Notifier attached to the vcm.ui.Content, which can be access through the mixins notifyError, notifyInfo, notifySuccess methods.

new vcs.ui.notifications.Notifier(options)

Name Type Description
options vcs.ui.notifications.Notifier.Options

Members

maxLength{number}

the number of notification to keep in the log

notifications{Array.<vcs.ui.notifications.Notification>}

The notification log, newest first.

timeout{number}

the number of milliseconds to keep a notification in the log

Methods

error(message, action){number}

Name Type Description
message string
action NotificationAction
Returns:
  • the notifications id

info(message, action){number}

Name Type Description
message string
action NotificationAction
Returns:
  • the notifications id

success(message, action){number}

Name Type Description
message string
action NotificationAction
Returns:
  • the notifications id

Type Definitions

vcs.ui.notifications.Notifier.Options{Object}

Properties:
Name Type Argument Default Description
maxLength number <optional>
 3

the number of notification to keep in the log
timeout number <optional>
 10000

the number of milliseconds to keep a notification in the log