Content (Swirl Proximity Library)

java.lang.Object
- com.swirl.Content

```
public class Content
extends java.lang.Object
```
A Content object represents targeted content received from the platform in response to a proximity signal: beacon, wifi network or geo-location change.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ACTION_DISMISS_NOTIFICATION` Action for Dismiss notification Intents.
`static java.lang.String`	`ACTION_OPEN_NOTIFICATION` Action for open notification Intents.
`static java.lang.String`	`CONTENT_TYPE_CUSTOM` Content with this type can generate notifications, but otherwise is just passed through to the application.
`static java.lang.String`	`CONTENT_TYPE_SWIRL` Content with this type is presented as an interstitial web view.
`static java.lang.String`	`CONTENT_TYPE_SWIRL_URL` Content with this type is present as an interstitial web view
`static java.lang.String`	`CONTENT_TYPE_URL` Content with this type is used for deep-links back into the application or other applications.
`static java.lang.String`	`EXTRA_CONTENT` Extra for notification Intents that contains a JSON String of the raw content.
`static java.lang.String`	`EXTRA_IMPRESSION` Extra for representing the impression id.

Constructor Summary

Constructors
Constructor and Description
`Content(android.content.Context ctx, android.content.Intent intent, boolean fromNotification)`
`Content(android.content.Context ctx, org.json.JSONObject data, Visit v, boolean fromNotification)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`org.json.JSONObject`	`getAttributes()` Get the attributes associated with this content.
`java.lang.String`	`getCustomType()` Get the custom content type associeted with this content
`android.net.Uri`	`getFallbackURL()` Get the fallback URL associated with this content.
`java.lang.String`	`getIdentifier()` Get the impression identifier associated with this content.
`android.app.Notification`	`getNotification(boolean silent, android.graphics.Bitmap image)` Get a operating system Notification object for this content or null if the content has no notification.
`java.lang.String`	`getNotificationText()` Gets the notification text if present
`java.lang.String`	`getNotificationTitle()` Gets the notification title if present or application label if not
`void`	`getNotificationWithImage(boolean silent, Completion completion)` Get a operating system Notification object for this content or null if the content has no notification.
`android.content.Intent`	`getShareIntent()` Returns an Intent suitable for using with the Android Share Widget
`long`	`getTimestamp()` Returns the milliseconds since epoch of when the content was received by the client.
`java.lang.String`	`getType()` Get the content type associated with this content.
`android.net.Uri`	`getURL()` Get the URL associated with this content.
`Visit`	`getVisit()` Get the Visit object associated with this content (if present)
`int`	`hashCode()`
`boolean`	`isFromNotification()` Returns whether this content was delivered via a notification interaction.
`boolean`	`isRemoteNotification()` Determine if this content was sent as a remote notification.
`org.json.JSONObject`	`toJSON()` Convert the Content object to a JSONObject
`java.lang.String`	`toString()`

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

- Field Detail
  - CONTENT_TYPE_CUSTOM
```
public static final java.lang.String CONTENT_TYPE_CUSTOM
```
    Content with this type can generate notifications, but otherwise is just passed through to the application.
    
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE_URL
```
public static final java.lang.String CONTENT_TYPE_URL
```
    Content with this type is used for deep-links back into the application or other applications.
    
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE_SWIRL
```
public static final java.lang.String CONTENT_TYPE_SWIRL
```
    Content with this type is presented as an interstitial web view.
    
    See Also:
    
    Constant Field Values
  - CONTENT_TYPE_SWIRL_URL
```
public static final java.lang.String CONTENT_TYPE_SWIRL_URL
```
    Content with this type is present as an interstitial web view
    
    See Also:
    
    Constant Field Values
  - ACTION_OPEN_NOTIFICATION
```
public static final java.lang.String ACTION_OPEN_NOTIFICATION
```
    Action for open notification Intents.
    
    See Also:
    
    Constant Field Values
  - ACTION_DISMISS_NOTIFICATION
```
public static final java.lang.String ACTION_DISMISS_NOTIFICATION
```
    Action for Dismiss notification Intents.
    
    See Also:
    
    Constant Field Values
  - EXTRA_CONTENT
