Package com.atlassian.gadgets

This package contains the main APIs for interacting with gadgets.

See: Description

Interface Summary

Interface	Description
DashboardItemModuleId	This is the identifier for modules, which can be added to dashboard.
DashboardItemModuleIdVisitor<T>
DashboardItemState	Representation of the dashboard item state.
DashboardItemStateVisitor<T>	Visitor for implementations of DashboardItemState.
GadgetRequestContextFactory	Provides methods for constructing GadgetRequestContext instances from various sources.
GadgetSpecProvider	A simple representation of a container of gadget spec URIs.
GadgetSpecUrlChecker	Models permission and validation checks on gadget specs.
LocalGadgetSpecProvider	A provider of gadget specs that are avaiable locally, without making an HTTP request to fetch them.

Class Summary

Class	Description
GadgetId	Representation of the identifier for a particular gadget.
GadgetRequestContext	Holds information associated with a gadget request that the system will need to use.
GadgetRequestContext.Builder	A builder that facilitates construction of GadgetRequestContext objects.
GadgetRequestContext.User
GadgetState	An immutable extension of DashboardItemState.
GadgetState.Builder	A builder that allows you to set the Color and the user preferences of the GadgetState under construction.
GadgetState.SpecUriBuilder	A builder that allows you to set the spec URI of the gadget state under construction
LocalDashboardItemModuleId
LocalDashboardItemState	Represents the state of the dashboard item which is not based on Open Social specification but is based on the description provided in the plugin.
LocalDashboardItemState.Builder
OpenSocialDashboardItemModuleId

Enum Summary

Enum	Description
DashboardItemType
Vote	Votes are used in the gadget system to determine whether a user is allowed to perform certain actions, such as seeing a gadget in the gadget browser or being allowed to render a gadget on their dashboard.

Exception Summary

Exception	Description
GadgetNotFoundException	Thrown if the gadget identified by the GadgetId does not exist.
GadgetParsingException	Thrown when the gadget spec is malformed or cannot be parsed for other reasons.
GadgetSpecUriNotAllowedException	Thrown when a gadget spec URI is not valid for rendering on the dashboard.

Package com.atlassian.gadgets Description

This package contains the main APIs for interacting with gadgets.