Package com.atlassian.gadgets.plugins

Interface DashboardItemModuleDescriptor

All Superinterfaces:
com.atlassian.plugin.ModuleDescriptor<DashboardItemModule>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware
public interface DashboardItemModuleDescriptor extends com.atlassian.plugin.ModuleDescriptor<DashboardItemModule>
Module descriptor to represent a non-opensocial dashboard item that can be used to render a dashboard content inline without iframes.
This is the way of the future and eventually all opensocial gadget will be replaced by inline renderable dashboard items.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.atlassian.fugue.Option<DashboardItemModule.DirectoryDefinition>
    getDirectoryDefinition()
     
    io.atlassian.fugue.Option<String>
    getGadgetSpecUriToReplace()
     

    Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

    destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

    Methods inherited from interface com.atlassian.plugin.Resourced

    getResourceDescriptor, getResourceDescriptors, getResourceLocation

    Methods inherited from interface com.atlassian.plugin.ScopeAware

    getScopeKey

  • Method Details

    • getGadgetSpecUriToReplace

      io.atlassian.fugue.Option<String> getGadgetSpecUriToReplace()
      Returns:
      an optional gadgetspec uri to replace. If none is returned this dashbaorditem wont replace any existing gadget

    • getDirectoryDefinition

      io.atlassian.fugue.Option<DashboardItemModule.DirectoryDefinition> getDirectoryDefinition()
      Returns:
      return an optional description of the dashboard item. If none is provided, the dashboard item will used specification from getGadgetSpecUriToReplace().