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

Class ReceiversRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.receivers.ReceiversRequestExecutor

public class ReceiversRequestExecutor
extends PaginatedRequestExecutor<Receivers>

Request executor provided by ReceiversApi. Use this class if you want to obtain receivers through fluent API in chained fashion, for instance:

   
   KontaktCloud kontaktCloud = KontaktCloudFactory.create();
   Receivers receivers = kontaktCloud.receivers().fetch()
      .fromPlaces(placeIDs)
      .maxResult(10)
      .execute();
   
 

Constructor Summary

Constructors

Constructor and Description
ReceiversRequestExecutor(ReceiversService receiversService) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
ReceiversRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
Receivers	execute() Executes created request synchronously.
void	execute(CloudCallback<Receivers> callback) Executes created request asynchronously and invokes callback with the result.
ReceiversRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
ReceiversRequestExecutor	fromPlaces(java.util.List<java.util.UUID> placeIds) Specifies places for whose receivers belong to.
ReceiversRequestExecutor	fromPlaces(java.util.UUID... placeIds) Specifies places for whose receivers belong to.
ReceiversRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
ReceiversRequestExecutor	orderBy(OrderBy orderBy, Order order) Specifies the ordering of response data elements.
ReceiversRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
ReceiversRequestExecutor	withIds(java.util.List<java.util.UUID> ids) Specifies receivers identifiers.
ReceiversRequestExecutor	withIds(java.util.UUID... ids) Specifies receivers identifiers.

Methods inherited from class java.lang.Object

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

Constructor Detail

ReceiversRequestExecutor

public ReceiversRequestExecutor(ReceiversService receiversService)

Constructs request executor initialized with corresponding service class.

Parameters:

receiversService - the receivers API service.

Method Detail

withIds

public ReceiversRequestExecutor withIds(java.util.UUID... ids)

Specifies receivers identifiers. Use that method if you want to fetch particular receiver by ID.

Parameters:

ids - receivers identifiers.

Returns:

this request executor.

withIds

public ReceiversRequestExecutor withIds(java.util.List<java.util.UUID> ids)

Specifies receivers identifiers. Use that method if you want to fetch particular receiver by ID.

Parameters:

ids - receivers identifiers.

Returns:

this request executor.

fromPlaces

public ReceiversRequestExecutor fromPlaces(java.util.UUID... placeIds)

Specifies places for whose receivers belong to.

Parameters:

placeIds - places identifiers.

Returns:

this request executor.

fromPlaces

public ReceiversRequestExecutor fromPlaces(java.util.List<java.util.UUID> placeIds)

Specifies places for whose receivers belong to.

Parameters:

placeIds - places identifiers.

Returns:

this request executor.

startIndex

public ReceiversRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Receivers>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public ReceiversRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Receivers>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public ReceiversRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Receivers>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public ReceiversRequestExecutor orderBy(OrderBy orderBy,
                                        Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Receivers>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public ReceiversRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Receivers>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

execute

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

Executes created request synchronously.

Overrides:

execute in class RequestExecutor<Receivers>

Returns:

the response object.

Throws:

java.io.IOException - exception

KontaktCloudException - exception

execute

public void execute(CloudCallback<Receivers> callback)

Executes created request asynchronously and invokes callback with the result.

Overrides:

execute in class RequestExecutor<Receivers>

Parameters:

callback - the callback object.