Package software.amazon.awscdk.services.pinpoint

Class CfnCampaign.MessageProperty.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.pinpoint.CfnCampaign.MessageProperty.Jsii$Proxy
All Implemented Interfaces:
CfnCampaign.MessageProperty, software.amazon.jsii.JsiiSerializable
Enclosing interface:
CfnCampaign.MessageProperty
@Stability(Stable) @Internal public static final class CfnCampaign.MessageProperty.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements CfnCampaign.MessageProperty
An implementation for CfnCampaign.MessageProperty

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.pinpoint.CfnCampaign.MessageProperty

    CfnCampaign.MessageProperty.Builder, CfnCampaign.MessageProperty.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(CfnCampaign.MessageProperty.Builder builder)
    Constructor that initializes the object based on literal property values passed by the CfnCampaign.MessageProperty.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getAction()
    The action to occur if a recipient taps the push notification.
    final String
    getBody()
    The body of the notification message.
    final String
    getImageIconUrl()
    The URL of the image to display as the push notification icon, such as the icon for the app.
    final String
    getImageSmallIconUrl()
    The URL of the image to display as the small, push notification icon, such as a small version of the icon for the app.
    final String
    getImageUrl()
    The URL of an image to display in the push notification.
    final String
    getJsonBody()
    The JSON payload to use for a silent push notification.
    final String
    getMediaUrl()
    The URL of the image or video to display in the push notification.
    final String
    getRawContent()
    The raw, JSON-formatted string to use as the payload for the notification message.
    final Object
    getSilentPush()
    Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.
    final Number
    getTimeToLive()
    The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time.
    final String
    getTitle()
    The title to display above the notification message on a recipient's device.
    final String
    getUrl()
    The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL .
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(CfnCampaign.MessageProperty.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnCampaign.MessageProperty.Builder.

  • Method Details

    • getAction

      public final String getAction()
      Description copied from interface: CfnCampaign.MessageProperty
      The action to occur if a recipient taps the push notification. Valid values are:.

      • OPEN_APP – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
      • DEEP_LINK – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
      • URL – The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
      Specified by:
      getAction in interface CfnCampaign.MessageProperty

    • getBody

      public final String getBody()
      Description copied from interface: CfnCampaign.MessageProperty
      The body of the notification message.

      The maximum number of characters is 200.

      Specified by:
      getBody in interface CfnCampaign.MessageProperty

    • getImageIconUrl

      public final String getImageIconUrl()
      Description copied from interface: CfnCampaign.MessageProperty
      The URL of the image to display as the push notification icon, such as the icon for the app.
      Specified by:
      getImageIconUrl in interface CfnCampaign.MessageProperty

    • getImageSmallIconUrl

      public final String getImageSmallIconUrl()
      Description copied from interface: CfnCampaign.MessageProperty
      The URL of the image to display as the small, push notification icon, such as a small version of the icon for the app.
      Specified by:
      getImageSmallIconUrl in interface CfnCampaign.MessageProperty

    • getImageUrl

      public final String getImageUrl()
      Description copied from interface: CfnCampaign.MessageProperty
      The URL of an image to display in the push notification.
      Specified by:
      getImageUrl in interface CfnCampaign.MessageProperty

    • getJsonBody

      public final String getJsonBody()
      Description copied from interface: CfnCampaign.MessageProperty
      The JSON payload to use for a silent push notification.
      Specified by:
      getJsonBody in interface CfnCampaign.MessageProperty

    • getMediaUrl

      public final String getMediaUrl()
      Description copied from interface: CfnCampaign.MessageProperty
      The URL of the image or video to display in the push notification.
      Specified by:
      getMediaUrl in interface CfnCampaign.MessageProperty

    • getRawContent

      public final String getRawContent()
      Description copied from interface: CfnCampaign.MessageProperty
      The raw, JSON-formatted string to use as the payload for the notification message.

      If specified, this value overrides all other content for the message.

      Specified by:
      getRawContent in interface CfnCampaign.MessageProperty

    • getSilentPush

      public final Object getSilentPush()
      Description copied from interface: CfnCampaign.MessageProperty
      Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.

      Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.

      Specified by:
      getSilentPush in interface CfnCampaign.MessageProperty

    • getTimeToLive

      public final Number getTimeToLive()
      Description copied from interface: CfnCampaign.MessageProperty
      The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time.

      This value is converted to an expiration value when it's sent to a push notification service. If this value is 0 , the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

      This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.

      Specified by:
      getTimeToLive in interface CfnCampaign.MessageProperty

    • getTitle

      public final String getTitle()
      Description copied from interface: CfnCampaign.MessageProperty
      The title to display above the notification message on a recipient's device.
      Specified by:
      getTitle in interface CfnCampaign.MessageProperty

    • getUrl

      public final String getUrl()
      Description copied from interface: CfnCampaign.MessageProperty
      The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL .
      Specified by:
      getUrl in interface CfnCampaign.MessageProperty

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object