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

Class CommandsRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.commands.CommandsRequestExecutor

public class CommandsRequestExecutor
extends PaginatedRequestExecutor<SecureCommands>

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   SecureCommands commands = kontaktCloud.commands().fetch()
      .forDevices("34Gh", "5Gk9", "d5Gv")
      .withType(SecureCommandType.BOOTLOADER)
      .startIndex(5)
      .maxResult(15)
      .execute();
   
 

Keep in mind that devices and command type must be specified so invocations of forDevices and withType methods are 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
CommandsRequestExecutor(CommandsService commandsService) Constructs request executor initialized with corresponding service class.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandsRequestExecutor

public CommandsRequestExecutor(CommandsService commandsService)

Constructs request executor initialized with corresponding service class.

Parameters:

commandsService - the commands API service.

Method Detail

forDevices

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

withType

public CommandsRequestExecutor withType(SecureCommandType type)

Specifies the command's type. The method invocation is obligatory while using this request executor.

Parameters:

type - the secure command type.

Returns:

this request executor.

startIndex

public CommandsRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<SecureCommands>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public CommandsRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<SecureCommands>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public CommandsRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<SecureCommands>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public CommandsRequestExecutor orderBy(OrderBy orderBy,
                                       Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<SecureCommands>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public CommandsRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<SecureCommands>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

execute

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

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<SecureCommands>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<SecureCommands> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<SecureCommands>

Parameters:

callback - the callback object.

prepareCall

protected retrofit2.Call<SecureCommands> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<SecureCommands>

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

Returns:

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