com.scvngr.levelup.core.model

Class Interstitial

java.lang.Object

com.scvngr.levelup.core.model.Interstitial

All Implemented Interfaces:

Parcelable

@Immutable
 @LevelUpApi(contract=INTERNAL)
public final class Interstitial
extends Object
implements Parcelable

Model representing a receipt interstitial. An interstitial is a callout that is shown on a receipt which offers a call to action to the user. The call to action can be to claim more credit at a merchant, invite their friends to try the merchant, or some other type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Interstitial.ClaimAction Represents an interstitial that can be claimed by the user.
static class	Interstitial.FeedbackAction Represents an interstitial that requests feedback from the user.
static interface	Interstitial.InterstitialAction Interface for the different types of actions.
static class	Interstitial.ShareAction Represents an interstitial that can be shared by the user.
static class	Interstitial.UrlAction Represents an interstitial that contains a URL that can be visited by the user.

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<Interstitial>	CREATOR Implements the Parcelable interface.
static String	TYPE_CLAIM The type returned from getType() if this is a claim Interstitial.
static String	TYPE_FEEDBACK The type returned from getType() if this is a customer feedback Interstitial.
static String	TYPE_NAVIGATION The type returned from getType() if this is a navigation Interstitial.
static String	TYPE_NO_ACTION The type returned from getType() if this is a no_action Interstitial.
static String	TYPE_SHARE The type returned from getType() if this is a share Interstitial.
static String	TYPE_URL The type returned from getType() if this is a URL Interstitial.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Interstitial(Interstitial.InterstitialAction action, String calloutText, String descriptionHtml, String imageUrl, String title, String type)

Method Summary

Modifier and Type	Method and Description
int	describeContents()
boolean	equals(Object o)
<T extends Interstitial.InterstitialAction> T	getAction()
String	getCalloutText() The text to prompt the user to view this interstitial.
String	getDescriptionHtml() The description (encoded in HTML) of the interstitial.
String	getImageUrl() The base URL to the image for this interstitial.
String	getTitle() The title of the interstitial.
String	getType() The type of the interstitial.
int	hashCode()
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<Interstitial> CREATOR

Implements the Parcelable interface.

TYPE_CLAIM

public static final String TYPE_CLAIM

The type returned from getType() if this is a claim Interstitial.

See Also:

Constant Field Values

TYPE_FEEDBACK

public static final String TYPE_FEEDBACK

The type returned from getType() if this is a customer feedback Interstitial.

See Also:

Constant Field Values

TYPE_NAVIGATION

public static final String TYPE_NAVIGATION

The type returned from getType() if this is a navigation Interstitial. The interstitial will include a URL representing an in-app screen to which the user can navigate.

See Also:

Constant Field Values

TYPE_NO_ACTION

public static final String TYPE_NO_ACTION

The type returned from getType() if this is a no_action Interstitial. A No_Action interstitial requires no action from the user, but provides information.

See Also:

Constant Field Values

TYPE_SHARE

public static final String TYPE_SHARE

The type returned from getType() if this is a share Interstitial.

See Also:

Constant Field Values

TYPE_URL

public static final String TYPE_URL

The type returned from getType() if this is a URL Interstitial.

See Also:

Constant Field Values

Constructor Detail

Interstitial

public Interstitial(Interstitial.InterstitialAction action,
                    String calloutText,
                    String descriptionHtml,
                    String imageUrl,
                    String title,
                    String type)

Method Detail

getAction

public final <T extends Interstitial.InterstitialAction> T getAction()

Type Parameters:

T - The type of Interstitial.InterstitialAction to return.

Returns:

The parsed action.

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable

getCalloutText

public String getCalloutText()

The text to prompt the user to view this interstitial.

getDescriptionHtml

public String getDescriptionHtml()

The description (encoded in HTML) of the interstitial.

getImageUrl

public String getImageUrl()

The base URL to the image for this interstitial.

getTitle

public String getTitle()

The title of the interstitial.

getType

public String getType()

The type of the interstitial.

NOTE: This could return any of the recognized types (or a currently unsupported type). This is mostly intended to be used to determine what type will be returned from getAction() .

See Also:

TYPE_CLAIM, TYPE_FEEDBACK, TYPE_NAVIGATION, TYPE_NO_ACTION, TYPE_SHARE, TYPE_URL

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