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

Class FirmwaresRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.firmwares.FirmwaresRequestExecutor

public class FirmwaresRequestExecutor
extends PaginatedRequestExecutor<Firmwares>

Request executor provided by FirmwaresApi. Use this class if you want to get firmwares through fluent API in chained fashion, for example:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Firmwares firmwares = kontaktCloud.firmwares().fetch()
      .forDevices("4DgT", "6Hyj")
      .execute();
   
 

Keep in mind that devices must be specified so invocation of forDevices 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
FirmwaresRequestExecutor(FirmwaresService firmwaresService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
FirmwaresRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
Firmwares	execute() Executes created request synchronously.
void	execute(CloudCallback<Firmwares> callback) Executes created request asynchronously and invokes callback with the result.
FirmwaresRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
FirmwaresRequestExecutor	forDevices(java.util.List<java.lang.String> uniqueIds) Specifies devices.
FirmwaresRequestExecutor	forDevices(java.util.Set<java.lang.String> uniqueIds) Specifies devices.
FirmwaresRequestExecutor	forDevices(java.lang.String... uniqueIds) Specifies devices.
FirmwaresRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
FirmwaresRequestExecutor	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<Firmwares>	prepareCall() Prepares a request to execute.
FirmwaresRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
FirmwaresRequestExecutor	withType(FirmwareType type) Specifies firmware type.

Methods inherited from class java.lang.Object

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

Constructor Detail

FirmwaresRequestExecutor

public FirmwaresRequestExecutor(FirmwaresService firmwaresService)

Constructs request executor initialized with corresponding service class.

Parameters:

firmwaresService - the firmwares API service.

Method Detail

forDevices

public FirmwaresRequestExecutor forDevices(java.lang.String... uniqueIds)

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

Parameters:

uniqueIds - the device unique identifiers.

Returns:

this request executor.

forDevices

public FirmwaresRequestExecutor forDevices(java.util.List<java.lang.String> uniqueIds)

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

Parameters:

uniqueIds - the device unique identifiers.

Returns:

this request executor.

forDevices

public FirmwaresRequestExecutor forDevices(java.util.Set<java.lang.String> uniqueIds)

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

Parameters:

uniqueIds - the device unique identifiers.

Returns:

this request executor.

withType

public FirmwaresRequestExecutor withType(FirmwareType type)

Specifies firmware type.

Parameters:

type - the firmware type.

Returns:

this request executor.

startIndex

public FirmwaresRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Firmwares>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public FirmwaresRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Firmwares>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public FirmwaresRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Firmwares>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public FirmwaresRequestExecutor orderBy(OrderBy orderBy,
                                        Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Firmwares>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public FirmwaresRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Firmwares>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

execute

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

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<Firmwares>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<Firmwares> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<Firmwares>

Parameters:

callback - the callback object.

prepareCall

protected retrofit2.Call<Firmwares> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Firmwares>

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<Firmwares>

Returns:

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