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

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

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 APNSMessage data as a hash:

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

Specifies the settings for a one-time message that's sent directly to an endpoint through the APNs (Apple Push Notification service) channel.

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action to occur if the 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 platform.

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

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#badgeInteger

The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.

Returns:

  • (Integer)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#bodyString

The body of the notification message.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#categoryString

The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#collapse_idString

An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes.

Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#dataHash<String,String>

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

Returns:

  • (Hash<String,String>)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#media_urlString

The URL of an image or video to display in the push notification.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#preferred_authentication_methodString

The authentication method that you want Amazon Pinpoint to use when authenticating with Apple Push Notification service (APNs), CERTIFICATE or TOKEN.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#priorityString

para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled.

/listitem> 3. 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device.

/para> Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs.

The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#raw_contentString

The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#silent_pushBoolean

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.

Returns:

  • (Boolean)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#soundString

The key for the sound to play when the recipient receives the push notification. The value of this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#substitutionsHash<String,Array<String>>

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

Returns:

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


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#thread_idString

The key that represents your 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)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#time_to_liveInteger

The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.

Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.

Returns:

  • (Integer)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#titleString

The title to display above the notification message on the recipient's device.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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

#urlString

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Returns:

  • (String)


568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 568

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