com.atlassian.gadgets.dashboard.internal.rest
Interface DeleteGadgetHandler

All Known Implementing Classes:

DeleteGadgetHandlerImpl

public interface DeleteGadgetHandler

Interface for removing a gadget from a live dashboard.

Method Summary

javax.ws.rs.core.Response

deleteGadget(com.atlassian.gadgets.dashboard.DashboardId dashboardId, com.atlassian.gadgets.GadgetRequestContext gadgetRequestContext, com.atlassian.gadgets.GadgetId gadgetId) Removes the specified gadget from the specified dashboard.

Method Detail

deleteGadget

javax.ws.rs.core.Response deleteGadget(com.atlassian.gadgets.dashboard.DashboardId dashboardId,
                                       com.atlassian.gadgets.GadgetRequestContext gadgetRequestContext,
                                       com.atlassian.gadgets.GadgetId gadgetId)

Removes the specified gadget from the specified dashboard.

Parameters:

dashboardId - the dashboard hosting the gadget

gadgetRequestContext - the context of this request

gadgetId - the gadget to remove

Returns:

a Response for the client with details on success or failure