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

Class TriggersRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.triggers.TriggersRequestExecutor

public class TriggersRequestExecutor
extends PaginatedRequestExecutor<Triggers>

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

   
   KontaktCloud kontaktCloud = KontaktCloudFactory.create();
   Triggers triggers = kontaktCloud.triggers().fetch()
      .startIndex(5)
      .maxResult(10)
      .execute();
   
 

Constructor Summary

Constructors

Constructor and Description
TriggersRequestExecutor(TriggersService triggersService) Constructs request executor initialized with corresponding service class.

Method Summary

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

TriggersRequestExecutor

public TriggersRequestExecutor(TriggersService triggersService)

Constructs request executor initialized with corresponding service class.

Parameters:

triggersService - the triggers API service.

Method Detail

withIds

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

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

Parameters:

ids - triggers unique identifiers.

Returns:

this request executor.

withIds

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

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

Parameters:

ids - triggers unique identifiers.

Returns:

this request executor.

startIndex

public TriggersRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<Triggers>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public TriggersRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<Triggers>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

filter

public TriggersRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<Triggers>

Parameters:

query - the query filter.

Returns:

this request executor.

orderBy

public TriggersRequestExecutor orderBy(OrderBy orderBy,
                                       Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<Triggers>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

eTag

public TriggersRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<Triggers>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.