Package com.cheetahdigital.beacons.core.api

Class BeaconsAPI

java.lang.Object

com.cheetahdigital.corekit.models.module.Controller

com.cheetahdigital.beacons.core.api.BeaconsAPI

All Implemented Interfaces:

RestController

public class BeaconsAPI
extends Controller

Class for setting the query parameters of Beacons 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

Method Summary

Modifier and Type	Method	Description
void	getBeaconUuids(BeaconsParams beaconsParams, boolean clearCache, ListenerModel<BaseModel<UUIDs>,UUIDs> listener)	Method to get UUIDs
static BeaconsAPI	getInstance()
void	sendIBeaconData(BeaconsParams beaconsParams, BeaconFields beaconFields, ListenerModel<BaseModel<java.util.List<BeaconOffer>>,java.util.List<BeaconOffer>> listener)	Posts the UUID, major and minor values of the iBeacon detected by the device.

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

Method Detail

getInstance

public static BeaconsAPI getInstance()

getBeaconUuids

public void getBeaconUuids(BeaconsParams beaconsParams,
                           boolean clearCache,
                           ListenerModel<BaseModel<UUIDs>,UUIDs> listener)

Method to get UUIDs

Parameters:

beaconsParams - the BeaconsParams for Beacon API

clearCache - set to true to clear previously stored cache

listener - callback to handle the results

sendIBeaconData

public void sendIBeaconData(BeaconsParams beaconsParams,
                            BeaconFields beaconFields,
                            ListenerModel<BaseModel<java.util.List<BeaconOffer>>,java.util.List<BeaconOffer>> listener)

Posts the UUID, major and minor values of the iBeacon detected by the device.

Parameters:

beaconsParams - the BeaconsParams for Beacon API

beaconFields - the BeaconFields for Beacon API

listener - callback to handle the results