Class: Aws::Pinpoint::Types::AndroidPushNotificationTemplate

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

{
  action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
  body: "__string",
  image_icon_url: "__string",
  image_url: "__string",
  raw_content: "__string",
  small_image_icon_url: "__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 ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) 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 action uses the deep-linking features of the Android 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)


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1825

class AndroidPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_url,
  :raw_content,
  :small_image_icon_url,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#bodyString

The message body to use in a push notification that's based on the message template.

Returns:

  • (String)


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1825

class AndroidPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_url,
  :raw_content,
  :small_image_icon_url,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#image_icon_urlString

The URL of the large icon image to display in the content view of a push notification that's based on the message template.

Returns:

  • (String)


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1825

class AndroidPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_url,
  :raw_content,
  :small_image_icon_url,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#image_urlString

The URL of an image to display in a push notification that's based on the message template.

Returns:

  • (String)


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1825

class AndroidPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_url,
  :raw_content,
  :small_image_icon_url,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#raw_contentString

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

Returns:

  • (String)


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1825

class AndroidPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_url,
  :raw_content,
  :small_image_icon_url,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#small_image_icon_urlString

The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.

Returns:

  • (String)


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1825

class AndroidPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_url,
  :raw_content,
  :small_image_icon_url,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#soundString

The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

Returns:

  • (String)


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1825

class AndroidPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_url,
  :raw_content,
  :small_image_icon_url,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#titleString

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

Returns:

  • (String)


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1825

class AndroidPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_url,
  :raw_content,
  :small_image_icon_url,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end

#urlString

The URL to open in a 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)


1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1825

class AndroidPushNotificationTemplate < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_url,
  :raw_content,
  :small_image_icon_url,
  :sound,
  :title,
  :url)
  SENSITIVE = []
  include Aws::Structure
end