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

All Known Implementing Classes:

UpdateGadgetUserPrefsHandlerImpl

public interface UpdateGadgetUserPrefsHandler

Interface for updating the values of user prefs in an active gadget.

Method Summary

javax.ws.rs.core.Response

updateUserPrefs(DashboardId dashboardId, GadgetRequestContext gadgetRequestContext, GadgetId gadgetId, javax.ws.rs.core.MultivaluedMap<String,String> queryParams) Changes the user prefs on the specified gadget and dashboard to the values supplied by the query.

Method Detail

updateUserPrefs

javax.ws.rs.core.Response updateUserPrefs(DashboardId dashboardId,
                                          GadgetRequestContext gadgetRequestContext,
                                          GadgetId gadgetId,
                                          javax.ws.rs.core.MultivaluedMap<String,String> queryParams)

Changes the user prefs on the specified gadget and dashboard to the values supplied by the query.

Parameters:

dashboardId - the ID of the dashboard hosting the gadget

gadgetRequestContext - the context of this request

gadgetId - the gadget to change the prefs for

queryParams - the user prefs with their updated values

Returns:

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