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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pinpoint/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",
  },
  json_data: "__string",
  silent_push: false,
  substitutions: {
    "__string" => ["__string"],
  },
  title: "__string",
  url: "__string",
}

Default Push Notification Message.

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

Returns:

  • (String)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1762

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

#bodyString

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

Returns:

  • (String)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1762

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

#dataHash<String,String>

Returns:

  • (Hash<String,String>)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1762

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

#json_dataString

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

Returns:

  • (String)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1762

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

#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)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1762

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

#substitutionsHash<String,Array<String>>

Returns:

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


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1762

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

#titleString

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

Returns:

  • (String)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1762

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

#urlString

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

Returns:

  • (String)


1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1762

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