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

Class DevicesRequestExecutor

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.DevicesRequestExecutor

public class DevicesRequestExecutor
extends PaginatedRequestExecutor<Devices>

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Devices devices = kontaktCloud.devices().fetch()
      .managerIds(managerId)
      .type(DeviceType.BEACON)
      .profile(DeviceProfile.IBEACON)
      .startIndex(5)
      .maxResult(10)
      .filter("major>=155")
      .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
DevicesRequestExecutor(DevicesService devicesService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
DevicesRequestExecutor	access(Access access) Specifies access parameter.
DevicesRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
DevicesRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
DevicesRequestExecutor	managerIds(java.util.List<java.util.UUID> managerIds) Specifies managers for whom devices are assigned to.
DevicesRequestExecutor	managerIds(java.util.UUID... managerIds) Specifies managers for whom devices are assigned to.
DevicesRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
DevicesRequestExecutor	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.
DevicesRequestExecutor	profile(DeviceProfile profile) Specifies device profile.
DevicesRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
DevicesRequestExecutor	type(DeviceType type) Specifies device type.
DevicesRequestExecutor	unassignedFor(java.util.UUID managerId) Use that method if you want to fetch devices that are assigned to the given manager and not assigned to any venue.
DevicesRequestExecutor	withIds(java.util.List<java.lang.String> uniqueIds) Specifies device unique IDs.
DevicesRequestExecutor	withIds(java.lang.String... uniqueIds) Specifies device 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

DevicesRequestExecutor

public DevicesRequestExecutor(DevicesService devicesService)

Constructs request executor initialized with corresponding service class.

Parameters:

devicesService - the devices API service.

Method Detail

withIds

public DevicesRequestExecutor withIds(java.lang.String... uniqueIds)

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

Parameters:

uniqueIds - device unique identifiers.

Returns:

this request executor.

withIds

public DevicesRequestExecutor withIds(java.util.List<java.lang.String> uniqueIds)

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

Parameters:

uniqueIds - device unique identifiers.

Returns:

this request executor.

type

public DevicesRequestExecutor type(DeviceType type)

Specifies device type.

Parameters:

type - the device type.

Returns:

this request executor.

profile

public DevicesRequestExecutor profile(DeviceProfile profile)

Specifies device profile.

Parameters:

profile - the device profile.

Returns:

this request executor.

unassignedFor

public DevicesRequestExecutor unassignedFor(java.util.UUID managerId)

Use that method if you want to fetch devices that are assigned to the given manager and not assigned to any venue.

Parameters:

managerId - the manager unique identifier.

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 DevicesRequestExecutor 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 DevicesRequestExecutor 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 DevicesRequestExecutor 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 DevicesRequestExecutor access(Access access)

Specifies access parameter.

Parameters:

access - the access.

Returns:

this request executor.

managerIds

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

Specifies managers for whom devices are assigned to.

Parameters:

managerIds - manager unique identifiers.

Returns:

this request executor.

managerIds

public DevicesRequestExecutor 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 DevicesRequestExecutor 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 DevicesRequestExecutor 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.