Package com.swrve.sdk.messaging

Class SwrveEmbeddedCampaign

java.lang.Object

com.swrve.sdk.messaging.SwrveBaseCampaign

com.swrve.sdk.messaging.SwrveEmbeddedCampaign

public class SwrveEmbeddedCampaign
extends SwrveBaseCampaign

Field Summary

Fields

Modifier and Type	Field	Description
protected SwrveEmbeddedMessage	message

Fields inherited from class com.swrve.sdk.messaging.SwrveBaseCampaign

campaignDisplayer, campaignManager, DEFAULT_DELAY_FIRST_MESSAGE, DEFAULT_MAX_IMPRESSIONS, DEFAULT_MIN_DELAY_BETWEEN_MSGS, endDate, id, maxImpressions, messageCenter, messageCenterDetails, minDelayBetweenMessage, name, priority, saveableState, showMessagesAfterLaunch, startDate, subject, triggers

Constructor Summary

Constructors

Constructor	Description
SwrveEmbeddedCampaign(ISwrveCampaignManager campaignManager, SwrveCampaignDisplayer campaignDisplayer, org.json.JSONObject campaignData)

Method Summary

Modifier and Type	Method	Description
boolean	areAssetsReady(java.util.Set<java.lang.String> assetsOnDisk, java.util.Map<java.lang.String,java.lang.String> properties)	Determine if the assets for this campaign have been downloaded.
protected SwrveEmbeddedMessage	createMessage(SwrveEmbeddedCampaign swrveCampaign, org.json.JSONObject messageData)
com.swrve.sdk.QaCampaignInfo.CAMPAIGN_TYPE	getCampaignType()	Used by QAUser to determine what kind of campaign we are reporting
SwrveEmbeddedMessage	getMessage()
SwrveEmbeddedMessage	getMessageForEvent(java.lang.String event, java.util.Map<java.lang.String,java.lang.String> payload, java.util.Date now, java.util.Map<java.lang.Integer,com.swrve.sdk.QaCampaignInfo> qaCampaignInfoMap)
boolean	supportsOrientation(com.swrve.sdk.messaging.SwrveOrientation orientation)

Methods inherited from class com.swrve.sdk.messaging.SwrveBaseCampaign

getDownloadDate, getEndDate, getId, getImpressions, getMaxImpressions, getMessageCenterDetails, getName, getPriority, getSaveableState, getShowMessagesAfterLaunch, getStartDate, getStatus, getSubject, getTriggers, incrementImpressions, isActive, isMessageCenter, messageWasShownToUser, setImpressions, setMessageCenterDetails, setMessageMinDelayThrottle, setSaveableState, setStatus

Methods inherited from class java.lang.Object

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

Field Detail

message

protected SwrveEmbeddedMessage message

Constructor Detail

SwrveEmbeddedCampaign

public SwrveEmbeddedCampaign(ISwrveCampaignManager campaignManager,
                             SwrveCampaignDisplayer campaignDisplayer,
                             org.json.JSONObject campaignData)
                      throws org.json.JSONException

Throws:

org.json.JSONException

Method Detail

supportsOrientation

public boolean supportsOrientation(com.swrve.sdk.messaging.SwrveOrientation orientation)

Specified by:

supportsOrientation in class SwrveBaseCampaign

areAssetsReady

public boolean areAssetsReady(java.util.Set<java.lang.String> assetsOnDisk,
                              java.util.Map<java.lang.String,java.lang.String> properties)

Description copied from class: SwrveBaseCampaign

Determine if the assets for this campaign have been downloaded.

Specified by:

areAssetsReady in class SwrveBaseCampaign

Parameters:

assetsOnDisk - All assets that are already downloaded.

properties - String map of personalized properties.

Returns:

if the assets are ready

getCampaignType

public com.swrve.sdk.QaCampaignInfo.CAMPAIGN_TYPE getCampaignType()

Description copied from class: SwrveBaseCampaign

Used by QAUser to determine what kind of campaign we are reporting

Specified by:

getCampaignType in class SwrveBaseCampaign

Returns:

CAMPAIGN_TYPE enum

createMessage

protected SwrveEmbeddedMessage createMessage(SwrveEmbeddedCampaign swrveCampaign,
                                             org.json.JSONObject messageData)
                                      throws org.json.JSONException

Throws:

org.json.JSONException

getMessage

public SwrveEmbeddedMessage getMessage()

getMessageForEvent

public SwrveEmbeddedMessage getMessageForEvent(java.lang.String event,
                                               java.util.Map<java.lang.String,java.lang.String> payload,
                                               java.util.Date now,
                                               java.util.Map<java.lang.Integer,com.swrve.sdk.QaCampaignInfo> qaCampaignInfoMap)

Parameters:

event - trigger event

payload - payload to compare conditions against

now - device time

qaCampaignInfoMap - will contain the reason the campaign wasn't triggered

Returns:

SwrveEmbeddedMessage message setup to the given trigger or null otherwise.