public class

AccengageMessage

extends Object
java.lang.Object
   ↳ com.urbanairship.accengage.AccengageMessage

Class Overview

Accengage push message.

Summary

Nested Classes
@interface AccengageMessage.Action Accengage actions. 
Constants
String ACCENGAGE_BIG_PICTURE_STYLE Big picture notification style.
String ACCENGAGE_BIG_TEXT_BIG_PICTURE_COLLAPSED_TEMPLATE Big text big picture collapsed style.
String ACCENGAGE_BIG_TEXT_BIG_PICTURE_EXPANDED_TEMPLATE Big text big picture expanded template.
String ACCENGAGE_BIG_TEXT_STYLE Big text notification style.
String ACCENGAGE_INBOX_STYLE Inbox notification style.
String ACTION_OPEN_URL Browser action.
String ACTION_SHOW_WEBVIEW Web view action.
String ACTION_TRACK_URL Track URL action.
Public Methods
static AccengageMessage fromAirshipPushMessage(PushMessage message)
Factory method.
int getAccengageAccentColor()
Gets Accengage push accent color
int getAccengageAccentColor(int defaultValue)
Gets Accengage push accent color
String getAccengageAction()
Gets Accengage push action.
String getAccengageAppName()
Gets the push app name from Accengage custom params.
String getAccengageBigContent()
Gets Accengage push big content.
String getAccengageBigPictureUrl()
Gets Accengage push big picture url.
String getAccengageBigTemplate()
Gets Accengage push extended template.
int getAccengageBigTemplateId(Context context)
Gets the Accengage big template Id.
String getAccengageCategory()
Gets Accengage push category
String getAccengageChannel()
Gets Accengage push channel.
String getAccengageContent()
Gets Accengage push content.
String getAccengageContentInfo()
Gets Accengage push content info.
boolean getAccengageForeground()
Tells if Accengage push can be displayed in foreground.
String getAccengageGroup()
Gets Accengage push group.
boolean getAccengageGroupSummary()
Gets Accengage push group summary.
String getAccengageHeaderText()
Gets the push header text from Accengage custom params
boolean getAccengageIsDecorated()
Tells if Accengage push should be decorated.
String getAccengageLargeIcon()
Gets Accengage push large icon.
String getAccengageNotificationSound()
Gets Accengage push notification sound.
boolean getAccengageOpenWithBrowser()
Tells if Accengage push action should be opened with browser or with webview.
int getAccengagePriority()
Gets Accengage push priority
int getAccengageSmallIcon(Context context)
This method is deprecated. Use #getAccengageSmallIcon(Context, int) instead.
String getAccengageSubtext()
Gets Accengage push subtext.
String getAccengageSummaryText()
Gets Accengage push summary text.
int getAccengageSystemId()
Gets Accengage push system ID.
String getAccengageTemplate()
Gets Accengage push collapsed template.
int getAccengageTemplateId(Context context)
Gets the Accengage template Id.
String getAccengageTitle()
Gets Accengage push title.
String getAccengageUrl()
Gets Accengage push action url.
List<AccengagePushButton> getButtons()
Gets the Accengage notification buttons.
String getExtra(String key, String defaultValue)
Gets an extra from the push bundle.
String getExtra(String key)
Gets an extra from the push bundle.
boolean isAccengageMultipleLines()
Tells if Accengage push has multiple lines.
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String ACCENGAGE_BIG_PICTURE_STYLE

Big picture notification style.

Constant Value: "BigPictureStyle"

public static final String ACCENGAGE_BIG_TEXT_BIG_PICTURE_COLLAPSED_TEMPLATE

Big text big picture collapsed style.

Constant Value: "com_ad4screen_sdk_template_notification_bigpicture_collapsed"

public static final String ACCENGAGE_BIG_TEXT_BIG_PICTURE_EXPANDED_TEMPLATE

Big text big picture expanded template.

Constant Value: "com_ad4screen_sdk_template_notification_bigpicture"

public static final String ACCENGAGE_BIG_TEXT_STYLE

Big text notification style.

Constant Value: "BigTextStyle"

public static final String ACCENGAGE_INBOX_STYLE

Inbox notification style.

Constant Value: "InboxStyle"

public static final String ACTION_OPEN_URL

Browser action.

Constant Value: "browser"

public static final String ACTION_SHOW_WEBVIEW

Web view action.

Constant Value: "webView"

public static final String ACTION_TRACK_URL

Track URL action. Not supported in Airship.

Constant Value: "urlExec"

Public Methods

public static AccengageMessage fromAirshipPushMessage (PushMessage message)

Factory method.

Parameters
message The push message.
Returns
  • The Accengage message.
Throws
IllegalArgumentException if the push message is not an Accengage push.