```
public static final java.lang.String EXTRA_CONTENT
```
    Extra for notification Intents that contains a JSON String of the raw content. This is used to reconstruct a Content object when the Intent is decoded.
    
    See Also:
    
    Constant Field Values
  - EXTRA_IMPRESSION
```
public static final java.lang.String EXTRA_IMPRESSION
```
    Extra for representing the impression id.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Content
```
public Content(android.content.Context ctx,
               org.json.JSONObject data,
               Visit v,
               boolean fromNotification)
```
  - Content
```
public Content(android.content.Context ctx,
               android.content.Intent intent,
               boolean fromNotification)
```
- Method Detail
  - isFromNotification
```
public boolean isFromNotification()
```
    Returns whether this content was delivered via a notification interaction.
    
    Returns:
    
    true if content created from notification open
  - getShareIntent
```
public android.content.Intent getShareIntent()
```
    Returns an Intent suitable for using with the Android Share Widget
    
    Returns:
    
    Intent
  - getVisit
```
public Visit getVisit()
```
    Get the Visit object associated with this content (if present)
    
    Returns:
    
    Visit or null
  - getIdentifier
```
public java.lang.String getIdentifier()
```
    Get the impression identifier associated with this content. An impression identifier is a unique identifier associated with an instance of content delivery.
    
    Returns:
    
    impression identifier
  - getNotificationTitle
```
public java.lang.String getNotificationTitle()
```
    Gets the notification title if present or application label if not
    
    Returns:
    
    notification title
  - getNotificationText
```
public java.lang.String getNotificationText()
```
    Gets the notification text if present
    
    Returns:
    
    notification text
  - getTimestamp
```
public long getTimestamp()
```
    Returns the milliseconds since epoch of when the content was received by the client.
    
    Returns:
    
    received timestamp
  - getType
```
public java.lang.String getType()
```
    Get the content type associated with this content.
    
    Returns:
    
    one of CONTENT_TYPE_CUSTOM, CONTENT_TYPE_URL, CONTENT_TYPE_SWIRL
  - isRemoteNotification
```
public boolean isRemoteNotification()
```
    Determine if this content was sent as a remote notification.
    
    Returns:
    
    true if content sent as a remote notification, false otherwise
  - getCustomType
```
public java.lang.String getCustomType()
```
    Get the custom content type associeted with this content
    
    Returns:
    
    custom type string or empty-string
  - getURL
```
public android.net.Uri getURL()
```
    Get the URL associated with this content.
    
    Returns:
    
    URL
  - getFallbackURL
```
public android.net.Uri getFallbackURL()
```
    Get the fallback URL associated with this content.
    
    Returns:
    
    URL
  - getAttributes
```
public org.json.JSONObject getAttributes()
```
    Get the attributes associated with this content.
    
    Returns:
    
    attributes
  - getNotification
```
public android.app.Notification getNotification(boolean silent,
                                                android.graphics.Bitmap image)
```
    Get a operating system Notification object for this content or null if the content has no notification.
    
    Parameters:
    
    silent - yes/no
    
    image - if image present, create bigImage style, otherwise text
    
    Returns:
    
    the notification
  - getNotificationWithImage
```
public void getNotificationWithImage(boolean silent,
                                     Completion completion)
```
    Get a operating system Notification object for this content or null if the content has no notification.
    
    Parameters:
    
    silent - yes/no
    
    completion - call this completion when the notification (and assets) are ready
  - toJSON
```
public org.json.JSONObject toJSON()
```
    Convert the Content object to a JSONObject
    
    Returns:
    
    JSONObject representation of the Content object.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class Content

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTENT_TYPE_CUSTOM

CONTENT_TYPE_URL

CONTENT_TYPE_SWIRL

CONTENT_TYPE_SWIRL_URL

ACTION_OPEN_NOTIFICATION

ACTION_DISMISS_NOTIFICATION

EXTRA_CONTENT

EXTRA_IMPRESSION

Constructor Detail

Content

Content

Method Detail

isFromNotification

getShareIntent

getVisit

getIdentifier

getNotificationTitle

getNotificationText

getTimestamp

getType

isRemoteNotification

getCustomType

getURL

getFallbackURL

getAttributes

getNotification

getNotificationWithImage

toJSON

toString

equals

hashCode