com.atlassian.gadgets.view

Interface RenderedGadgetUriBuilder

public interface RenderedGadgetUriBuilder

Builds URLs to the rendered gadget.

Method Summary

Modifier and Type	Method and Description
URI	build(GadgetState gadgetState, ModuleId moduleId, View view, GadgetRequestContext gadgetRequestContext) Returns the URL to the rendered gadget.
URI	build(GadgetState gadgetState, View view, GadgetRequestContext gadgetRequestContext) Deprecated. as of 2.0, use build(GadgetState, ModuleId, View, GadgetRequestContext)

Method Detail

build

@Deprecated
URI build(GadgetState gadgetState,
                      View view,
                      GadgetRequestContext gadgetRequestContext)

Deprecated. as of 2.0, use build(GadgetState, ModuleId, View, GadgetRequestContext)

Returns the URL to the rendered gadget.

Parameters:

gadgetState - gadget used to insert the gadget's spec URL

view - the view to render the gadget in

gadgetRequestContext - context for this request

Returns:

URL to the rendered gadget

build

URI build(GadgetState gadgetState,
          ModuleId moduleId,
          View view,
          GadgetRequestContext gadgetRequestContext)

Returns the URL to the rendered gadget.

Parameters:

gadgetState - gadget used to insert the gadget's spec URL

moduleId - the moduleId to use in the URL. Should be unique for the HTML page that the gadget will be rendered in.

view - the view to render the gadget in

gadgetRequestContext - context for this request

Returns:

URL to the rendered gadget

Since:

2.0