com.scvngr.levelup.core.model

Class Campaign

java.lang.Object

com.scvngr.levelup.core.model.Campaign

All Implemented Interfaces:

Parcelable

@Immutable
 @LevelUpApi(contract=PUBLIC)
public final class Campaign
extends Object
implements Parcelable

Represents a campaign (which can be claimed for credit) on the server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Campaign.CampaignBuilder

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<Campaign>	CREATOR Implements the Parcelable interface.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Campaign(boolean appliesToAllMerchants, String confirmationHtml, long id, String messageForEmailBody, String messageForEmailSubject, String messageForTwitter, String messageForFacebook, String name, String offerHtml, String type, boolean shareable, String shareUrlEmail, String shareUrlFacebook, String shareUrlTwitter, String sponsor, MonetaryValue value)

Method Summary

Modifier and Type	Method and Description
static Campaign.CampaignBuilder	builder()
int	describeContents()
boolean	equals(Object o)
String	getConfirmationHtml() The text to show when a successful claim of this campaign occurs.
long	getId() The ID of this Campaign on the web service.
String	getMessageForEmailBody() The message to use as a body for an email share of this campaign.
String	getMessageForEmailSubject() The message to use as a the subject for an email share of this campaign.
String	getMessageForFacebook() The message to use for a Facebook share of this campaign.
String	getMessageForTwitter() The message to use for a Twitter share of this campaign.
String	getName() The name of this campaign.
String	getOfferHtml() The text describing this campaign.
String	getShareUrlEmail() The URL to share via email.
String	getShareUrlFacebook() The URL to share via Facebook.
String	getShareUrlTwitter() The URL to share via twitter.
String	getSponsor() The name of the sponsor of this campaign.
String	getType() The type of campaign this is.
MonetaryValue	getValue() The amount of credit the user would get for claiming this campaign.
int	hashCode()
boolean	isAppliesToAllMerchants() Whether or not this campaign's value is eligible to be spent at all merchants on LevelUp.
boolean	isShareable() If this Campaign is eligible to be shared to others.
String	toString()
void	writeToParcel(Parcel dest, int flags)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final Parcelable.Creator<Campaign> CREATOR

Implements the Parcelable interface.

Constructor Detail

Campaign

public Campaign(boolean appliesToAllMerchants,
                String confirmationHtml,
                long id,
                String messageForEmailBody,
                String messageForEmailSubject,
                String messageForTwitter,
                String messageForFacebook,
                String name,
                String offerHtml,
                String type,
                boolean shareable,
                String shareUrlEmail,
                String shareUrlFacebook,
                String shareUrlTwitter,
                String sponsor,
                MonetaryValue value)

Method Detail

describeContents

public final int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public final void writeToParcel(Parcel dest,
                                int flags)

Specified by:

writeToParcel in interface Parcelable

builder

public static Campaign.CampaignBuilder builder()

isAppliesToAllMerchants

public boolean isAppliesToAllMerchants()

Whether or not this campaign's value is eligible to be spent at all merchants on LevelUp.

getConfirmationHtml

public String getConfirmationHtml()

The text to show when a successful claim of this campaign occurs.

getId

public long getId()

The ID of this Campaign on the web service.

getMessageForEmailBody

public String getMessageForEmailBody()

The message to use as a body for an email share of this campaign.

getMessageForEmailSubject

public String getMessageForEmailSubject()

The message to use as a the subject for an email share of this campaign.

getMessageForTwitter

public String getMessageForTwitter()

The message to use for a Twitter share of this campaign.

getMessageForFacebook

public String getMessageForFacebook()

The message to use for a Facebook share of this campaign.

getName

public String getName()

The name of this campaign.

getOfferHtml

public String getOfferHtml()

The text describing this campaign.

getType

public String getType()

The type of campaign this is.

isShareable

public boolean isShareable()

If this Campaign is eligible to be shared to others.

getShareUrlEmail

public String getShareUrlEmail()

The URL to share via email.

getShareUrlFacebook

public String getShareUrlFacebook()

The URL to share via Facebook.

getShareUrlTwitter

public String getShareUrlTwitter()

The URL to share via twitter.

getSponsor

public String getSponsor()

The name of the sponsor of this campaign.

getValue

public MonetaryValue getValue()

The amount of credit the user would get for claiming this campaign.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object