Package com.cheetahdigital.offers.core.api

Class OffersAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.offers.core.api.OffersAPI

All Implemented Interfaces:

RestController

public class OffersAPI
extends Controller

Class for setting the query parameters of Offers API. All Nullable parameters means you can remove the parameter by passing a null value.

Field Summary

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

STANDARD_DATE_FORMAT, TIMEZONE_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
OffersAPI()

Method Summary

Modifier and Type	Method	Description
void	clipOffer(OfferParams offerParams, Listener<SuccessResponse> listener)	Clip an offer.
void	clipOfferResponse(OfferParams offerParams, Listener<SuccessResponse> listener)	Clip offer response.
void	getFavoriteOffers(OfferParams offerParams, boolean clearCache, ListenerModel<BaseModel<Offers>,Offers> listener)	Get All Favorited Offers
void	getOffer(OfferParams offerParams, boolean clearCache, ListenerModel<BaseModel<Offer>,Offer> listener)	Get Offer API.
void	getOfferCategories(OfferParams offerParams, boolean clearCache, ListenerModel<BaseModel<OfferCategories>,OfferCategories> listener)	List all available offer categories
void	getOfferResponse(OfferParams offerParams, boolean clearCache, ListenerModel<BaseModel<OfferResponse>,OfferResponse> listener)	Get an offer responses by id
void	getOfferResponses(OfferParams offerParams, boolean clearCache, ListenerModel<BaseModel<OfferResponses>,OfferResponses> listener)	Get all offer responses
void	getOffers(OfferParams offerParams, boolean clearCache, ListenerModel<BaseModel<Offers>,Offers> listener)	Get Offers
void	getOffersWithResponses(OfferParams offerParams, boolean clearCache, ListenerModel<BaseModel<Offers>,Offers> listener)	Get Offers with Responses
void	getPublicOffers(boolean clearCache, Listener<java.util.List<Offer>> listener)	Get All Public Offers
void	respondToOffer(OfferParams offerParams, ListenerModel<BaseModel<OfferResponse>,OfferResponse> listener)	Respond to an offer.
void	setOfferAsDismissed(OfferParams offerParams, Listener<SuccessResponse> listener)	Dismiss an offer.
void	setOfferAsFavorited(OfferParams offerParams, Listener<SuccessResponse> listener)	Favorite an offer.
void	setOfferAsUndismiss(OfferParams offerParams, Listener<SuccessResponse> listener)	Undismiss an offer.
void	setOfferAsUnfavorited(OfferParams offerParams, Listener<SuccessResponse> listener)	Unfavorite an offer.
void	unclipOffer(OfferParams offerParams, Listener<SuccessResponse> listener)	Unclip an offer.
void	unclipOfferResponse(OfferParams offerParams, Listener<SuccessResponse> listener)	Unclip offer response.

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

OffersAPI

public OffersAPI()

Method Detail

getOffer

public void getOffer(OfferParams offerParams,
                     boolean clearCache,
                     ListenerModel<BaseModel<Offer>,Offer> listener)

Get Offer API. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

clearCache - clear previously stored cache

listener - handles failure or successful response

getOffers

public void getOffers(OfferParams offerParams,
                      boolean clearCache,
                      ListenerModel<BaseModel<Offers>,Offers> listener)

Get Offers

Parameters:

offerParams - the OfferParams for Offers API

clearCache - clear previously stored cache

listener - listener if offer is successfully received

getPublicOffers

public void getPublicOffers(boolean clearCache,
                            Listener<java.util.List<Offer>> listener)

Get All Public Offers

Parameters:

clearCache - clear previously stored cache

listener - listener if offer is successfully received

getFavoriteOffers

public void getFavoriteOffers(OfferParams offerParams,
                              boolean clearCache,
                              ListenerModel<BaseModel<Offers>,Offers> listener)

Get All Favorited Offers

Parameters:

offerParams - the OfferParams for Offers API

clearCache - clear previously stored cache

listener - callback for receiving response

getOfferResponses

public void getOfferResponses(OfferParams offerParams,
                              boolean clearCache,
                              ListenerModel<BaseModel<OfferResponses>,OfferResponses> listener)

Get all offer responses

Parameters:

offerParams - the OfferParams for Offers API

clearCache - clear previously stored cache

listener - listener if offer response is successfully received

getOfferResponse

public void getOfferResponse(OfferParams offerParams,
                             boolean clearCache,
                             ListenerModel<BaseModel<OfferResponse>,OfferResponse> listener)

Get an offer responses by id

Parameters:

offerParams - the OfferParams for Offers API

clearCache - clear previously stored cache

listener - listener for getting offer response object

respondToOffer

public void respondToOffer(OfferParams offerParams,
                           ListenerModel<BaseModel<OfferResponse>,OfferResponse> listener)

Respond to an offer. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

listener - listener if offer is successfully received

setOfferAsFavorited

public void setOfferAsFavorited(OfferParams offerParams,
                                Listener<SuccessResponse> listener)

Favorite an offer. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

listener - listener if offer is successfully favorited

setOfferAsUnfavorited

public void setOfferAsUnfavorited(OfferParams offerParams,
                                  Listener<SuccessResponse> listener)

Unfavorite an offer. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

listener - listener if offer is successfully unfavorited

getOfferCategories

public void getOfferCategories(OfferParams offerParams,
                               boolean clearCache,
                               ListenerModel<BaseModel<OfferCategories>,OfferCategories> listener)

List all available offer categories

Parameters:

offerParams - query params for offers API

clearCache - clear previously stored cache

listener - listener if offer category is successfully received

clipOffer

public void clipOffer(OfferParams offerParams,
                      Listener<SuccessResponse> listener)

Clip an offer. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

listener - listener if offer is successfully clipped

unclipOffer

public void unclipOffer(OfferParams offerParams,
                        Listener<SuccessResponse> listener)

Unclip an offer. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

listener - listener if offer is successfully unclipped

setOfferAsDismissed

public void setOfferAsDismissed(OfferParams offerParams,
                                Listener<SuccessResponse> listener)

Dismiss an offer. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

listener - listener if offer is successfully dismissed

setOfferAsUndismiss

public void setOfferAsUndismiss(OfferParams offerParams,
                                Listener<SuccessResponse> listener)

Undismiss an offer. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

listener - listener if offer is successfully undismissed

clipOfferResponse

public void clipOfferResponse(OfferParams offerParams,
                              Listener<SuccessResponse> listener)

Clip offer response. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

listener - listener if offer is successfully clipped

unclipOfferResponse

public void unclipOfferResponse(OfferParams offerParams,
                                Listener<SuccessResponse> listener)

Unclip offer response. Remember to set the id by BaseParams.setId(String)

Parameters:

offerParams - the OfferParams for Offers API

listener - listener if offer is successfully unclipped

getOffersWithResponses

public void getOffersWithResponses(OfferParams offerParams,
                                   boolean clearCache,
                                   ListenerModel<BaseModel<Offers>,Offers> listener)

Get Offers with Responses

Parameters:

offerParams - the OfferParams for Offers API

clearCache - clear previously stored cache

listener - listener if Offers with Responses are successfully received