Namespace SSB
SSB - Site Specific Browsing API Singleton Object
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Field Attributes | Field Name and Description |
|---|---|
| <static> {String} |
SSB.version
The client's version string.
|
| <static> {Boolean} |
SSB.visible
A flag telling us whether the Site-Specific-Browser is currenty visible.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> {void} |
SSB.ensureVisible()
Ensures that the bubble is visible.
|
| <static> {void} |
SSB.notify(width, height, delay, transparent, transparent)
Popup an interactive HTML notification window from the system-tray area (Toaster style).
|
| <static> {void} |
SSB.setIcon(iconUrl)
Set the SSB's Tray Icon
|
| <static> {void} |
SSB.simpleNotify(text, link)
A simpler version of the notify method, uses a fixed design with variable content.
|
Field Detail
<static>
{String}
SSB.version
The client's version string. E.g. 'Bubbles 2.0'
<static>
{Boolean}
SSB.visible
A flag telling us whether the Site-Specific-Browser is currenty visible. The other option is that it's minimized/hidden.
Method Detail
<static>
{void}
SSB.ensureVisible()
Ensures that the bubble is visible. useful when responding to context-menu
clicks and any action that may take place when the bubble is potentially
minimized.
- Returns:
- {void}
<static>
{void}
SSB.notify(width, height, delay, transparent, transparent)
Popup an interactive HTML notification window from the system-tray area (Toaster style).
- Parameters:
- {Integer} width
- The width of your notification window
- {Integer} height
- The height of your notification window
- {Integer} delay
- The delay in seconds that your notification should stay on screen. There is an enforced range of 3 to 15 seconds.
- {String} transparent
- You can specify a color that will be color-keyed as transparent in your notification window. For example, specify 'color(255,255,255)' and any white pixel in your notification window will become transparent. Yes, you can use animated GIFs and even Flash to do some amazing things here.
- transparent
- Returns:
- {void}
<static>
{void}
SSB.setIcon(iconUrl)
Set the SSB's Tray Icon
- Parameters:
- {url} iconUrl
- URL of the icon. The icon file must be a standard .ico file
- Returns:
- {void}
<static>
{void}
SSB.simpleNotify(text, link)
A simpler version of the notify method, uses a fixed design with variable content.
- Parameters:
- {String} text
- The text to be displayed in the notification window
- {String} link
- Need to perform an action in response to a user click? provie an url or a 'javascript:<YOUR_CODE>' url.
- Returns:
- {void}