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

All Known Implementing Classes:

ChangeGadgetColorHandlerImpl

public interface ChangeGadgetColorHandler

Interface for changing the color of a gadget on a dashboard.

Method Summary

javax.ws.rs.core.Response

setGadgetColor(com.atlassian.gadgets.dashboard.DashboardId dashboardId, com.atlassian.gadgets.GadgetRequestContext gadgetRequestContext, com.atlassian.gadgets.GadgetId gadgetId, com.atlassian.gadgets.dashboard.Color color) Sets the color of the specified gadget to the specified color.

Method Detail

setGadgetColor

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

Sets the color of the specified gadget to the specified color.

Parameters:

dashboardId - the dashboard hosting the gadget

gadgetRequestContext - the context of this request

gadgetId - the ID of the gadget to change

color - the new color of the gadget

Returns:

a Response for the client with details on the success or failure