com.kontakt.sdk.android.cloud.api.executor.devices

Class IBeaconsRequestExecutor

java.lang.Object

com.kontakt.sdk.android.cloud.api.executor.RequestExecutor<T>

com.kontakt.sdk.android.cloud.api.executor.PaginatedRequestExecutor<Devices>

com.kontakt.sdk.android.cloud.api.executor.devices.IBeaconsRequestExecutor

public class IBeaconsRequestExecutor
extends PaginatedRequestExecutor<Devices>

Request executor provided by DevicesApi. Use this class if you want to fetch iBeacon devices through fluent API in chained fashion, for example:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Devices iBeacons = kontaktCloud.devices().iBeacons()
      .withIds(iBeaconIDs)
      .maxResult(10)
      .execute();
   
 

Field Summary

Fields

Modifier and Type	Field and Description
protected Access	access
protected java.util.UUID[]	managerIds
protected DeviceProfile	profile
protected DeviceType	type

Fields inherited from class com.kontakt.sdk.android.cloud.api.executor.PaginatedRequestExecutor

eTag, maxResult, order, orderBy, query, startIndex

Constructor Summary

Constructors

Constructor and Description
IBeaconsRequestExecutor(DevicesService devicesService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
IBeaconsRequestExecutor	access(Access access) Specifies access parameter.
IBeaconsRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
IBeaconsRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
IBeaconsRequestExecutor	managerIds(java.util.List<java.util.UUID> managerIds) Specifies managers for whom devices are assigned to.
IBeaconsRequestExecutor	managerIds(java.util.UUID... managerIds) Specifies managers for whom devices are assigned to.
IBeaconsRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
IBeaconsRequestExecutor	orderBy(OrderBy orderBy, Order order) Specifies the ordering of response data elements.
protected java.util.Map<java.lang.String,java.lang.String>	params() Composes the request's query parameters in map.
protected retrofit2.Call<Devices>	prepareCall() Prepares a request to execute.
IBeaconsRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
IBeaconsRequestExecutor	withIds(IBeaconId... iBeaconIDs) Specifies iBeacon unique IDs.
IBeaconsRequestExecutor	withIds(java.util.List<IBeaconId> iBeaconIDs) Specifies iBeacon unique IDs.

Methods inherited from class com.kontakt.sdk.android.cloud.api.executor.RequestExecutor

execute, execute

Methods inherited from class java.lang.Object

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

Field Detail

access

protected Access access

profile

protected DeviceProfile profile

type

protected DeviceType type

managerIds

protected java.util.UUID[] managerIds

Constructor Detail

IBeaconsRequestExecutor

public IBeaconsRequestExecutor(DevicesService devicesService)

Constructs request executor initialized with corresponding service class.

Parameters:

devicesService - the devices API service.

Method Detail

withIds

public IBeaconsRequestExecutor withIds(IBeaconId... iBeaconIDs)

Specifies iBeacon unique IDs. Use that method if you want to fetch particular iBeacon devices by ID.

Parameters:

iBeaconIDs - iBeacon unique identifiers.

Returns:

this request executor.

withIds

public IBeaconsRequestExecutor withIds(java.util.List<IBeaconId> iBeaconIDs)

Specifies iBeacon unique IDs. Use that method if you want to fetch particular iBeacon devices by ID.

Parameters:

iBeaconIDs - iBeacon unique identifiers.

Returns:

this request executor.

prepareCall

protected retrofit2.Call<Devices> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Devices>

Returns:

the request.

startIndex

public IBeaconsRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Devices>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public IBeaconsRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Devices>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public IBeaconsRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Devices>

Parameters:

query - the query filter.

Returns:

this request executor.

access

public IBeaconsRequestExecutor access(Access access)

Specifies access parameter.

Parameters:

access - the access.

Returns:

this request executor.

managerIds

public IBeaconsRequestExecutor managerIds(java.util.UUID... managerIds)

Specifies managers for whom devices are assigned to.

Parameters:

managerIds - manager unique identifiers.

Returns:

this request executor.

managerIds

public IBeaconsRequestExecutor managerIds(java.util.List<java.util.UUID> managerIds)

Specifies managers for whom devices are assigned to.

Parameters:

managerIds - manager unique identifiers.

Returns:

this request executor.

orderBy

public IBeaconsRequestExecutor orderBy(OrderBy orderBy,
                                       Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Devices>

Parameters:

orderBy - the field type that specifies the order by column.

order - ascending or descending.

Returns:

this request executor.

eTag

public IBeaconsRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Devices>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

params

protected java.util.Map<java.lang.String,java.lang.String> params()

Composes the request's query parameters in map.

Returns:

the map of request parameters that are being used to get desired data from API.