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

Class ConfigsRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.configs.ConfigsRequestExecutor

public class ConfigsRequestExecutor
extends PaginatedRequestExecutor<Configs>

Request executor provided by ConfigsApi. Use this class if you want to obtain configs through fluent API in chained fashion. Here is an example of how to use this executor:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Configs configs = kontaktCloud.configs().fetch()
      .type(DeviceType.BEACON)
      .profile(DeviceProfile.EDDYSTONE)
      .maxResult(15)
      .execute();
   
 

Keep in mind that device type must be specified so invocation of type method is mandatory. Otherwise an exception will be thrown.

Field Summary

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

eTag, maxResult, order, orderBy, query, startIndex

Constructor Summary

Constructors

Constructor and Description
ConfigsRequestExecutor(ConfigsService configsService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
ConfigsRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
Configs	execute() Executes created request synchronously.
void	execute(CloudCallback<Configs> callback) Executes created request asynchronously and invokes callback with the result.
ConfigsRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
ConfigsRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
ConfigsRequestExecutor	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<Configs>	prepareCall() Prepares a request to execute.
ConfigsRequestExecutor	profile(DeviceProfile profile) Specifies device profile.
ConfigsRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
ConfigsRequestExecutor	type(DeviceType type) Specifies device type.
ConfigsRequestExecutor	withIds(java.util.List<java.lang.String> uniqueIds) Specifies config unique identifiers.
ConfigsRequestExecutor	withIds(java.lang.String... uniqueIds) Specifies config unique identifiers.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigsRequestExecutor

public ConfigsRequestExecutor(ConfigsService configsService)

Constructs request executor initialized with corresponding service class.

Parameters:

configsService - the configs API service.

Method Detail

type

public ConfigsRequestExecutor type(DeviceType type)

Specifies device type. The method invocation is obligatory while using this request executor.

Parameters:

type - the device type.

Returns:

this request executor.

profile

public ConfigsRequestExecutor profile(DeviceProfile profile)

Specifies device profile.

Parameters:

profile - the device profile.

Returns:

this request executor.

withIds

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

Specifies config unique identifiers. Use that method if you want to fetch particular configs by ID.

Parameters:

uniqueIds - config unique identifiers.

Returns:

this request executor.

withIds

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

Specifies config unique identifiers. Use that method if you want to fetch particular configs by ID.

Parameters:

uniqueIds - config unique identifiers.

Returns:

this request executor.

startIndex

public ConfigsRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Configs>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public ConfigsRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Configs>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public ConfigsRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Configs>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public ConfigsRequestExecutor orderBy(OrderBy orderBy,
                                      Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Configs>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public ConfigsRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Configs>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

execute

public Configs execute()
                throws java.io.IOException,
                       KontaktCloudException

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<Configs>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<Configs> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<Configs>

Parameters:

callback - the callback object.

prepareCall

protected retrofit2.Call<Configs> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Configs>

Returns:

the request.

params

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

Composes the request's query parameters in map.

Overrides:

params in class PaginatedRequestExecutor<Configs>

Returns:

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