CreateTrayNotification: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ {{Client function}} This functions creates a notification ballon on the desktop. ==Syntax== <syntaxhighlight lang="lua">bool createTrayNotification ( string notifi...") |
No edit summary |
||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua">bool createTrayNotification ( string notificationText, string eType, bool useSound )</syntaxhighlight> | <syntaxhighlight lang="lua">bool createTrayNotification ( string notificationText, [ string eType, bool useSound ] )</syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''notificationText:''' The text to send in the notification. | *'''notificationText:''' The text to send in the notification. | ||
===Optional Arguments=== | |||
*'''eType:''' The notification icon. Possible values are: '''"default", "info", "warning", "error"''' | *'''eType:''' The notification icon. Possible values are: '''"default", "info", "warning", "error"''' | ||
*'''userSound:''' A boolean value indicating whether or not to play a sound when receiving the notification. | *'''userSound:''' A boolean value indicating whether or not to play a sound when receiving the notification. | ||
==Returns== | ==Returns== | ||
Returns ''true'' if the notification is correctly created, ''false'' otherwise. | Returns ''true'' if the notification is correctly created, ''false'' otherwise. | ||
Revision as of 17:56, 20 October 2016
This functions creates a notification ballon on the desktop.
Syntax
bool createTrayNotification ( string notificationText, [ string eType, bool useSound ] )
Required Arguments
- notificationText: The text to send in the notification.
Optional Arguments
- eType: The notification icon. Possible values are: "default", "info", "warning", "error"
- userSound: A boolean value indicating whether or not to play a sound when receiving the notification.
Returns
Returns true if the notification is correctly created, false otherwise.