Package com.cheetahdigital.groups.core.api

Class GroupsAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.groups.core.api.GroupsAPI

All Implemented Interfaces:

RestController

public class GroupsAPI
extends Controller

Loyalty Groups Module A Groups represents one group of users.

Field Summary

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

STANDARD_DATE_FORMAT, TIMEZONE_DATE_FORMAT

Constructor Summary

Constructors

Constructor	Description
GroupsAPI()

Method Summary

Modifier and Type	Method	Description
void	getGroupClasses(GroupsParams groupsParams, boolean clearCache, ListenerModel<BaseModel<GroupClasses>,GroupClasses> listener)	Get the list of group classes
void	getGroupMembers(GroupsParams groupsParams, boolean clearCache, ListenerModel<BaseModel<GroupMembers>,GroupMembers> listener)	Get the list of members in the group
void	getGroups(GroupsParams groupsParams, boolean clearCache, ListenerModel<BaseModel<Groups>,Groups> listener)	Get the list of groups
void	getJoinedGroups(GroupsParams groupsParams, boolean clearCache, ListenerModel<BaseModel<Groups>,Groups> listener)	Get the list of joined groups
void	joinGroup(GroupsParams groupsParams, ListenerModel<BaseModel<GroupJoinLeaveResponse>,GroupJoinLeaveResponse> listener)	Join group
void	leaveGroup(GroupsParams groupsParams, ListenerModel<BaseModel<GroupJoinLeaveResponse>,GroupJoinLeaveResponse> listener)	Leave group

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

GroupsAPI

public GroupsAPI()

Method Detail

getGroups

public void getGroups(GroupsParams groupsParams,
                      boolean clearCache,
                      ListenerModel<BaseModel<Groups>,Groups> listener)

Get the list of groups

Parameters:

groupsParams - the GroupsParams for Groups API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

getJoinedGroups

public void getJoinedGroups(GroupsParams groupsParams,
                            boolean clearCache,
                            ListenerModel<BaseModel<Groups>,Groups> listener)

Get the list of joined groups

Parameters:

groupsParams - the GroupsParams for Groups API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

getGroupMembers

public void getGroupMembers(GroupsParams groupsParams,
                            boolean clearCache,
                            ListenerModel<BaseModel<GroupMembers>,GroupMembers> listener)

Get the list of members in the group

Parameters:

groupsParams - the GroupsParams for Groups API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

getGroupClasses

public void getGroupClasses(GroupsParams groupsParams,
                            boolean clearCache,
                            ListenerModel<BaseModel<GroupClasses>,GroupClasses> listener)

Get the list of group classes

Parameters:

groupsParams - the GroupsParams for Groups API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

joinGroup

public void joinGroup(GroupsParams groupsParams,
                      ListenerModel<BaseModel<GroupJoinLeaveResponse>,GroupJoinLeaveResponse> listener)

Join group

Parameters:

groupsParams - the GroupsParams for Groups API

listener - callback to handle the results

leaveGroup

public void leaveGroup(GroupsParams groupsParams,
                       ListenerModel<BaseModel<GroupJoinLeaveResponse>,GroupJoinLeaveResponse> listener)

Leave group

Parameters:

groupsParams - the GroupsParams for Groups API

listener - callback to handle the results