ssCore.Tray.showBalloon

Display a balloon tip above the system tray icon with custom text, title and icon.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

text - Text to be displayed in the balloon tip. Newline characters ('\n') in the balloon tip text allow you to create multi-line balloon tips.

title - [Optional] - The title you provide will appear at the top of the balloon tip, if the operating system supports it.

timeout - [Optional] - A period (in milliseconds) after which the balloon top will automatically be closed. The timeout value, in milliseconds, for the balloon tip. Windows enforces minimum and maximum timeout valuesof 10 seconds and 30 seconds, respectively. These values may change in future versions of Windows. You can close a balloon time before the 10 second minimum by calling Tray.hideBalloon.

icon - [Optional] - Type of icon to be displayed in the balloon tip if the operating system supports icons in balloon tips. The icon will not be displayed unless the balloon tip also has a title. Valid values include: error, info, and warning.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Tray.showBalloon( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Tray.showBalloon( paramsObject );


Notes:

None.


Examples:

ssCore.Tray.showBalloon({text:"This is a system tray balloon tip", title:"The Title", icon:"info"});