Built-In Namespace _global_

Field Summary
Field Attributes	Field Name and Description
	_menuHandlerRegistry
	_requestCallBackRegistry
	AUTO_CLOSE_TIME How long the toaster will be displayed by default.
	ICON_COLOR Icon Color mapping for state status
	ICON_PATH ICON_PATH constant for holding path icon images
	PERMISSION_DEFAULT PERMISSION_DEFAULT constant for default string
	PERMISSION_DENIED PERMISSION_DENIED constant for denied string
	PERMISSION_GRANTED PERMISSION_GRANTED constant for granted string

Method Summary
Method Attributes	Method Name and Description
	_add(id, handler)
	_addShortcutKey(newKeys)
	_addToasterListeners(notification, options, toasterTimer) This method will add onclick and onerror listener to Notification.
	_clear(id)
	_cloneEvent(keyEvent)
	_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.
	_executeShortcutKey(keyEvent) Executes the handler for particular keyevent
	_getComponentTabID(componentID)
	_getGadget(iframeId)
	_getNonConflictedShortcutKey(matchedRegisteredKeys)
	_getShortcutKeyById(keyId)
	_getShortcutKeys()
	_ignoreDuplicateRegistrationOnRealodGadget(newKeys)
	_initTimerForTimeout(_uid)
	_isKeyAlreadyExists(newKey)
	_keyupEventHandler(keyEvent)
	_markAsConflicted(alreadyExistedKeys)
	_messageHandler(e)
	_processChannelOperationResult(payload)
	_processChannelRequest(channelId, action, success, error, data, menuHandler)
	_requestPermission() This method will request permission to display Toaster.
	_requestTimedOutHandler(_uid)
	_sendKeyupEvent(keyEvent)
	_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
	_toggleGadgetExpandCollapse(type)
	_updateConflictField(accessKey, newKey)
	_validateInputParam(keys, Validator)
	_validModifierKeysPressed(keyEvent)
	callback(param)
	checkIfLogCollectionSchedulePresentInSession() To check if the log collection data is present in session Storing the log schedule data as 3 keys in session 1.isDesktopAutoLogScheduled: flag which indicates if log collection is scheduled 2.logSchedule: schedule data stored as JSON object 3.scheduledLogArrayData: contains the log data of primary server during failover, which needs to be posted to secondary server as soon as failover is completed
	define(name, deps, callback)
	getIntValue(strVal, defaultVal)
	main(name, deps, callback, relName)
	makeMap(name, relName) Makes a name map, normalizing the name, and using a plugin for normalization if necessary.
	processMediaStateChange(media)
	processResponse(response)
	req(deps, callback, relName, forceSync, alt)
	validateRequiredFields(param)

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

_addShortcutKey(newKeys)

Defined in: finesse.js.

Parameters:
newKeys

_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

_cloneEvent(keyEvent)

Defined in: finesse.js.

Parameters:
keyEvent

_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.

_executeShortcutKey(keyEvent)

Executes the handler for particular keyevent
Defined in: finesse.js.

Parameters:
keyEvent

_getComponentTabID(componentID)

Defined in: finesse.js.

Parameters:
componentID

_getGadget(iframeId)

Defined in: finesse.js.

Parameters:
iframeId

_getNonConflictedShortcutKey(matchedRegisteredKeys)

Defined in: finesse.js.

Parameters:
matchedRegisteredKeys

_getShortcutKeyById(keyId)

Defined in: finesse.js.

Parameters:
keyId

_getShortcutKeys()

Defined in: finesse.js.

_ignoreDuplicateRegistrationOnRealodGadget(newKeys)

Defined in: finesse.js.

Parameters:
newKeys

_initTimerForTimeout(_uid)

Defined in: finesse.js.

Parameters:
_uid

_isKeyAlreadyExists(newKey)

Defined in: finesse.js.

Parameters:
newKey

_keyupEventHandler(keyEvent)

Defined in: finesse.js.

Parameters:
keyEvent

_markAsConflicted(alreadyExistedKeys)

Defined in: finesse.js.

Parameters:
alreadyExistedKeys

_messageHandler(e)

Defined in: finesse.js.

Parameters:
e

_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

_sendKeyupEvent(keyEvent)

Defined in: finesse.js.

Parameters:
keyEvent

_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

_toggleGadgetExpandCollapse(type)

Defined in: finesse.js.

Parameters:
type

_updateConflictField(accessKey, newKey)

Defined in: finesse.js.

Parameters:
accessKey
newKey

_validateInputParam(keys, Validator)

Defined in: finesse.js.

Parameters:
keys
Validator

_validModifierKeysPressed(keyEvent)

Defined in: finesse.js.

Parameters:
keyEvent

callback(param)

Defined in: finesse.js.

Parameters:
param

checkIfLogCollectionSchedulePresentInSession()

To check if the log collection data is present in session Storing the log schedule data as 3 keys in session 1.isDesktopAutoLogScheduled: flag which indicates if log collection is scheduled 2.logSchedule: schedule data stored as JSON object 3.scheduledLogArrayData: contains the log data of primary server during failover, which needs to be posted to secondary server as soon as failover is completed
Defined in: finesse.js.

define(name, deps, callback)

Defined in: finesse.js.

Parameters:
name
deps
callback

getIntValue(strVal, defaultVal)

Defined in: finesse.js.

Parameters:
strVal
defaultVal

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

validateRequiredFields(param)

Defined in: finesse.js.

Parameters:
param

Classes

Built-In Namespace _global_