com.scvngr.levelup.core.net.request.factory

Class OrderRequestFactory

java.lang.Object

com.scvngr.levelup.core.net.request.factory.AbstractRequestFactory

com.scvngr.levelup.core.net.request.factory.OrderRequestFactory

@Immutable
 @LevelUpApi(contract=PUBLIC)
public final class OrderRequestFactory
extends AbstractRequestFactory

Class to build requests to interact with the order endpoint.

Constructor Summary

Constructors

Constructor and Description
OrderRequestFactory(Context context, AccessTokenRetriever retriever) Constructor.

Method Summary

Modifier and Type	Method and Description
AbstractRequest	newGetAppOrdersRequest(int page) Builds a request to get a list of orders for the current user.
AbstractRequest	newGetAppOrdersRequest(long appId, int page) Deprecated.
AbstractRequest	newGetOrderRequest(String orderUuid) Builds a request to get a single order.

Methods inherited from class com.scvngr.levelup.core.net.request.factory.AbstractRequestFactory

getAccessTokenRetriever, getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

OrderRequestFactory

public OrderRequestFactory(Context context,
                           AccessTokenRetriever retriever)

Constructor.

Parameters:

context - Application context.

retriever - the implementation of AccessTokenRetriever to use to get the User's AccessToken.

Method Detail

newGetAppOrdersRequest

@LevelUpApi(contract=PUBLIC)
 @RequiresPermission(value="read_user_orders")
 @AccessTokenRequired
public AbstractRequest newGetAppOrdersRequest(int page)

Builds a request to get a list of orders for the current user.

Parameters:

page - the "page" of results to get because the endpoint supports pagination. The expected first page from the web service starts at 1. The web service will return an empty set if there are no more results to show

Returns:

Request to get a list of orders for the current user.

newGetOrderRequest

@LevelUpApi(contract=PUBLIC)
 @RequiresPermission(value="read_user_orders")
 @AccessTokenRequired
public AbstractRequest newGetOrderRequest(String orderUuid)

Builds a request to get a single order.

Parameters:

orderUuid - the UUID of the order to request.

Returns:

Request to get a single order.

newGetAppOrdersRequest

@AccessTokenRequired
 @Deprecated
 @LevelUpApi(contract=INTERNAL)
public AbstractRequest newGetAppOrdersRequest(long appId,
                                                                                                                int page)

Deprecated.

Builds a request to get a list of orders for the current user. Replaced by newGetAppOrdersRequest(int).

Parameters:

appId - the ID of the app whose orders will be displayed.

page - the "page" of results to get because the endpoint supports pagination. The expected first page from the web service starts at 1. The web service will return an empty set if there are no more results to show

Returns:

Request to get a list of orders for the current user.