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

Class ProximitiesRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.proximities.ProximitiesRequestExecutor

public class ProximitiesRequestExecutor
extends PaginatedRequestExecutor<Proximities>

Request executor provided by ProximitiesApi. Use this class if you want to fetch secure proximities mapping through fluent API in chained fashion, for example:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   kontaktCloud.proximities().fetch()
      .startIndex(4)
      .maxResult(10)
      .execute();
   
 

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
ProximitiesRequestExecutor(ProximitiesService proximitiesService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
ProximitiesRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
ProximitiesRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
ProximitiesRequestExecutor	mappedBy(java.util.UUID proximity) Specifies proximity to mapping.
ProximitiesRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
ProximitiesRequestExecutor	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<Proximities>	prepareCall() Prepares a request to execute.
ProximitiesRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.

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

Constructor Detail

ProximitiesRequestExecutor

public ProximitiesRequestExecutor(ProximitiesService proximitiesService)

Constructs request executor initialized with corresponding service class.

Parameters:

proximitiesService - the proximities API service.

Method Detail

mappedBy

public ProximitiesRequestExecutor mappedBy(java.util.UUID proximity)

Specifies proximity to mapping.

Parameters:

proximity - the proximity.

Returns:

this request executor.

startIndex

public ProximitiesRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Proximities>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public ProximitiesRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Proximities>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public ProximitiesRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Proximities>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public ProximitiesRequestExecutor orderBy(OrderBy orderBy,
                                          Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Proximities>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public ProximitiesRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Proximities>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

prepareCall

protected retrofit2.Call<Proximities> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Proximities>

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

Returns:

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