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

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::DefaultPushNotificationMessage

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

When making an API call, you may pass DefaultPushNotificationMessage data as a hash:

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

Specifies the default settings and content for a push notification that’s sent directly to an endpoint.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #action ⇒ String

  The default action to occur if a recipient taps the push notification.

• #body ⇒ String

  The default body of the notification message.

• #data ⇒ Hash<String,String>

  The JSON data payload to use for the default push notification, if the notification is a silent push notification.

• #silent_push ⇒ Boolean

  Specifies whether the default notification is a silent push notification, which is a push notification that doesn’t display on a recipient’s device.

• #substitutions ⇒ Hash<String,Array<String>>

  The default message variables to use in the notification message.

• #title ⇒ String

  The default title to display above the notification message on a recipient’s device.

• #url ⇒ String

  The default 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.

Instance Attribute Details

#action ⇒ String

The default 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 the iOS and Android platforms.

• URL - The default mobile browser on the recipient’s device opens and loads the web page at a URL that you specify.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4582

class DefaultPushNotificationMessage < Struct.new(
  :action,
  :body,
  :data,
  :silent_push,
  :substitutions,
  :title,
  :url)
  include Aws::Structure
end

#body ⇒ String

The default body of the notification message.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4582

class DefaultPushNotificationMessage < Struct.new(
  :action,
  :body,
  :data,
  :silent_push,
  :substitutions,
  :title,
  :url)
  include Aws::Structure
end

#data ⇒ Hash<String,String>

The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4582

class DefaultPushNotificationMessage < Struct.new(
  :action,
  :body,
  :data,
  :silent_push,
  :substitutions,
  :title,
  :url)
  include Aws::Structure
end

#silent_push ⇒ Boolean

Specifies whether the default 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 or delivering messages to an in-app notification center.

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4582

class DefaultPushNotificationMessage < Struct.new(
  :action,
  :body,
  :data,
  :silent_push,
  :substitutions,
  :title,
  :url)
  include Aws::Structure
end

#substitutions ⇒ Hash<String,Array<String>>

The default message variables to use in the notification message. You can override the default variables with individual address variables.

Returns:

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

# File 'lib/aws-sdk-pinpoint/types.rb', line 4582

class DefaultPushNotificationMessage < Struct.new(
  :action,
  :body,
  :data,
  :silent_push,
  :substitutions,
  :title,
  :url)
  include Aws::Structure
end

#title ⇒ String

The default title to display above the notification message on a recipient’s device.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4582

class DefaultPushNotificationMessage < Struct.new(
  :action,
  :body,
  :data,
  :silent_push,
  :substitutions,
  :title,
  :url)
  include Aws::Structure
end

#url ⇒ String

The default 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.

Returns:

• (String)

# File 'lib/aws-sdk-pinpoint/types.rb', line 4582

class DefaultPushNotificationMessage < Struct.new(
  :action,
  :body,
  :data,
  :silent_push,
  :substitutions,
  :title,
  :url)
  include Aws::Structure
end