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

Overview

LevelUp campaigns are general objects used by merchants and advertisers. They are typically used by merchants to acquire new customers and/or re-engage new customers.

Campaigns

Applications built on the LevelUp SDK will usually interact with campaigns in one of several ways:

  • Users may scan QR codes representing a campaign, which will then claim the campaign for them, and show a success screen providing more information about the campaign, and ways to share the campaign online.
  • Each user has a unique referral code which they can share with their friends. If someone joins LevelUp using their code, both the referring user and the new user will get LevelUp credit. Behind the scenes, these referral programs are implemented using “Refer-a-Friend” campaigns.
  • Some merchants support migration of loyalty cards into LevelUp credit. These are handled by “Legacy Loyalty” campaigns.

Sharing

Some campaigns can be shared by users. Currently, sharing by email, Facebook, and Twitter is supported. If the campaign allows sharing, the campaign will contain initial text that can be used to prefill the sharing dialogs.

Tasks

Properties

campaignID

The unique identifier for this campaign.

@property (nonatomic, copy, readonly) NSNumber *campaignID

Discussion

The unique identifier for this campaign.

Declared In

LUCampaign.h

confirmationHTML

An HTML message to show the user after claiming the campaign.

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

Discussion

An HTML message to show the user after claiming the campaign.

Declared In

LUCampaign.h

global

Specifies that the campaign is global, which means that it applies to all merchants – if a user claims it, they will receive global credit that can be used at any LevelUp merchant.

@property (nonatomic, assign, readonly) BOOL global

Discussion

Specifies that the campaign is global, which means that it applies to all merchants – if a user claims it, they will receive global credit that can be used at any LevelUp merchant.

Declared In

LUCampaign.h

messageForEmailBody

A suggested initial email body to use when a user shares this campaign over email.

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

Discussion

A suggested initial email body to use when a user shares this campaign over email.

Declared In

LUCampaign.h

messageForEmailSubject

A suggested initial email subject to use when a user shares this campaign over email.

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

Discussion

A suggested initial email subject to use when a user shares this campaign over email.

Declared In

LUCampaign.h

messageForFacebook

A suggested initial post to use when a user shares this campaign over Facebook.

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

Discussion

A suggested initial post to use when a user shares this campaign over Facebook.

Declared In

LUCampaign.h

messageForTwitter

A suggested initial post to use when a user shares this campaign over Twitter.

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

Discussion

A suggested initial post to use when a user shares this campaign over Twitter.

Declared In

LUCampaign.h

name

The name of the campaign.

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

Discussion

The name of the campaign.

Declared In

LUCampaign.h

offerHTML

An HTML message describing the campaign.

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

Discussion

An HTML message describing the campaign.

Declared In

LUCampaign.h

shareURLEmail

The URL to use when sharing this campaign via email. Note that this will be included in the email body by the server, so it does not need to be added to the email body.

@property (nonatomic, copy, readonly) NSURL *shareURLEmail

Discussion

The URL to use when sharing this campaign via email. Note that this will be included in the email body by the server, so it does not need to be added to the email body.

Declared In

LUCampaign.h

shareURLFacebook

The URL to use when sharing this campaign via Facebook.

@property (nonatomic, copy, readonly) NSURL *shareURLFacebook

Discussion

The URL to use when sharing this campaign via Facebook.

Declared In

LUCampaign.h

shareURLTwitter

The URL to use when sharing this campaign via Twitter.

@property (nonatomic, copy, readonly) NSURL *shareURLTwitter

Discussion

The URL to use when sharing this campaign via Twitter.

Declared In

LUCampaign.h

shareable

Specifies if this campaign can be shared.

@property (nonatomic, assign, readonly) BOOL shareable

Discussion

Specifies if this campaign can be shared.

Declared In

LUCampaign.h

sponsor

The campaign’s sponsor.

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

Discussion

The campaign’s sponsor.

Declared In

LUCampaign.h

value

The monetary value of the campaign. This is the amount of credit the user will receive after claiming.

@property (nonatomic, strong, readonly) LUMonetaryValue *value

Discussion

The monetary value of the campaign. This is the amount of credit the user will receive after claiming.

Declared In

LUCampaign.h

Instance Methods

confirmationText

A helper method which returns confirmationHTML stripped of HTML tags.

- (NSString *)confirmationText

Discussion

A helper method which returns confirmationHTML stripped of HTML tags.

Declared In

LUCampaign.h

imageURL

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

- (NSURL *)imageURL

Discussion

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

Declared In

LUCampaign.h

offerText

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

- (NSString *)offerText

Discussion

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

Declared In

LUCampaign.h