public int getAccengageAccentColor ()

Gets Accengage push accent color

Returns
  • Accengage push accent color or default value 0

public int getAccengageAccentColor (int defaultValue)

Gets Accengage push accent color

Parameters
defaultValue The default value.
Returns
  • Accengage push accent color or default value.

public String getAccengageAction ()

Gets Accengage push action.

Returns
  • Accengage push action if it is set, otherwise returns null.

public String getAccengageAppName ()

Gets the push app name from Accengage custom params.

Returns
  • The push app name from the custom params if it is set, otherwise returns null.

public String getAccengageBigContent ()

Gets Accengage push big content.

Returns
  • Accengage push big content if it is set, otherwise returns null.

public String getAccengageBigPictureUrl ()

Gets Accengage push big picture url.

Returns
  • Accengage push big picture url if it is set, otherwise returns null.

public String getAccengageBigTemplate ()

Gets Accengage push extended template.

Returns
  • Accengage push extended template if it is set, otherwise returns null.

public int getAccengageBigTemplateId (Context context)

Gets the Accengage big template Id.

Parameters
context The context.
Returns
  • The template Id, or 0 if not available.

public String getAccengageCategory ()

Gets Accengage push category

Returns
  • Accengage push category or default value NotificationCompat.CATEGORY_PROMO

public String getAccengageChannel ()

Gets Accengage push channel.

Returns
  • Accengage push channel if it is set, otherwise returns null.

public String getAccengageContent ()

Gets Accengage push content.

Returns
  • Accengage push content if it is set, otherwise null.

public String getAccengageContentInfo ()

Gets Accengage push content info.

Returns
  • Accengage push content info if it is set, otherwise returns null.

public boolean getAccengageForeground ()

Tells if Accengage push can be displayed in foreground.

Returns
  • true if the push can be displayed in foreground, otherwise false.

public String getAccengageGroup ()

Gets Accengage push group.

Returns
  • Accengage push group.

public boolean getAccengageGroupSummary ()

Gets Accengage push group summary.

Returns
  • Accengage push group summary.

public String getAccengageHeaderText ()

Gets the push header text from Accengage custom params

Returns
  • the push header text from the custom params if it is set, otherwise returns null.

public boolean getAccengageIsDecorated ()

Tells if Accengage push should be decorated.

Returns
  • true if the push should be decorated, otherwise false.

public String getAccengageLargeIcon ()

Gets Accengage push large icon.

Returns
  • Accengage push large icon if it is set, otherwise returns null.

public String getAccengageNotificationSound ()

Gets Accengage push notification sound.

Returns
  • Accengage push notification sound if it is set, otherwise returns null.

public boolean getAccengageOpenWithBrowser ()

Tells if Accengage push action should be opened with browser or with webview.

Returns
  • true if the push should be opened with browser, otherwise false.

public int getAccengagePriority ()

Gets Accengage push priority

Returns
  • Accengage push priority or default value 0

public int getAccengageSmallIcon (Context context)

This method is deprecated.
Use #getAccengageSmallIcon(Context, int) instead.

Gets Accengage push small icon

Parameters
context A context
Returns
  • Accengage push small icon or default application icon

public String getAccengageSubtext ()

Gets Accengage push subtext.

Returns
  • Accengage push subtext if it is set, otherwise returns null.

public String getAccengageSummaryText ()

Gets Accengage push summary text.

Returns
  • Accengage push summary text if it is set, otherwise returns null.

public int getAccengageSystemId ()

Gets Accengage push system ID.

Returns
  • Accengage push system ID or default value 1001.

public String getAccengageTemplate ()

Gets Accengage push collapsed template.

Returns
  • Accengage push collapsed template if it is set, otherwise returns null.

public int getAccengageTemplateId (Context context)

Gets the Accengage template Id.

Parameters
context The context.
Returns
  • The template Id, or 0 if not available.

public String getAccengageTitle ()

Gets Accengage push title.

Returns
  • Accengage push title.

public String getAccengageUrl ()

Gets Accengage push action url.

Returns
  • Accengage push action url.

public List<AccengagePushButton> getButtons ()

Gets the Accengage notification buttons.

Returns
  • The Accengage notification buttons.

public String getExtra (String key, String defaultValue)

Gets an extra from the push bundle.

Parameters
key The extra key.
defaultValue Default value if the value does not exist.
Returns
  • The extra or the default value if the extra does not exist.

public String getExtra (String key)

Gets an extra from the push bundle.

Parameters
key The extra key.
Returns
  • The extra if it is set, otherwise returns null.

public boolean isAccengageMultipleLines ()

Tells if Accengage push has multiple lines.

Returns
  • true if Accengage push has multiple lines, otherwise false.