com.localytics.android

Class InboxCampaign

java.lang.Object

com.localytics.android.Campaign

com.localytics.android.WebViewCampaign

com.localytics.android.InboxCampaign

All Implemented Interfaces:

android.os.Parcelable

public final class InboxCampaign
extends WebViewCampaign

The campaign class containing information relevant to a single inbox campaign. Also includes push to inbox campaigns (getCampaignId() in that case is a push campaign id).

Nested Class Summary

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

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

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<InboxCampaign>	CREATOR

Fields inherited from class com.localytics.android.WebViewCampaign

localCreativeUri, webViewAttributes

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
void	delete() Delete the Inbox Campaign
int	describeContents()
protected java.lang.String	getConversionEventName()
protected android.net.Uri	getCreativeUri() Get the uri pointing to the remote inbox creative.
java.lang.String	getDeepLinkUrl() Get a deep link url sent in a push to inbox campaign
protected java.util.Map<java.lang.String,java.lang.String>	getExtraCampaignEventAttributes(java.lang.String action)
protected long	getInboxId() Get the inbox campaign database auto-incrementing ID
protected android.net.Uri	getLocalThumbnailUri() Get the url pointing to the local location where we can get the inbox thumbnail resource.
protected long	getPtiId() Get the push to inbox campaign database auto-incrementing ID
java.util.Date	getReceivedDate() Get the received date for the campaign
long	getSortOrder() Get the sort order for the campaign.
java.lang.String	getSummary() Get the preview summary of the inbox campaign.
android.net.Uri	getThumbnailUri() Get the uri of the remote thumbnail.
java.lang.String	getTitle() Get the preview title of the inbox campaign.
boolean	hasCreative() Check if the campaign has a creative WebViewCampaign.getCreativeFilePath()
boolean	hasThumbnail() Check if the campaign has a thumbnail getThumbnailUri()
boolean	isDeleted() Get the state of whether or not this campaign is deleted.
boolean	isPushToInboxCampaign() Returns yes if a push to inbox campaign
boolean	isRead() Get the inbox campaign read/unread state.
boolean	isVisible() Get the state of whether or not this campaign should be displayed.
void	setRead(boolean read) Set the inbox campaign read/unread state.
java.lang.String	toString()
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.localytics.android.WebViewCampaign

getCreativeFilePath, getWebViewAttributes

Methods inherited from class com.localytics.android.Campaign

getAbTest, getAttributes, getCampaignId, getName, getRuleName, getSchemaVersion, getVersion

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<InboxCampaign> CREATOR

Method Detail

getInboxId

protected long getInboxId()

Get the inbox campaign database auto-incrementing ID

Returns:

The database auto-incrementing ID

getPtiId

protected long getPtiId()

Get the push to inbox campaign database auto-incrementing ID

Returns:

The database auto-incrementing ID

isRead

public boolean isRead()

Get the inbox campaign read/unread state. This flag can be used to indicate the UI status.

Returns:

true if the inbox campaign is read, otherwise false.

isVisible

public boolean isVisible()

Get the state of whether or not this campaign should be displayed.

Returns:

true if the Inbox campaign has a non-blank title

isDeleted

public boolean isDeleted()

Get the state of whether or not this campaign is deleted.

Returns:

true if the Inbox campaign has been deleted

isPushToInboxCampaign

public boolean isPushToInboxCampaign()

Returns yes if a push to inbox campaign

Returns:

true if the Inbox campaign originated from a push message.

setRead

public void setRead(boolean read)

Set the inbox campaign read/unread state. Setting this flag will also update the Localytics database with the appropriate value

Parameters:

read - true if the inbox campaign is read, otherwise false

delete

public void delete()

Delete the Inbox Campaign

getTitle

@Nullable
public java.lang.String getTitle()

Get the preview title of the inbox campaign.

Returns:

the title string.

getSortOrder

public long getSortOrder()

Get the sort order for the campaign.

Returns:

the sort order for the campaign.

getReceivedDate

@NonNull
public java.util.Date getReceivedDate()

Get the received date for the campaign

Returns:

the received date for th campaign

getSummary

@Nullable
public java.lang.String getSummary()

Get the preview summary of the inbox campaign.

Returns:

the summary string.

hasThumbnail

public boolean hasThumbnail()

Check if the campaign has a thumbnail getThumbnailUri()

Returns:

boolean indicating if the campaign has a thumbnail

getThumbnailUri

@Nullable
public android.net.Uri getThumbnailUri()

Get the uri of the remote thumbnail.

Returns:

the uri pointing to the remote thumbnail.

hasCreative

public boolean hasCreative()

Check if the campaign has a creative WebViewCampaign.getCreativeFilePath()

Returns:

boolean indicating if the campaign has a creative

getDeepLinkUrl

@Nullable
public java.lang.String getDeepLinkUrl()

Get a deep link url sent in a push to inbox campaign

Returns:

a deep link url

getCreativeUri

@Nullable
protected android.net.Uri getCreativeUri()

Get the uri pointing to the remote inbox creative.

Returns:

the uri pointing to the remote creative

getLocalThumbnailUri

@Nullable
protected android.net.Uri getLocalThumbnailUri()

Get the url pointing to the local location where we can get the inbox thumbnail resource.

Returns:

the uri pointing to the inbox thumbnail resource on the local device

getExtraCampaignEventAttributes

@NonNull
protected java.util.Map<java.lang.String,java.lang.String> getExtraCampaignEventAttributes(@NonNull
                                                                                                    java.lang.String action)

Specified by:

getExtraCampaignEventAttributes in class WebViewCampaign

getConversionEventName

@NonNull
protected java.lang.String getConversionEventName()

Specified by:

getConversionEventName in class WebViewCampaign

toString

@NonNull
public java.lang.String toString()

Overrides:

toString in class java.lang.Object

describeContents

public int describeContents()

writeToParcel

public void writeToParcel(@NonNull
                          android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable

Overrides:

writeToParcel in class WebViewCampaign