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

Class ActionsRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.actions.ActionsRequestExecutor

public class ActionsRequestExecutor
extends PaginatedRequestExecutor<Actions>

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

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Actions actions = kontaktCloud.actions().fetch()
      .forDevices("AxT7")
      .startIndex(4)
      .maxResult(10)
      .filter("")
      .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
ActionsRequestExecutor(ActionsService actionsService) Constructs request executor initialized with corresponding service class.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionsRequestExecutor

public ActionsRequestExecutor(ActionsService actionsService)

Constructs request executor initialized with corresponding service class.

Parameters:

actionsService - the actions API service.

Method Detail

forDevices

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

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

Parameters:

uniqueIds - the device unique identifiers.

Returns:

this request executor.

forDevices

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

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

Parameters:

uniqueIds - the device unique identifiers.

Returns:

this request executor.

startIndex

public ActionsRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Actions>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public ActionsRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Actions>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public ActionsRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Actions>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public ActionsRequestExecutor orderBy(OrderBy orderBy,
                                      Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Actions>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public ActionsRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Actions>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

execute

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

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<Actions>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<Actions> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<Actions>

Parameters:

callback - the callback object.

prepareCall

protected retrofit2.Call<Actions> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Actions>

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

Returns:

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