Interface Context

Provides APIs to handle data campaigns, track Item views and interactions, and track manual actions, all within a lifecycle-managed context such as Screen.

Typically used as Evergage.getScreenForActivity(android.app.Activity), and if necessary, Evergage.getGlobalContext().

MethodModifier and TypeDescription
addToCart(LineItem lineItem)voidTracks that a line item is being added to the shopping cart.
comment(Item item)voidTracks that an item was commented on.
favorite(Item item)voidTracks that an item was marked by the user as a favorite item.
isActive()booleanIf this context is currently active or not.
purchase(Order order)voidTracks that an order was purchased.
review(Item item)voidTracks that an item was reviewed, with no additional details.
review(Item item, Review reviewDetails)voidTracks that an item was reviewed, with the contents (optional) of the review.
setCampaignHandler(CampaignHandler handler, java.lang.String target)voidTo optionally support custom 'Data' campaigns, register a campaign handler for the user-defined target within this context.
share(Item item)voidTracks that an item was shared, for instance by email or on a social network.
trackAction(java.lang.String action)voidSends an event to Personalization describing an action to track.
trackClickthrough(Campaign campaign)voidTracks a clickthrough for the provided campaign.
trackDismissal(Campaign campaign)voidTracks a dismissal for the provided campaign.
trackImpression(Campaign campaign)voidTracks an impression for the provided campaign.
viewCategory(Category category)voidTracks that a category is being viewed.
viewItem(Item item)voidTracks that an item is being viewed.
viewItemDetail(Item item)voidTracks that the details of an item are being viewed, such as other product images or a specifications tab.
viewTag(Tag tag)voidTracks that a tag is being viewed.

isActive

If this context is currently active or not.

A typical Screen context is active when Screen.isRunning() and the app and user are active.

Besides some initial setup just before becoming visible (setCampaignHandler(com.evergage.android.CampaignHandler, java.lang.String), viewItem(com.evergage.android.promote.Item) etc), activity generally occurs while a context is active. Context activity, in addition to app state and user idleness, can affect campaign delivery. For more information, see setCampaignHandler(com.evergage.android.CampaignHandler, java.lang.String).

Returns

true, if this context is currently active.

setCampaignHandler

To optionally support custom data campaigns, register a campaign handler for the user-defined target within this context. Can set a null handler for a target to clear.

The "target" is an user-defined string that uniquely identifies what the payload data represents and its purpose. See Campaign.getTarget().

While the context, app, and user is active, the handler may receive asynchronous callbacks (on the main thread) with campaigns for the target, in response to actions/events sent. The handler code should show/update the campaign to the user, when appropriate. For example code, see CampaignHandler.

Campaigns may be held for delivery while either:

  • The context, app, or user is inactive
  • No handler is found for the campaign's target within this context

For each context and target, only the most recent campaign will be held.

Lifecycle details:

  • For an Activity, it is recommended to always call this method just before becoming visible, specifically onStart().
  • In order to prevent accidental leaks in the CampaignHandler, a Screen has a limited time to become visible, after which its handlers and held campaigns will be cleared.
  • When a screen transitions to not visible onStop(), all handlers and held campaigns are cleared.

Parameters:

ParameterDescription
handlerThe campaign handler this context should use for the specified target.
targetA user-defined string that uniquely identifies what the payload data represents and its purpose. For more information, see Campaign.getTarget().

See Also

trackImpression

Tracks an impression for the provided campaign. Call this method after showing the campaign to the user or if the campaign would be shown but the user is in the control group.

Parameters:

ParameterDescription
campaignThe campaign for which an impression should be tracked.

See Also

trackClickthrough

Tracks a clickthrough for the provided campaign.

Parameters

ParameterDescription
campaignThe campaign for which a clickthrough should be tracked.

See Also

trackDismissal

Tracks a dismissal for the provided campaign.

Parameters

ParameterDescription
campaignThe campaign for which a dismissal should be tracked.

viewItem

Tracks that an item is being viewed.

Set null to indicate no longer viewing any item/category/tag.

For an Activity Screen, it is recommended to call this method within onStart() or onResume() before super.onResume(), if the item is known at that time.

Personalization will automatically track the time spent viewing the item while the context, app, and user is active. The item will remain the one viewed until viewItem or viewItemDetail(com.evergage.android.promote.Item) are called again.

Parameters

ParameterDescription
itemThe item being viewed.

viewItemDetail

Tracks that the details of an item are being viewed, such as other product images or a specifications tab. Set null to indicate no longer viewing any item/category/tag.

For an Activity Screen, it is recommended to call this method within onStart() or onResume() before super.onResume(), if the item is known at that time.

Personalization will automatically track the time spent viewing the item while the context, app, and user is active. The item will remain the one viewed until this method or viewItem(com.evergage.android.promote.Item) are called again.

Parameters

ParameterDescription
itemThe item whose details are being viewed.

viewCategory

Tracks that a category is being viewed.

Set null to indicate no longer viewing any item/category/tag.

For an Activity Screen, it is recommended to call this method within onStart() or onResume() before super.onResume(), if the category is known at that time.

Parameters

ParameterDescription
categoryThe category being viewed.

viewTag

Tracks that a tag is being viewed. Set null to indicate no longer viewing any item/category/tag.

For an Activity Screen, it is recommended to call this method within onStart() or onResume() before super.onResume(), if the tag is known at that time.

Parameters

ParameterDescription
tagThe tag being viewed.

addToCart

Tracks that a line item is being added to the shopping cart.

Parameters

ParameterDescription
lineItemThe line item being added.

purchase

Tracks that an order was purchased. If the order contains no lineItems, the lineItems currently in the cart will be used. If orderId is set and multiple purchase events are received for the same orderId, only the first will be used (all others will be ignored.)

Parameters

ParameterDescription
orderThe order that was purchased.

review

Tracks that an item was reviewed, with no additional details. Equivalent of calling review(Item, Review) with null for the optional review details.

Parameters

ParameterDescription
itemThe item that was reviewed.

review(Item item, Review reviewDetails)

Tracks that an item was reviewed, with the contents (optional) of the review.

Parameters

ParameterDescription
itemThe item that was reviewed.
reviewDetailsThe optional contents of the review, such as the rating.

share

Tracks that an item was shared, for instance by email or on a social network.

Parameters

ParameterDescription
itemThe item that was shared.

comment

Tracks that an item was commented on. For instance, an article or blog might accept comments.

Parameters

ParameterDescription
itemThe item that was commented on.

favorite

Tracks that an item was marked by the user as a favorite item. This is an explicit action taken by the user (often indicated by a single star).

Parameters

ParameterDescription
itemThe item that was marked as favorite.

trackAction

Sends an event to Personalization describing an action to track. When considering the action name, remember that datasets encompass multiple platforms and apps. The name can match a corresponding action/behavior from another platform/app. A campaign can use a source rule to be limited to a specific source or set of sources. For information on recommended rules, see Mobile Data Campaigns.

Actions sent from this context (including Item APIs) can potentially receive a campaign in response, delivered to a handler via setCampaignHandler(com.evergage.android.CampaignHandler, java.lang.String).

Parameters

ParameterDescription
actionA short string that identifies the action.