Module: explorer/widgets/gadgetarea/GadgetArea

explorer/widgets/gadgetarea/GadgetArea

Contains the space where the gadget renders.
Source:
See:

Extends

  • dijit/_WidgetBase
  • dijit/_TemplatedMixin

Methods

addMenuItems()

Adds menu items to the gadget menu. Sub-classes can override this method to add additional menus.
Source:

closeOpenSite()

Closes the currently open gadget site.
Source:

createDialog(title, viewTarget)

Creates a modal dialog. Typically used when handling open-views requests from the gadget.
Parameters:
Name Type Description
title String The title to give the dialog.
viewTarget String Should be one of the view targets defined in the OpenSocial spec.
Source:

createNodeForSite() → {Element}

Creates a DOM node to use for the gadget site.
Source:
Returns:
A DOM node.
Type
Element

createSite()

Creates an gadget site.
Source:
See:
Returns:
Returns a new gadget site.

destroy()

Destroys this widget.
Source:
See:

getExplorerContainer()

Gets the module:explorer/widgets/ExplorerContainer.
Source:

renderEmbeddedExperience(url, dataModel) → {module:dojo/promise/Promise}

Renders an embedded experience.
Parameters:
Name Type Description
url String The URL where the embedded experience is located.
dataModel String A stringified JSON object containing just the context property from the embedded experiences data model. The gadget property of the embedded experiences data model will be the URL parameter.
Source:
Returns:
Returns a Dojo Promise. Call the then method of this Promise with a function that takes in one parameter, the gadget metadata and the osapi.container.GadgetSite|gadget site.
Type
module:dojo/promise/Promise

renderGadget(url, opt_renderParams) → {module:dojo/promise/Promise}

Renders the gadget given its URL.
Parameters:
Name Type Argument Description
url String The URL where the gadget is located.
opt_renderParams Object <optional>
 Optional parameter used by the container, see the OpenSocial spec for more details about how this object should be constructed.
Source:
Returns:
Returns a Dojo Promise. Call the then method of this Promise with a function that takes in one parameter, the gadget metadata.
Type
module:dojo/promise/Promise

reRenderGadget(opt_renderParams)

Rerenders the currently rendered gadget.
Parameters:
Name Type Argument Description
opt_renderParams Object <optional>
 Optional render params. See OpenSocial spec for more details about how this object should be constructed.
Source:

setupEventListeners()

Sets up event listeners for this class. Override this method to add additional event listeners.
Source:

setupSubscriptions()

Setups topic subscriptions for this class.
Source:

startup()

Called right after this widget has been added to the DOM.
Source:
See:

updateContainerSecurityToken(token, ttl)

Updates the container security token and forces a refresh of all of the gadget security tokens to ensure owner/viewer information is up-to-date.
Parameters:
Name Type Description
token String The security token.
ttl Number The time to live for the security token.
Source: