ContentManager (Swirl Proximity Library)

java.lang.Object
- com.swirl.Manager
- - com.swirl.ContentManager

```
public class ContentManager
extends Manager
```
The ContentManager requests Content from the platform (through the API) in response to events generated by the VisitManager. It is responsible for generating operating system Notifications where appropriate (depending upon Settings) and for generating log events to reflect user and application behavior with respect to the Notifications and any presented Content.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`ContentManager.ContentEvent` ContentEvent is the base class for all content events.
`class`	`ContentManager.ReceiveContentCustomEvent` This event is sent when content of type Custom is received.
`class`	`ContentManager.ReceiveContentURLEvent` This event is sent when content of type URL is received.
`class`	`ContentManager.ReceiveContentViewEvent` This event is sent when content of type Swirl is received.

Field Summary

Fields
Modifier and Type	Field and Description
`protected ContentView`	`contentView`
`protected android.content.Context`	`context`
`static java.lang.String`	`EVENT_IMPRESSION_1` These events are for user-defined reporting
`static java.lang.String`	`EVENT_IMPRESSION_10`
`static java.lang.String`	`EVENT_IMPRESSION_2`
`static java.lang.String`	`EVENT_IMPRESSION_3`
`static java.lang.String`	`EVENT_IMPRESSION_4`
`static java.lang.String`	`EVENT_IMPRESSION_5`
`static java.lang.String`	`EVENT_IMPRESSION_6`
`static java.lang.String`	`EVENT_IMPRESSION_7`
`static java.lang.String`	`EVENT_IMPRESSION_8`
`static java.lang.String`	`EVENT_IMPRESSION_9`
`static java.lang.String`	`EVENT_IMPRESSION_OFFER_REDEEMED` This event is added to the log stream when an offer is redeeemed.
`static java.lang.String`	`EVENT_IMPRESSION_REJECTED` This event is added to the log stream when an impression is rejected via the override shouldShowContent.
`static java.lang.String`	`EVENT_IMPRESSION_SAVED` This event is added to the log stream when an impression is saved.
`static java.lang.String`	`EVENT_IMPRESSION_SHARED` This event is added to the log stream when an impression is shared.
`static java.lang.String`	`EVENT_IMPRESSION_TAP_AREA` This event is added to the log stream when a tap area is hit
`static java.lang.String`	`EVENT_IMPRESSION_TIMEOUT` This event is added to the log stream when a presentation is rejected by the application due to being too old (stale).
`static java.lang.String`	`EVENT_IMPRESSION_TOUCHED` This event is added to the log stream whena n impression is touched.
`static java.lang.String`	`EVENT_IMPRESSION_VIEWED` This event is added to the log stream when an impressions is viewed.
`static java.lang.String`	`EVENT_IMPRESSION_VIEWED_MINIMIZED` This event is added to the log stream when an impressions is viewed using alternate layout
`static java.lang.String`	`EVENT_IMPRESSION_WALLET_REDEEMED` This event is added to the log stream when a wallet item is redeeemed
`static java.lang.String`	`EVENT_NOTIFICATION_ABSENT` This event is added to the log stream when content does not contain a notification.
`static java.lang.String`	`EVENT_NOTIFICATION_DISABLE` This event is added to the log stream when notifications are disabled.
`static java.lang.String`	`EVENT_NOTIFICATION_DISMISS` This event is added to the log stream when a notification is dismissed.
`static java.lang.String`	`EVENT_NOTIFICATION_OPEN` This event is added to the log stream when a notification is opened.
`static java.lang.String`	`EVENT_NOTIFICATION_SENT` This event is added to the log stream when a notification is sent without any of the othe qualifications.
`static java.lang.String`	`EVENT_NOTIFICATION_SENT_BLOCKED` This event is added to the log stream when a notification is present, but the user has blocked notifications.
`static java.lang.String`	`EVENT_NOTIFICATION_SENT_NOSOUND` This event is added to the log stream when a notification is present, but the user has disallowed sound (or vibration) for notifications.
`static java.lang.String`	`EVENT_NOTIFICATION_TIMEOUT` This event is added to the log stream when a notification is rejected by the application due to being too old (stale).
`static java.lang.String`	`EVENT_NOTIFICATON_REJECTED` This event is added to the log stream when a notification is rejected by the application via the shouldShowNotification override.

Constructor Summary

Constructors
Constructor and Description

ContentManager(android.content.Context context)

Constructors
Constructor and Description
`ContentManager(android.content.Context context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ContentView`	`getContentView()` Returns the default ContentView.
`static ContentManager`	`getInstance()` Returns the last ContentManager created.
`Content`	`getLastContent()` Returns the last content received, regardless of whether it has been shown or not.
`Content`	`getLastShown()` Returns the last content shown (in this session)
`void`	`handleURLIntent(android.content.Intent intent)` Called to handle an URL Intent Default implementation is context.startActivity(intent)
`protected void`	`handleViewIntent(android.content.Intent intent)` Called to handle a view activity intent Default implementation is context.startActivity(intent)
`protected android.content.Intent`	`intentForContent(Content content)`
`protected android.content.Intent`	`intentForContentActivity(android.content.Context context)` Called before starting the ContentActivity to proved an opportunity to subclass the default ContentActivity.
`protected void`	`notifyForContent(Content content)` Called to display a notification for content.
`void`	`onBeginVisit(VisitManager.BeginVisitEvent event)` This method is public for technical reasons.
`void`	`onDwellVisit(VisitManager.DwellVisitEvent event)` This method is public for technical reasons.
`void`	`onEndVisit(VisitManager.EndVisitEvent event)` This method is public for technical reasons.
`void`	`onForeground(Swirl.ForegroundEvent event)` This method is public for technical reasons.
`void`	`onIntent(android.content.Intent intent)` This method is public for technical reasons.
`void`	`onReceiveContent(Content content)`
`protected void`	`onReceiveContentCustom(Content content)` Called when content of type Custom is received.
`protected void`	`onReceiveContentURL(Content content)` Called when content of type URL is received.
`protected void`	`onReceiveContentView(Content content)` Called when content of type Swirl is received.
`void`	`requestContentPreview(java.lang.String previewCode, SafeRunnable completion)` Force a request for content with a preview code.
`protected void`	`shouldNotifyForContent(Content content, Completion completion)` Called before a notification is generated (async).
`protected boolean`	`shouldNotifyForContent(Content content, android.app.Notification notification)` Called before a notification is presented.
`protected boolean`	`shouldStartContentURLActivity(Content content, android.content.Intent intent)` Called before CONTENT_TYPE_URL content is activated.
`protected boolean`	`shouldStartContentViewActivity(Content content, android.content.Intent intent)` Called before CONTENT_TYPE_SWIRL content is activated.
`void`	`showToastForContent(Content content)`
`void`	`start()` Starts the manager.
`void`	`startContentViewActivity()` Forces the a call to startActivity on the ContentActivity.
`void`	`stop()` Stops the manager.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EVENT_NOTIFICATION_DISABLE
```
public static final java.lang.String EVENT_NOTIFICATION_DISABLE
```
    This event is added to the log stream when notifications are disabled.
    
    See Also:
    
    Constant Field Values
  - EVENT_NOTIFICATION_ABSENT
```
public static final java.lang.String EVENT_NOTIFICATION_ABSENT
```
    This event is added to the log stream when content does not contain a notification.
    
    See Also:
    
    Constant Field Values
  - EVENT_NOTIFICATON_REJECTED
```
public static final java.lang.String EVENT_NOTIFICATON_REJECTED
```
    This event is added to the log stream when a notification is rejected by the application via the shouldShowNotification override.
    
    See Also:
    
    Constant Field Values
  - EVENT_NOTIFICATION_TIMEOUT
```
public static final java.lang.String EVENT_NOTIFICATION_TIMEOUT
```
    This event is added to the log stream when a notification is rejected by the application due to being too old (stale). Content is validated for recency (<15m) before notification is sent.
    
    See Also:
    
    Constant Field Values
  - EVENT_NOTIFICATION_SENT_BLOCKED
```
public static final java.lang.String EVENT_NOTIFICATION_SENT_BLOCKED
```
    This event is added to the log stream when a notification is present, but the user has blocked notifications.
    
    See Also:
    
    Constant Field Values
  - EVENT_NOTIFICATION_SENT_NOSOUND
```
public static final java.lang.String EVENT_NOTIFICATION_SENT_NOSOUND
```
    This event is added to the log stream when a notification is present, but the user has disallowed sound (or vibration) for notifications.
    
    See Also:
    
    Constant Field Values
  - EVENT_NOTIFICATION_SENT
```
public static final java.lang.String EVENT_NOTIFICATION_SENT
```
    This event is added to the log stream when a notification is sent without any of the othe qualifications.
    
    See Also:
    
    Constant Field Values
  - EVENT_NOTIFICATION_OPEN
```
public static final java.lang.String EVENT_NOTIFICATION_OPEN
```
    This event is added to the log stream when a notification is opened.
    
    See Also:
    
    Constant Field Values
  - EVENT_NOTIFICATION_DISMISS
```
public static final java.lang.String EVENT_NOTIFICATION_DISMISS
```
    This event is added to the log stream when a notification is dismissed.
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_VIEWED
```
public static final java.lang.String EVENT_IMPRESSION_VIEWED
```
    This event is added to the log stream when an impressions is viewed.
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_VIEWED_MINIMIZED
```
public static final java.lang.String EVENT_IMPRESSION_VIEWED_MINIMIZED
```
    This event is added to the log stream when an impressions is viewed using alternate layout
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_REJECTED
```
public static final java.lang.String EVENT_IMPRESSION_REJECTED
```
    This event is added to the log stream when an impression is rejected via the override shouldShowContent.
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_SHARED
```
public static final java.lang.String EVENT_IMPRESSION_SHARED
```
    This event is added to the log stream when an impression is shared.
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_TIMEOUT
```
public static final java.lang.String EVENT_IMPRESSION_TIMEOUT
```
    This event is added to the log stream when a presentation is rejected by the application due to being too old (stale). Content is validated for recency (<15m) before starting the content activity.
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_SAVED
```
public static final java.lang.String EVENT_IMPRESSION_SAVED
```
    This event is added to the log stream when an impression is saved.
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_TOUCHED
```
public static final java.lang.String EVENT_IMPRESSION_TOUCHED
```
    This event is added to the log stream whena n impression is touched.
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_OFFER_REDEEMED
```
public static final java.lang.String EVENT_IMPRESSION_OFFER_REDEEMED
```
    This event is added to the log stream when an offer is redeeemed.
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_WALLET_REDEEMED
```
public static final java.lang.String EVENT_IMPRESSION_WALLET_REDEEMED
```
    This event is added to the log stream when a wallet item is redeeemed
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_TAP_AREA
```
public static final java.lang.String EVENT_IMPRESSION_TAP_AREA
```
    This event is added to the log stream when a tap area is hit
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_1
```
public static final java.lang.String EVENT_IMPRESSION_1
```
    These events are for user-defined reporting
    
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_2
```
public static final java.lang.String EVENT_IMPRESSION_2
```
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_3
```
public static final java.lang.String EVENT_IMPRESSION_3
```
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_4
```
public static final java.lang.String EVENT_IMPRESSION_4
```
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_5
```
public static final java.lang.String EVENT_IMPRESSION_5
```
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_6
```
public static final java.lang.String EVENT_IMPRESSION_6
```
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_7
```
public static final java.lang.String EVENT_IMPRESSION_7
```
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_8
```
public static final java.lang.String EVENT_IMPRESSION_8
```
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_9
```
public static final java.lang.String EVENT_IMPRESSION_9
```
    See Also:
    
    Constant Field Values
  - EVENT_IMPRESSION_10
```
public static final java.lang.String EVENT_IMPRESSION_10
```
    See Also:
    
    Constant Field Values
  - context
```
protected android.content.Context context
```
  - contentView
```
protected ContentView contentView
```
- Constructor Detail
  - ContentManager
```
public ContentManager(android.content.Context context)
```
- Method Detail
  - getInstance
```
public static ContentManager getInstance()
```
    Returns the last ContentManager created. Usually there is only one. It will return null if there is no ContentManager.
    
    Returns:
    
    ContentManager
  - start
```
public void start()
```
    Description copied from class: Manager
    
    Starts the manager.
  - stop
```
public void stop()
```
    Description copied from class: Manager
    
    Stops the manager.
  - showToastForContent
