public class ActivitiesRequestExecutor extends PaginatedRequestExecutor<Activities>
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();
eTag, maxResult, order, orderBy, query, startIndex
Constructor and Description |
---|
ActivitiesRequestExecutor(ActivitiesService service)
Constructs request executor initialized with corresponding service class.
|
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.
|
protected java.util.Map<java.lang.String,java.lang.String> |
params()
Composes the request's query parameters in map.
|
protected <any> |
prepareCall()
Prepares a request to execute.
|
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.
|
execute, execute
public ActivitiesRequestExecutor(ActivitiesService service)
service
- the activities API service.public ActivitiesRequestExecutor withIds(java.util.UUID... ids)
ids
- activities unique identifiers.public ActivitiesRequestExecutor withIds(java.util.List<java.util.UUID> ids)
ids
- activities unique identifiers.public ActivitiesRequestExecutor startIndex(int startIndex)
startIndex
in class PaginatedRequestExecutor<Activities>
startIndex
- the start index.public ActivitiesRequestExecutor maxResult(int maxResult)
maxResult
in class PaginatedRequestExecutor<Activities>
maxResult
- the maximum response size value.public ActivitiesRequestExecutor filter(java.lang.String query)
filter
in class PaginatedRequestExecutor<Activities>
query
- the query filter.public ActivitiesRequestExecutor orderBy(OrderBy orderBy, Order order)
orderBy
in class PaginatedRequestExecutor<Activities>
orderBy
- the field type that specifies the order by column.order
- ascending or descending.public ActivitiesRequestExecutor eTag(java.lang.String eTag)
eTag
in class PaginatedRequestExecutor<Activities>
eTag
- the entity tag value.protected <any> prepareCall()
prepareCall
in class RequestExecutor<Activities>
protected java.util.Map<java.lang.String,java.lang.String> params()
PaginatedRequestExecutor
params
in class PaginatedRequestExecutor<Activities>