Notification

lumin. Notification

new Notification()

Default constructor

Classes

NotificationActivateGlyph
NotificationDismissGlyph
NotificationSound

Methods

getActivateButtonGlyph() → {lumin.Notification.NotificationActivateGlyph}

Returns:

the glyph used for the activate button

Type
lumin.Notification.NotificationActivateGlyph

getActivateButtonText() → {string}

Returns:

the text used on the activate button

Type
string

getActivatePayload() → {string}

Returns:

the custom data of the notification

Type
string

getDetailedMessage() → {string}

Returns:

the detailed message in the notification

Type
string

getDismissButtonGlyph() → {lumin.Notification.NotificationDismissGlyph}

Returns:

the glyph used with the dismiss button

Type
lumin.Notification.NotificationDismissGlyph

getDismissButtonText() → {string}

Returns:

the text used on the dismiss button

Type
string

getIconModelPath() → {string}

Returns:

the path of the icon model file

Type
string

getIconTexturePath() → {string}

Returns:

the path of the icon texture file

Type
string

getIsExclusiveNotification() → {boolean}

Returns:

true if this is an exclusive notification, false otherwise

Type
boolean

getNotificationSound() → {lumin.Notification.NotificationSound}

Returns:

the notification sound

Type
lumin.Notification.NotificationSound

getSummarizedMessage() → {string}

Returns:

the summarized message in the notification

Type
string

getTitle() → {string}

Returns:

the title of the notification

Type
string

setActivateAction(action)

Set the callback for the action performed when the notification is activated

Parameters:
Name Type Description
action callable

the callback to run on activate

setActivateButtonGlyph(glyph)

Set the glyph used for the activate button

Parameters:
Name Type Description
glyph lumin.Notification.NotificationActivateGlyph

the glyph used for the activate button

setActivateButtonText(activateText)

Set the text used in the activate button

Parameters:
Name Type Description
activateText string

the text to use on the activate button

setActivatePayload(activatePayload)

Set the custom data of the notification

Parameters:
Name Type Description
activatePayload string

the custom data to set

setDetailedMessage(message)

Set the detailed version of the notification message

Parameters:
Name Type Description
message string

the detailed message

setDismissAction(action)

Set the callback for the action performed when the notification is dismissed

Parameters:
Name Type Description
action callable

the callback to run on dismiss

setDismissButtonGlyph(glyph)

Set the glyph used for the dismiss button

Parameters:
Name Type Description
glyph lumin.Notification.NotificationDismissGlyph

the glyph used for the dismiss button

setDismissButtonText(dismissText)

Set the text used for the dismiss button

Parameters:
Name Type Description
dismissText string

the text used on the dismiss button

setIconModelPath(iconModelPath)

Set the path of the icon model used in the notification

Parameters:
Name Type Description
iconModelPath string

the path to the icon model file

setIconTexturePath(iconTexturePath)

Set the path of the icon texture used in the notification

Parameters:
Name Type Description
iconTexturePath string

the path to the icon texture file

setIsExclusiveNotification(isExclusiveNotification)

Set whether or not this is an exclusive notification

Parameters:
Name Type Description
isExclusiveNotification boolean

true for an exclusive notification, false otherwise

setNotificationSound(notificationSound)

Set the sound to use when the notification is shown

Parameters:
Name Type Description
notificationSound lumin.Notification.NotificationSound

the sound to use with the notification

setSummarizedMessage(message)

Set the brief version of the notification message

Parameters:
Name Type Description
message string

the brief message

setTitle(title)

Set the title of the notification

Parameters:
Name Type Description
title string

the title of the notification