```
public void showToastForContent(Content content)
```
  - getContentView
```
public ContentView getContentView()
```
    Returns the default ContentView. If you want to customize the look and feel or behavior you can override this method and return a subclass of ContentView that you create. The default implementation does this:
```
     
      public ContentView getContentView() {
          return (contentView != null ? contentView : (contentView = new ContentView(context)));
      }

     
 
```
    Returns:
    
    an instance of ContentView or subclass
  - getLastContent
```
public Content getLastContent()
```
    Returns the last content received, regardless of whether it has been shown or not.
    
    Returns:
    
    an Content object representing the last content received or null.
  - getLastShown
```
public Content getLastShown()
```
    Returns the last content shown (in this session)
    
    Returns:
    
    an Content object representing the last content shown or null.
  - handleURLIntent
```
public void handleURLIntent(android.content.Intent intent)
```
    Called to handle an URL Intent Default implementation is context.startActivity(intent)
    
    Parameters:
    
    intent - the URL intent to start
  - shouldStartContentURLActivity
```
protected boolean shouldStartContentURLActivity(Content content,
                                                android.content.Intent intent)
```
    Called before CONTENT_TYPE_URL content is activated. If override, provides an opportunity for the subclass to accept, reject or alter the intent. The default behavior is to call startActivity with the intent passed.
    
    Parameters:
    
    content - The content containing the URL and fallbackURL
    
    intent - An intent based on that content
    
    Returns:
    
    true to open the content, false to stop the process, default is true
  - handleViewIntent
```
protected void handleViewIntent(android.content.Intent intent)
```
    Called to handle a view activity intent Default implementation is context.startActivity(intent)
    
    Parameters:
    
    intent - the intent to start the content view
  - shouldStartContentViewActivity
```
protected boolean shouldStartContentViewActivity(Content content,
                                                 android.content.Intent intent)
```
    Called before CONTENT_TYPE_SWIRL content is activated. If override, provides an opportunity for the subclass to accept, reject or alter the intent. The default behavior is to call startActivity with the intent passed.
    
    Parameters:
    
    content - The content containing an URL to a html interstitial
    
    intent - An intent based on that content
    
    Returns:
    
    true to open the content, false to stop the process, default is true
  - intentForContentActivity
```
protected android.content.Intent intentForContentActivity(android.content.Context context)
```
    Called before starting the ContentActivity to proved an opportunity to subclass the default ContentActivity.
    
    Parameters:
    
    context - Context to user
    
    Returns:
    
    Intent returns an intent with the supplied context and 'ContentActivity.class' and FLAG_ACTIVITY_NEW_TASK | FLAG_ACTIVITY_SINGLE_TOP
  - intentForContent
```
protected android.content.Intent intentForContent(Content content)
```
  - startContentViewActivity
```
public void startContentViewActivity()
```
    Forces the a call to startActivity on the ContentActivity. This is used by an application to show the content window without regard to any proximity triggers.
  - shouldNotifyForContent
```
protected boolean shouldNotifyForContent(Content content,
                                         android.app.Notification notification)
```
    Called before a notification is presented. Subclasses that override this method can accept, reject before display.
    
    Parameters:
    
    content - The content containing an URL to a html interstitial
    
    notification - The notification constructed from the content.
    
    Returns:
    
    true show the notification, false to reject it
  - shouldNotifyForContent
```
protected void shouldNotifyForContent(Content content,
                                      Completion completion)
```
    Called before a notification is generated (async). Subclasses can override this method can accept, reject or modify the content before display. The completion.complete must be called to complete processing of the notification. Call completion.complete(0, content) to allow processing, call completion.complete(-1, content) to block or reject the notification. By default, this calls the synchronous version of this method.
    
    Parameters:
    
    content - The content containing the notification
    
    completion - The completion object to call when processing is done
  - notifyForContent
```
protected void notifyForContent(Content content)
```
    Called to display a notification for content. This can be used to display a notification associated with custom content handling in order to have swirl manage the generation of the notification and the associated analytics events.
    
    Parameters:
    
    content -
  - onReceiveContentURL
```
protected void onReceiveContentURL(Content content)
```
    Called when content of type URL is received. Can be overriden. The default action is to post a ReceiveContentURLEvent to the EventBus.
    
    Parameters:
    
    content - The content that was received.
  - onReceiveContentView
