Class Index | File Index

Classes


Built-In Namespace _global_

Field Summary
Field Attributes Field Name and Description
 
 
 
How long the toaster will be displayed by default.
 
Icon Color mapping for state status
 
ICON_PATH constant for holding path icon images
 
PERMISSION_DEFAULT constant for default string
 
PERMISSION_DENIED constant for denied string
 
PERMISSION_GRANTED constant for granted string
Method Summary
Method Attributes Method Name and Description
 
_add(id, handler)
 
_addToasterListeners(notification, options, toasterTimer)
This method will add onclick and onerror listener to Notification.
 
_clear(id)
 
_createNotification(title, options)
_createNotification creates Notification instance
 
_dismiss(popoverId)
Requests Finesse to dismiss the notification popover.
 
_display(isExistingPopover, popoverId, payload, actionHandler)
Requests Finesse to show notification popover with the given payload.
 
 
 
_processChannelRequest(channelId, action, success, error, data, menuHandler)
 
This method will request permission to display Toaster.
 
 
_setAutoClose(notification, autoClose)
_setAutoClose set the auto close time for toaster, it checks if client code passed custom time out for the toaster, otherwise it set the AUTO_CLOSE_TIME
 
callback(param)
 
define(name, deps, callback)
 
logToConsole(str, error)
 
main(name, deps, callback, relName)
 
makeMap(name, relName)
Makes a name map, normalizing the name, and using a plugin for normalization if necessary.
 
 
processResponse(response)
 
req(deps, callback, relName, forceSync, alt)
Field Detail
_menuHandlerRegistry

Defined in: finesse.js.

_requestCallBackRegistry

Defined in: finesse.js.

AUTO_CLOSE_TIME
How long the toaster will be displayed by default. Default timeout is 8 seconds
Defined in: finesse.js.

ICON_COLOR
Icon Color mapping for state status
Defined in: finesse.js.

ICON_PATH
ICON_PATH constant for holding path icon images
Defined in: finesse.js.

PERMISSION_DEFAULT
PERMISSION_DEFAULT constant for default string
Defined in: finesse.js.

PERMISSION_DENIED
PERMISSION_DENIED constant for denied string
Defined in: finesse.js.

PERMISSION_GRANTED
PERMISSION_GRANTED constant for granted string
Defined in: finesse.js.
Method Detail
_add(id, handler)

Defined in: finesse.js.
Parameters:
id
handler

_addToasterListeners(notification, options, toasterTimer)
This method will add onclick and onerror listener to Notification. on click of toaster the gadget which originally had focus may loose the focus. To get the back the focus on any element inside the gadget use the on click callback handler.
Defined in: finesse.js.
Parameters:
{Object} notification
window.Notification that creates Html5 Notification.
{Object} options
JSON object for notification options.
toasterTimer

_clear(id)

Defined in: finesse.js.
Parameters:
id

_createNotification(title, options)
_createNotification creates Notification instance
Defined in: finesse.js.
Parameters:
{String} title
title string should be displayed in the Toaster
{Object} options
JSON object for notification options.

_dismiss(popoverId)
Requests Finesse to dismiss the notification popover.
Defined in: finesse.js.
Parameters:
{String} popoverId
Popover id which was returned from showPopover call
Throws:
Error Throws error if the service is not yet initialized.

_display(isExistingPopover, popoverId, payload, actionHandler)
Requests Finesse to show notification popover with the given payload. The user interaction or timeout of the popover will be notified to gadget through the registered action handler.
Defined in: finesse.js.
Parameters:
{Boolean} isExistingPopover
If Update or new Show operation .
{String} popoverId
Popover Id
{Object} payload
Action data JSON object as per the spec.
{Function} actionHandler
Callback function invoked when the user interacts with the popover or popover times out.
Throws:
Error Throws error when the passed in popoverData is not as per defined format.

_initTimerForTimeout(_uid)

Defined in: finesse.js.
Parameters:
_uid

_processChannelOperationResult(payload)

Defined in: finesse.js.
Parameters:
payload

_processChannelRequest(channelId, action, success, error, data, menuHandler)

Defined in: finesse.js.
Parameters:
channelId
action
success
error
data
menuHandler

_requestPermission()
This method will request permission to display Toaster.
Defined in: finesse.js.

_requestTimedOutHandler(_uid)

Defined in: finesse.js.
Parameters:
_uid

_setAutoClose(notification, autoClose)
_setAutoClose set the auto close time for toaster, it checks if client code passed custom time out for the toaster, otherwise it set the AUTO_CLOSE_TIME
Defined in: finesse.js.
Parameters:
{Object} notification
window.Notification that creates Html5 Notification.
{String} autoClose
autoClose time of the Toaster
Returns:
toasterTimeout Toaster Timeout

callback(param)

Defined in: finesse.js.
Parameters:
param

define(name, deps, callback)

Defined in: finesse.js.
Parameters:
name
deps
callback

logToConsole(str, error)

Defined in: finesse.js.
Parameters:
str
error

main(name, deps, callback, relName)

Defined in: finesse.js.
Parameters:
name
deps
callback
relName

makeMap(name, relName)
Makes a name map, normalizing the name, and using a plugin for normalization if necessary. Grabs a ref to plugin too, as an optimization.
Defined in: finesse.js.
Parameters:
name
relName

processMediaStateChange(media)

Defined in: finesse.js.
Parameters:
media

processResponse(response)

Defined in: finesse.js.
Parameters:
response

req(deps, callback, relName, forceSync, alt)

Defined in: finesse.js.
Parameters:
deps
callback
relName
forceSync
alt

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Jan 02 2019 11:05:17 GMT-0500 (EST)