Package com.cheetahdigital.preferences.core.api

Class PreferencesAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.preferences.core.api.PreferencesAPI

All Implemented Interfaces:

RestController

public class PreferencesAPI
extends Controller

Cheetah Loyalty Preferences Module

API Controller class for Preferences

Field Summary

Fields inherited from class com.cheetahdigital.corekit.models.module.Controller

STANDARD_DATE_FORMAT, TIMEZONE_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
PreferencesAPI()

Method Summary

Modifier and Type	Method	Description
void	addPreference(PreferencesParams preferencesParams, PreferencesFields preferencesFields, Listener<SuccessResponse> listener)	Add new preference
void	getPreferences(PreferencesParams preferencesParams, boolean clearCache, ListenerModel<BaseModel<java.util.List<Preference>>,java.util.List<Preference>> listener)	Get the preferences
void	removePreference(PreferencesParams preferencesParams, PreferencesFields preferencesFields, Listener<SuccessResponse> listener)	Remove specified preference
void	updatePreferences(PreferencesParams preferencesParams, PreferencesFields preferencesFields, Listener<SuccessResponse> listener)	Update the preferences

Methods inherited from class com.cheetahdigital.corekit.models.module.Controller

createCache, createHttpClient, createRetrofitInterface, evictAllCache, getGsonConfiguration, getRestAdapter, getTimeoutConnectionInSeconds, getTimeoutSocketInSeconds, initialize, removeResponsesFromCache

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreferencesAPI

public PreferencesAPI()

Method Detail

getPreferences

public void getPreferences(PreferencesParams preferencesParams,
                           boolean clearCache,
                           ListenerModel<BaseModel<java.util.List<Preference>>,java.util.List<Preference>> listener)

Get the preferences

Parameters:

preferencesParams - the PreferencesParams for Preferences API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

updatePreferences

public void updatePreferences(PreferencesParams preferencesParams,
                              PreferencesFields preferencesFields,
                              Listener<SuccessResponse> listener)

Update the preferences

Parameters:

preferencesParams - the PreferencesParams for Preferences API

preferencesFields - the PreferencesFields for Preferences API

listener - callback to handle the results

addPreference

public void addPreference(PreferencesParams preferencesParams,
                          PreferencesFields preferencesFields,
                          Listener<SuccessResponse> listener)

Add new preference

Parameters:

preferencesParams - the PreferencesParams for Preferences API

preferencesFields - the PreferencesFields for Preferences API

listener - callback to handle the results

removePreference

public void removePreference(PreferencesParams preferencesParams,
                             PreferencesFields preferencesFields,
                             Listener<SuccessResponse> listener)

Remove specified preference

Parameters:

preferencesParams - the PreferencesParams for Preferences API

preferencesFields - the PreferencesFields for Preferences API

listener - callback to handle the results