Package com.cheetahdigital.household.core.api

Class HouseholdAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.household.core.api.HouseholdAPI

All Implemented Interfaces:

RestController

public class HouseholdAPI
extends Controller

Class for setting the query parameters of Household 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
HouseholdAPI()

Method Summary

Modifier and Type	Method	Description
void	addChild(HouseholdParams householdParams, HouseholdFields householdFields, Listener<SuccessResponse> listener)	Add existing member to household member
void	createChild(HouseholdParams householdParams, HouseholdFields householdFields, Listener<SuccessResponse> listener)	Create a new household member
void	removeChild(HouseholdParams householdParams, HouseholdFields householdFields, Listener<SuccessResponse> listener)	Remove a member from the household

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

HouseholdAPI

public HouseholdAPI()

Method Detail

createChild

public void createChild(HouseholdParams householdParams,
                        HouseholdFields householdFields,
                        Listener<SuccessResponse> listener)

Create a new household member

Parameters:

householdParams - HouseholdParams for Household API

householdFields - HouseholdFields for Household API

listener - handles failure or successful response

addChild

public void addChild(HouseholdParams householdParams,
                     HouseholdFields householdFields,
                     Listener<SuccessResponse> listener)

Add existing member to household member

Parameters:

householdParams - HouseholdParams for Household API

householdFields - HouseholdFields for Household API

listener - handles failure or successful response

removeChild

public void removeChild(HouseholdParams householdParams,
                        HouseholdFields householdFields,
                        Listener<SuccessResponse> listener)

Remove a member from the household

Parameters:

householdParams - HouseholdParams for Household API

householdFields - HouseholdFields for Household API

listener - handles failure or successful response