com.kontakt.sdk.android.http

Class RequestDescription

java.lang.Object

com.kontakt.sdk.android.http.RequestDescription

public class RequestDescription
extends java.lang.Object

Class representing http call params, like startIndex and offset for paging, ETag header

Example use:

      RequestDescription.Descriptor descriptor = RequestDescription.start()
                .setOffset(Integer.MAX_VALUE)
                .addParameter(Constants.Devices.DEVICE_TYPE, DeviceType.BEACON.name());

        RequestDescription description = descriptor.build();
      

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestDescription.Descriptor The type Descriptor.

Method Summary

Modifier and Type	Method and Description
boolean	containsParameter(java.lang.String name, java.lang.String value)
ETag	getETag() Gets e tag.
com.squareup.okhttp.Headers	getHeaders() Extract header list.
Order	getOrder() Gets order.
OrderBy	getOrderBy() Gets order by.
java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>>	getParameters() Extract parameters list.
int	getResultsOffset() Gets results offset.
int	getResultsStartIndex() Gets results start index.
static RequestDescription.Descriptor	start() Start descriptor.

Methods inherited from class java.lang.Object

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

Method Detail

start

public static RequestDescription.Descriptor start()

Start descriptor.

Returns:

the descriptor

getHeaders

public com.squareup.okhttp.Headers getHeaders()

Extract header list.

Returns:

the list

getParameters

public java.util.List<java.util.Map.Entry<java.lang.String,java.lang.String>> getParameters()

Extract parameters list.

Returns:

the list

containsParameter

public boolean containsParameter(java.lang.String name,
                                 java.lang.String value)

getETag

public ETag getETag()

Gets e tag.

Returns:

the e tag

getOrder

public Order getOrder()

Gets order.

Returns:

the order

getOrderBy

public OrderBy getOrderBy()

Gets order by.

Returns:

the order by

getResultsStartIndex

public int getResultsStartIndex()

Gets results start index.

Returns:

the results start index

getResultsOffset

public int getResultsOffset()

Gets results offset.

Returns:

the results offset