Package 

Interface PushMessage

  • All Implemented Interfaces:
    android.os.Parcelable 
    
public interface PushMessage
 implements Parcelable

    • Method Summary

      Modifier and Type Method Description
      abstract Boolean has(String key) Checks whether the message data contains the specified key.
      abstract String data(String key) Retrieves the data associated with the specified key.
      abstract Unit recordAction(Context context) Records an action event occurrence for the message.
      abstract Unit recordAction(Context context, Integer buttonIndex) Records an action event occurrence for a specific button index.
      abstract String getId() Internal message ID.
      abstract String getTitle() Title of the message.
      abstract String getTitleColor() Title color of the message.
      abstract String getMessage() Content of the message.
      abstract String getMessageColor() Content of the message color.
      abstract String getSound() Message sound.
      abstract Integer getBadge() Badge count for the message.
      abstract Uri getLink() Default link to open for the message.
      abstract URL getMedia() Media URL associated with the message (e.g., JPEG or PNG image).
      abstract List<PushMessageButton> getButtons() List of buttons associated with the message.
      abstract Set<String> getDataKeys() Set of all data keys in the message, including standard keys like "title" or "message".
      abstract Map<String, Object> getCustomData() Map of custom data key-value pairs sent with the message.
      abstract MessageType getType() Type of the message.
      abstract TimerTemplate getTimerTemplate() Timer template associated with the message, if any.
      abstract Boolean getSticky() Whether the message is sticky.
      abstract Long getAutoDismissDuration() Duration after which the message will automatically dismiss.
      abstract String getDismissLabel() Label for the dismiss button in Android notifications.

      • Methods inherited from class sdk.main.core.pushmessaging.PushMessage

        describeContents, writeToParcel

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • has

         abstract Boolean has(String key)

        Checks whether the message data contains the specified key.

        Parameters:
        key - Key to check for.

      • data

         abstract String data(String key)

        Retrieves the data associated with the specified key.

        Parameters:
        key - Key to retrieve the value for.

      • recordAction

         abstract Unit recordAction(Context context)

        Records an action event occurrence for the message.

        Parameters:
        context - Context to record the action in.

      • recordAction

         abstract Unit recordAction(Context context, Integer buttonIndex)

        Records an action event occurrence for a specific button index.

        Parameters:
        context - Context to record the action in.
        buttonIndex - Index of the button to record the action for.

      • getId

         abstract String getId()

        Internal message ID.

      • getTitle

         abstract String getTitle()

        Title of the message.

      • getTitleColor

         abstract String getTitleColor()

        Title color of the message.

      • getMessage

         abstract String getMessage()

        Content of the message.

      • getMessageColor

         abstract String getMessageColor()

        Content of the message color.

      • getSound

         abstract String getSound()

        Message sound. Default is "default". Other sounds are specified as URIs from app resources.

      • getBadge

         abstract Integer getBadge()

        Badge count for the message.

      • getLink

         abstract Uri getLink()

        Default link to open for the message.

      • getMedia

         abstract URL getMedia()

        Media URL associated with the message (e.g., JPEG or PNG image).

      • getDataKeys

         abstract Set<String> getDataKeys()

        Set of all data keys in the message, including standard keys like "title" or "message".

      • getCustomData

         abstract Map<String, Object> getCustomData()

        Map of custom data key-value pairs sent with the message.

      • getType

         abstract MessageType getType()

        Type of the message. Possible values: TEXT, CAROUSEL, RATING, BANNER, TIMER.

      • getSticky

         abstract Boolean getSticky()

        Whether the message is sticky.

      • getAutoDismissDuration

         abstract Long getAutoDismissDuration()

        Duration after which the message will automatically dismiss.

      • getDismissLabel

         abstract String getDismissLabel()

        Label for the dismiss button in Android notifications.