Inherits from LUAPIModel : NSObject
Declared in LUInterstitial.h
LUInterstitial.m

Overview

An order may be associated with an LUInterstital, which represents an interstitial view that can be shown to the user. Interstitials can be used for things like showing additional information to the user, prompting them to share information about the merchant, or claiming a campaign.

An interstitial may optionally have an action for the user to complete. There are several possible actions based on the actionType. See LUInterstitialActionType for a full list of types.

The action property of LUInterstitialAction will contain additional properties relevant to the particular type. It may be nil (if the action type is “none” or “unknown”), or it may be an instance of LUInterstitialClaimAction, LUInterstitialFeedbackAction, LUInterstitialShareAction, or LUInterstitialURLAction.

Properties

action

An object with information about the action that this interstitial is requesting from the user.

@property (nonatomic, strong, readonly) id action

Discussion

An object with information about the action that this interstitial is requesting from the user.

The type of this property depends on the value of the actionType property:

Declared In

LUInterstitial.h

actionType

The type of action this interstitial is requesting.

@property (nonatomic, assign, readonly) LUInterstitialActionType actionType

Discussion

The type of action this interstitial is requesting.

Will be one of: LUInterstitialActionTypeUnknown, LUInterstitialActionTypeNone, LUInterstitialActionTypeClaim, LUInterstitialActionTypeFeedback, LUInterstitialActionTypeShare, LUInterstitialActionTypeURL, LUInterstitialActionTypeNavigation.

Declared In

LUInterstitial.h

calloutText

The callout text for the interstitial.

@property (nonatomic, copy, readonly) NSString *calloutText

Discussion

The callout text for the interstitial.

Declared In

LUInterstitial.h

descriptionHTML

An HTML description of the interstitial.

@property (nonatomic, copy, readonly) NSString *descriptionHTML

Discussion

An HTML description of the interstitial.

Declared In

LUInterstitial.h

imageURL

An image for this interstitial. Will automatically return a retina or non-retina scaled image based on the screen scale of the device. The resolution is 320x212.

@property (nonatomic, strong, readonly) NSURL *imageURL

Discussion

An image for this interstitial. Will automatically return a retina or non-retina scaled image based on the screen scale of the device. The resolution is 320x212.

Declared In

LUInterstitial.h

title

The title of the interstitial.

@property (nonatomic, copy, readonly) NSString *title

Discussion

The title of the interstitial.

Declared In

LUInterstitial.h

Instance Methods

actionTypeString

Returns an NSString for this interstitial’s actionType.

- (NSString *)actionTypeString

Discussion

Returns an NSString for this interstitial’s actionType.

Declared In

LUInterstitial.h

descriptionText

A helper method which returns the descriptionHTML stripped of HTML tags.

- (NSString *)descriptionText

Discussion

A helper method which returns the descriptionHTML stripped of HTML tags.

Declared In

LUInterstitial.h