You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::DefaultPushNotificationMessage

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DefaultPushNotificationMessage as input to an Aws::Client method, you can use a vanilla Hash:

{
  action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
  body: "__string",
  data: {
    "__string" => "__string",
  },
  json_data: "__string",
  silent_push: false,
  substitutions: {
    "__string" => ["__string"],
  },
  title: "__string",
  url: "__string",
}

Default Push Notification Message.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user\'s device launches and opens a web page at the URL you specify. Possible values include: OPEN_APP | DEEP_LINK | URL

Possible values:

  • OPEN_APP
  • DEEP_LINK
  • URL

Returns:

  • (String)

    The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background.

#bodyString

The message body of the notification, the email body or the text message.

Returns:

  • (String)

    The message body of the notification, the email body or the text message.

#dataHash<String,String>

Returns:

  • (Hash<String,String>)

#json_dataString

The data payload used for a silent push. This payload is added to the notifications\' data.pinpoint.jsonBody\' object

Returns:

  • (String)

    The data payload used for a silent push.

#silent_pushBoolean

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

Returns:

  • (Boolean)

    Indicates if the message should display on the users device.

#substitutionsHash<String,Array<String>>

Returns:

  • (Hash<String,Array<String>>)

#titleString

The message title that displays above the message on the user\'s device.

Returns:

  • (String)

    The message title that displays above the message on the user\'s device.

#urlString

The URL to open in the user\'s mobile browser. Used if the value for Action is URL.

Returns:

  • (String)

    The URL to open in the user\'s mobile browser.