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

Class ActivitiesRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.activities.ActivitiesRequestExecutor

public class ActivitiesRequestExecutor
extends PaginatedRequestExecutor<Activities>

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

   
   KontaktCloud kontaktCloud = KontaktCloudFactory.create();
   Activities activities = kontaktCloud.activities().fetch()
      .startIndex(5)
      .maxResult(10)
      .execute();
   
 

Constructor Summary

Constructors

Constructor and Description
ActivitiesRequestExecutor(ActivitiesService service) Constructs request executor initialized with corresponding service class.

Method Summary

Modifier and Type	Method and Description
ActivitiesRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
ActivitiesRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
ActivitiesRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
ActivitiesRequestExecutor	orderBy(OrderBy orderBy, Order order) Specifies the ordering of response data elements.
ActivitiesRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.
ActivitiesRequestExecutor	withIds(java.util.List<java.util.UUID> ids) Use that method if you want to fetch particular activities by ID.
ActivitiesRequestExecutor	withIds(java.util.UUID... ids) Use that method if you want to fetch particular activities by ID.

Methods inherited from class com.kontakt.sdk.android.cloud.api.executor.RequestExecutor

execute, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivitiesRequestExecutor

public ActivitiesRequestExecutor(ActivitiesService service)

Constructs request executor initialized with corresponding service class.

Parameters:

service - the activities API service.

Method Detail

withIds

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

Use that method if you want to fetch particular activities by ID.

Parameters:

ids - activities unique identifiers.

Returns:

this request executor.

withIds

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

Use that method if you want to fetch particular activities by ID.

Parameters:

ids - activities unique identifiers.

Returns:

this request executor.

startIndex

public ActivitiesRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Activities>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public ActivitiesRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Activities>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public ActivitiesRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Activities>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public ActivitiesRequestExecutor orderBy(OrderBy orderBy,
                                         Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Activities>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public ActivitiesRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Activities>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.