You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Pinpoint::Types::APNSPushNotificationTemplate
- Inherits:
-
Struct
- Object
- Struct
- Aws::Pinpoint::Types::APNSPushNotificationTemplate
- Defined in:
- (unknown)
Overview
When passing APNSPushNotificationTemplate as input to an Aws::Client method, you can use a vanilla 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.
Returned by:
Instance Attribute Summary collapse
-
#action ⇒ String
The action to occur if a recipient taps a push notification that\'s based on the message template.
-
#body ⇒ String
The message body to use in push notifications that are based on the message template.
-
#media_url ⇒ String
The URL of an image or video to display in push notifications that are based on the message template.
-
#raw_content ⇒ String
The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template.
-
#sound ⇒ String
The key for the sound to play when the recipient receives a push notification that\'s based on the message template.
-
#title ⇒ String
The title to use in push notifications that are based on the message template.
-
#url ⇒ String
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.
Instance Attribute Details
#action ⇒ String
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.
Possible values:
- OPEN_APP
- DEEP_LINK
- URL
#body ⇒ String
The message body to use in push notifications that are based on the message template.
#media_url ⇒ String
The URL of an image or video to display in push notifications that are based on the message template.
#raw_content ⇒ String
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.
#sound ⇒ String
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.
#title ⇒ String
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.
#url ⇒ String
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.