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

Class CampaignRequestFactory

java.lang.Object

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

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

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

Builds requests that interact with the Campaigns endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CampaignRequestFactory.IconSize Represents icon sizes for icon requests.

Constructor Summary

Constructors

Constructor and Description
CampaignRequestFactory(Context context, AccessTokenRetriever retriever)

Method Summary

Modifier and Type	Method and Description
AbstractRequest	buildGetCampaignDetailsByRepresentationType(CampaignMetadata metadata, CampaignRepresentationType representationType)
AbstractRequest	buildGetCampaignIcon(long campaignWebServiceId, CampaignRequestFactory.IconSize iconSize)
AbstractRequest	buildGetCampaignImageRequest(Context context, long campaignWebServiceId)
AbstractRequest	buildGetCampaignMerchantsRequest(long campaignWebServiceId)
AbstractRequest	buildGetCampaignRequest(int campaignId) Build a request to get the details of a campaign.

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

CampaignRequestFactory

public CampaignRequestFactory(Context context,
                              AccessTokenRetriever retriever)

Parameters:

context - the Application context.

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

Method Detail

buildGetCampaignRequest

public AbstractRequest buildGetCampaignRequest(int campaignId)

Build a request to get the details of a campaign.

Parameters:

campaignId - the ID of the campaign to get the details of.

Returns:

AbstractRequest to use to get the details of the campaign.

buildGetCampaignImageRequest

public AbstractRequest buildGetCampaignImageRequest(Context context,
                                                    long campaignWebServiceId)

Parameters:

context - the Application context.

campaignWebServiceId - the web service ID of the Campaign to get the image for.

Returns:

an AbstractRequest that represents a request to the web service to get the image for a Campaign with the web service ID passed.

buildGetCampaignMerchantsRequest

public AbstractRequest buildGetCampaignMerchantsRequest(long campaignWebServiceId)

Parameters:

campaignWebServiceId - the web service ID of the Campaign to get the merchants for.

Returns:

an AbstractRequest that represents a request to the web service to get the list of merchant IDs that its credit is valid at.

buildGetCampaignDetailsByRepresentationType

@LevelUpApi(contract=PUBLIC)
 @RequiresPermission(value="manage_user_campaigns")
public AbstractRequest buildGetCampaignDetailsByRepresentationType(CampaignMetadata metadata,
                                                                                                                                                    CampaignRepresentationType representationType)

Parameters:

metadata - the campaign metadata to get details about.

representationType - the type of details to retrieve.

Returns:

an AbstractRequest that represents a request to the web service to get details for a specific campaign based on the .CampaignRepresentationTypes.

buildGetCampaignIcon

@LevelUpApi(contract=PUBLIC)
public AbstractRequest buildGetCampaignIcon(long campaignWebServiceId,
                                                                         CampaignRequestFactory.IconSize iconSize)

Parameters:

campaignWebServiceId - the campaign id to get an icon for.

iconSize - the icon size to retrieve.

Returns:

an AbstractRequest that represents a request to the web service to get an icon for the specific campaign at the specified size.