Class: Aws::QConnect::Types::PushADMMessageTemplateContent

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb

Overview

The content of the push message template that applies to ADM (Amazon Device Messaging) notification service.

See Also:

Constant Summary collapse

SENSITIVE = 
[:title, :sound, :url, :image_url, :image_icon_url, :small_image_icon_url]

Instance Attribute Summary collapse

Instance Attribute Details

#action ⇒ String

The action to occur if a recipient taps a push notification that is 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) 


8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8306

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

#body ⇒ Types::MessageTemplateBodyContentProvider

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

Returns:



8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8306

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

#image_icon_url ⇒ String

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) 


8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8306

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

#image_url ⇒ String

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

Returns:

  • (String) 


8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8306

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

#raw_content ⇒ Types::MessageTemplateBodyContentProvider

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:



8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8306

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

#small_image_icon_url ⇒ String

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) 


8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8306

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

#sound ⇒ String

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) 


8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8306

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

#title ⇒ String

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) 


8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8306

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

#url ⇒ String

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) 


8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8306

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