Class: Aws::Pinpoint::Types::APNSMessage

Inherits:

Struct

• Object
• Struct
• Aws::Pinpoint::Types::APNSMessage

Includes:

Structure

Defined in:

lib/aws-sdk-pinpoint/types.rb

Overview

Note:

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

{
  action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
  badge: 1,
  body: "__string",
  category: "__string",
  data: {
    "__string" => "__string",
  },
  media_url: "__string",
  raw_content: "__string",
  silent_push: false,
  sound: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
  thread_id: "__string",
  title: "__string",
  url: "__string",
}

APNS Message.

Instance Attribute Summary

• #action ⇒ 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.

• #badge ⇒ Integer

  Include this key when you want the system to modify the badge of your app icon.

• #body ⇒ String

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

• #category ⇒ String

  Provide this key with a string value that represents the notification’s type.

• #data ⇒ Hash<String,String>
• #media_url ⇒ String

  The URL that points to a video used in the push notification.

• #raw_content ⇒ String

  The Raw JSON formatted string to be used as the payload.

• #silent_push ⇒ Boolean

  Indicates if the message should display on the users device.

• #sound ⇒ String

  Include this key when you want the system to play a sound.

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

  Provide this key with a string value that represents the app-specific identifier for grouping notifications.

• #title ⇒ String

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

• #url ⇒ String

  The URL to open in the user’s mobile browser.

Instance Attribute Details

#action ⇒ 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. 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)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#badge ⇒ Integer

Include this key when you want the system to modify the badge of your app icon. If this key is not included in the dictionary, the badge is not changed. To remove the badge, set the value of this key to 0.

Returns:

• (Integer)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#body ⇒ String

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

Returns:

• (String)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#category ⇒ String

Provide this key with a string value that represents the notification’s type. This value corresponds to the value in the identifier property of one of your app’s registered categories.

Returns:

• (String)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#data ⇒ Hash<String,String>

Returns:

• (Hash<String,String>)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#media_url ⇒ String

The URL that points to a video used in the push notification.

Returns:

• (String)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#raw_content ⇒ String

The Raw JSON formatted string to be used as the payload. This value overrides the message.

Returns:

• (String)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#silent_push ⇒ Boolean

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)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#sound ⇒ String

Include this key when you want the system to play a sound. The value of this key is the name of a sound file in your app’s main bundle or in the Library/Sounds folder of your app’s data container. If the sound file cannot be found, or if you specify defaultfor the value, the system plays the default alert sound.

Returns:

• (String)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

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

Returns:

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

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#thread_id ⇒ String

Provide this key with a string value that represents the app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.

Returns:

• (String)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#title ⇒ String

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

Returns:

• (String)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end

#url ⇒ String

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

Returns:

• (String)

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

class APNSMessage < Struct.new(
  :action,
  :badge,
  :body,
  :category,
  :data,
  :media_url,
  :raw_content,
  :silent_push,
  :sound,
  :substitutions,
  :thread_id,
  :title,
  :url)
  include Aws::Structure
end