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

Class CredentialsListRequestExecutor

java.lang.Object

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

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

com.kontakt.sdk.android.cloud.api.executor.devices.CredentialsListRequestExecutor

public class CredentialsListRequestExecutor
extends PaginatedRequestExecutor<CredentialsList>

Request executor provided by DevicesApi. Use this class if you want to get device credentials list through fluent API in chained fashion. Example of use:

   
   KontaktCloud kontaktCloud = KontaktCloudFactory.create();
   CredentialsList credentialsList = kontaktCloud.devices().credentials(deviceIDs).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
CredentialsListRequestExecutor(DevicesService devicesService, java.util.List<java.lang.String> uniqueIds) Constructs request executor initialized with corresponding service class and device unique IDs.

Method Summary

Modifier and Type	Method and Description
CredentialsListRequestExecutor	eTag(java.lang.String eTag) Specifies HTTP entity tag purposed for caching REST API calls.
CredentialsListRequestExecutor	filter(java.lang.String query) Specifies the filter for requested data.
CredentialsListRequestExecutor	maxResult(int maxResult) Specifies the maximum size of response data collection.
CredentialsListRequestExecutor	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.
CredentialsListRequestExecutor	startIndex(int startIndex) Specifies the start index of requested data.

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

CredentialsListRequestExecutor

public CredentialsListRequestExecutor(DevicesService devicesService,
                                      java.util.List<java.lang.String> uniqueIds)

Constructs request executor initialized with corresponding service class and device unique IDs.

Parameters:

devicesService - the devices API service.

uniqueIds - device unique identifiers.

Method Detail

prepareCall

protected <any> prepareCall()

Prepares a request to execute.

Specified by:

prepareCall in class RequestExecutor<CredentialsList>

Returns:

the request.

startIndex

public CredentialsListRequestExecutor startIndex(int startIndex)

Specifies the start index of requested data.

Overrides:

startIndex in class PaginatedRequestExecutor<CredentialsList>

Parameters:

startIndex - the start index.

Returns:

this request executor.

maxResult

public CredentialsListRequestExecutor maxResult(int maxResult)

Specifies the maximum size of response data collection.

Overrides:

maxResult in class PaginatedRequestExecutor<CredentialsList>

Parameters:

maxResult - the maximum response size value.

Returns:

this request executor.

orderBy

public CredentialsListRequestExecutor orderBy(OrderBy orderBy,
                                              Order order)

Specifies the ordering of response data elements.

Overrides:

orderBy in class PaginatedRequestExecutor<CredentialsList>

Parameters:

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

order - ascending or descending.

Returns:

this request executor.

filter

public CredentialsListRequestExecutor filter(java.lang.String query)

Specifies the filter for requested data.

Overrides:

filter in class PaginatedRequestExecutor<CredentialsList>

Parameters:

query - the query filter.

Returns:

this request executor.

eTag

public CredentialsListRequestExecutor eTag(java.lang.String eTag)

Specifies HTTP entity tag purposed for caching REST API calls.

Overrides:

eTag in class PaginatedRequestExecutor<CredentialsList>

Parameters:

eTag - the entity tag value.

Returns:

this request executor.

params

protected java.util.Map<java.lang.String,java.lang.String> params()

Description copied from class: PaginatedRequestExecutor

Composes the request's query parameters in map.

Overrides:

params in class PaginatedRequestExecutor<CredentialsList>

Returns:

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