```
protected void onReceiveContentView(Content content)
```
    Called when content of type Swirl is received. Can be overriden. The default action is to post a ReceiveContentViewEvent to the EventBus.
    
    Parameters:
    
    content - The content that was received.
  - onReceiveContentCustom
```
protected void onReceiveContentCustom(Content content)
```
    Called when content of type Custom is received. Can be overriden. The default action is to post a ReceiveContentCustomEvent to the EventBus.
    
    Parameters:
    
    content - The content that was received.
  - onReceiveContent
```
public void onReceiveContent(Content content)
```
  - requestContentPreview
```
public void requestContentPreview(java.lang.String previewCode,
                                  SafeRunnable completion)
```
    Force a request for content with a preview code. Used for previewing a creative on the mobile device. If content is returned, the normal receive content process is followed which will result in an interstitial view. In either case, the completion (if provided) is called with an error or 0 if no error.
    
    Parameters:
    
    previewCode - preview code retrieved from the platform
    
    completion - optional completion that is called when the content request completes.
  - onForeground
```
public void onForeground(Swirl.ForegroundEvent event)
```
    This method is public for technical reasons. It is not intended to be called except tye the EventBus.
    
    Parameters:
    
    event - The dispatched event.
  - onIntent
```
public void onIntent(android.content.Intent intent)
```
    This method is public for technical reasons. It is not intended to be called except tye the EventBus.
    
    Parameters:
    
    intent - The dispatched event.
  - onBeginVisit
```
public void onBeginVisit(VisitManager.BeginVisitEvent event)
```
    This method is public for technical reasons. It is not intended to be called except by the EventBus.
    
    Parameters:
    
    event - The dispatched event.
  - onDwellVisit
```
public void onDwellVisit(VisitManager.DwellVisitEvent event)
```
    This method is public for technical reasons. It is not intended to be called except by the EventBus.
    
    Parameters:
    
    event - The dispatched event.
  - onEndVisit
```
public void onEndVisit(VisitManager.EndVisitEvent event)
```
    This method is public for technical reasons. It is not intended to be called except by the EventBus.
    
    Parameters:
    
    event - The dispatched event.

Class ContentManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EVENT_NOTIFICATION_DISABLE

EVENT_NOTIFICATION_ABSENT

EVENT_NOTIFICATON_REJECTED

EVENT_NOTIFICATION_TIMEOUT

EVENT_NOTIFICATION_SENT_BLOCKED

EVENT_NOTIFICATION_SENT_NOSOUND

EVENT_NOTIFICATION_SENT

EVENT_NOTIFICATION_OPEN

EVENT_NOTIFICATION_DISMISS

EVENT_IMPRESSION_VIEWED

EVENT_IMPRESSION_VIEWED_MINIMIZED

EVENT_IMPRESSION_REJECTED

EVENT_IMPRESSION_SHARED

EVENT_IMPRESSION_TIMEOUT

EVENT_IMPRESSION_SAVED

EVENT_IMPRESSION_TOUCHED

EVENT_IMPRESSION_OFFER_REDEEMED

EVENT_IMPRESSION_WALLET_REDEEMED

EVENT_IMPRESSION_TAP_AREA

EVENT_IMPRESSION_1

EVENT_IMPRESSION_2

EVENT_IMPRESSION_3

EVENT_IMPRESSION_4

EVENT_IMPRESSION_5

EVENT_IMPRESSION_6

EVENT_IMPRESSION_7

EVENT_IMPRESSION_8

EVENT_IMPRESSION_9

EVENT_IMPRESSION_10

context

contentView

Constructor Detail

ContentManager

Method Detail

getInstance

start

stop

showToastForContent

getContentView

getLastContent

getLastShown

handleURLIntent

shouldStartContentURLActivity

handleViewIntent

shouldStartContentViewActivity

intentForContentActivity

intentForContent

startContentViewActivity

shouldNotifyForContent

shouldNotifyForContent

notifyForContent

onReceiveContentURL

onReceiveContentView

onReceiveContentCustom

onReceiveContent

requestContentPreview

onForeground

onIntent

onBeginVisit

onDwellVisit

onEndVisit