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

Class VenuesRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.venues.VenuesRequestExecutor

public class VenuesRequestExecutor
extends PaginatedRequestExecutor<Venues>

Request executor provided by VenuesApi. Use this class if you want to fetch devices through fluent API in chained fashion, for example:

   
   IKontaktCloud kontaktCloud = KontaktCloud.newInstance();
   Venues venues = kontaktCloud.venues().fetch()
      .managerIds(managerIDs)
      .startIndex(5)
      .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
VenuesRequestExecutor(VenuesService venuesService) Constructs request executor initialized with corresponding service class.

Method Summary

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

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

VenuesRequestExecutor

public VenuesRequestExecutor(VenuesService venuesService)

Constructs request executor initialized with corresponding service class.

Parameters:

venuesService - the venues API service.

Method Detail

managerIds

public VenuesRequestExecutor managerIds(java.util.UUID... managerIds)

Specifies managers.

Parameters:

managerIds - manager unique identifiers.

Returns:

this request executor.

managerIds

public VenuesRequestExecutor managerIds(java.util.List<java.util.UUID> managerIds)

Specifies managers.

Parameters:

managerIds - manager unique identifiers.

Returns:

this request executor.

type

public VenuesRequestExecutor type(VenueType type)

Specifies venue type.

Parameters:

type - venue type.

Returns:

this request executor.

startIndex

public VenuesRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Venues>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public VenuesRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Venues>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public VenuesRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Venues>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public VenuesRequestExecutor orderBy(OrderBy orderBy,
                                     Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Venues>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public VenuesRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Venues>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

prepareCall

protected retrofit2.Call<Venues> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<Venues>

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

Returns:

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