Class finesse.containerservices.ContainerServices
Provide container level services for gadget developers, exposing container events by
calling a set of exposed functions. Gadgets can utilize the container dialogs and
event handling (add/remove)
Defined in: ContainerServices.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
<static> |
finesse.containerservices.ContainerServices.addHandler(notifierType, callback)
Adds an handler to this object.
|
<static> |
finesse.containerservices.ContainerServices.hideDialog()
Hides the jQuery UI Dialog
|
<static> |
finesse.containerservices.ContainerServices.init()
Initiates the Container Services.
|
<static> |
finesse.containerservices.ContainerServices.makeActiveTabReq()
Make a request to the check the current tab
|
<static> |
finesse.containerservices.ContainerServices.removeHandler(notifierType, callback)
Removes a handler from this object.
|
<static> |
finesse.containerservices.ContainerServices.showDialog(options)
Shows the jQuery UI Dialog with the specified parameters and the
following defaults:
- The only button "Ok" closes the dialog
- Modal
- Not draggable
- Fixed size
|
<static> |
finesse.containerservices.ContainerServices.tabVisible()
Returns the visibility of current gadget
|
Method Detail
<static>
finesse.containerservices.ContainerServices.addHandler(notifierType, callback)
Adds an handler to this object.
- Parameters:
- {String} notifierType
- The type of notifier to add to ('tabVisible')
- {Function} callback
- The function callback to invoke.
<static>
{jQuery}
finesse.containerservices.ContainerServices.hideDialog()
Hides the jQuery UI Dialog
- Returns:
- {jQuery} jQuery wrapped object of the dialog DOM element
<static>
{Object}
finesse.containerservices.ContainerServices.init()
Initiates the Container Services.
- Returns:
- {Object} The ContainerServices instance
<static>
finesse.containerservices.ContainerServices.makeActiveTabReq()
Make a request to the check the current tab
<static>
finesse.containerservices.ContainerServices.removeHandler(notifierType, callback)
Removes a handler from this object.
- Parameters:
- {String} notifierType
- The type of notifier to remove ('tabVisible')
- {Function} callback
- The function to remove.
<static>
{jQuery}
finesse.containerservices.ContainerServices.showDialog(options)
Shows the jQuery UI Dialog with the specified parameters and the
following defaults:
- The only button "Ok" closes the dialog
- Modal
- Not draggable
- Fixed size
- Parameters:
- {Object} options
- An object containing additional options for the dialog.
- {String/Boolean} options.title
- Title to use. undefined defaults to "Cisco Finesse". false to hide
- {Function} options.close
- A function to invoke when the dialog is closed.
- {String} options.message
- The message to display in the dialog. Defaults to "A generic error has occurred."
- {Boolean} options.isBlocking
- Flag indicating whether this dialog will block other dialogs from being shown.
- Returns:
- {jQuery} jQuery wrapped object of the dialog DOM element
<static>
{Boolean}
finesse.containerservices.ContainerServices.tabVisible()
Returns the visibility of current gadget
- Returns:
- {Boolean} The visibility of current gadget