Package com.atlassian.gadgets.plugins

Interface DashboardItemModule

public interface DashboardItemModule
Inline dashboard item to render directly on the dashboard rather than via opensocial iframes.

  • Field Details

    • ALWAYS_TRUE_CONDITION

      static final com.atlassian.plugin.web.Condition ALWAYS_TRUE_CONDITION

  • Method Details

    • getDirectoryDefinition

      io.atlassian.fugue.Option<DashboardItemModule.DirectoryDefinition> getDirectoryDefinition()
      Returns the description of this dashboard item.

    • isConfigurable

      boolean isConfigurable()
      Return true if this dashboarditem requires configuration to be entered by the user

    • getAMDModule

      io.atlassian.fugue.Option<String> getAMDModule()
      Returns:
      an AMD module to call on the client side when rendering this dashboard item. May not be defined for server-side dashboard items.

    • getWebResourceKey

      io.atlassian.fugue.Option<String> getWebResourceKey()
      Returns:
      Key of the WebResource associated with this gadget. It will be asynchronously downloaded before gadget is initialized.

    • renderContent

      void renderContent(Writer writer, Map<String,Object> context)
      Renders server side content for the dashboard item. This may not write anything if the dashboard item is to be rendered entirely on the client-side.
      The context should contain user preferences stored for the dashboard item to render.

    • getCondition

      @Nonnull com.atlassian.plugin.web.Condition getCondition()
      Returns:
      the condition, which is checks if the dashboard item should be rendered. If no condition was defined in XML descriptor, this method should return ALWAYS_TRUE_CONDITION.