Class: Aws::Pinpoint::Types::APNSPushNotificationTemplate

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

{
  action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
  body: "__string",
  media_url: "__string",
  raw_content: "__string",
  sound: "__string",
  title: "__string",
  url: "__string",
}

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action to occur if a recipient taps a push notification that's based on the message template. 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)


752
753
754
755
756
757
758
759
760
761
762
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 752

class APNSPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :media_url,
  :raw_content,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#bodyString

The message body to use in push notifications that are based on the message template.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 752

class APNSPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :media_url,
  :raw_content,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#media_urlString

The URL of an image or video to display in push notifications that are based on the message template.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 752

class APNSPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :media_url,
  :raw_content,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#raw_contentString

The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 752

class APNSPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :media_url,
  :raw_content,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#soundString

The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for 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)


752
753
754
755
756
757
758
759
760
761
762
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 752

class APNSPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :media_url,
  :raw_content,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#titleString

The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 752

class APNSPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :media_url,
  :raw_content,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#urlString

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

Returns:

  • (String)


752
753
754
755
756
757
758
759
760
761
762
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 752

class APNSPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :media_url,
  :raw_content,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end