Class: Aws::QConnect::Types::PushAPNSMessageTemplateContent

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 APNS (Apple Push Notification service) notification service.

See Also:

Constant Summary collapse

SENSITIVE = 
[:title, :sound, :url, :media_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 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) 


8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8377

class PushAPNSMessageTemplateContent < Struct.new(
  :title,
  :body,
  :action,
  :sound,
  :url,
  :media_url,
  :raw_content)
  SENSITIVE = [:title, :sound, :url, :media_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:



8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8377

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

#media_url ⇒ String

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

Returns:

  • (String) 


8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8377

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

#raw_content ⇒ Types::MessageTemplateBodyContentProvider

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:



8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8377

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

#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.

Returns:

  • (String) 


8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8377

class PushAPNSMessageTemplateContent < Struct.new(
  :title,
  :body,
  :action,
  :sound,
  :url,
  :media_url,
  :raw_content)
  SENSITIVE = [:title, :sound, :url, :media_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) 


8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8377

class PushAPNSMessageTemplateContent < Struct.new(
  :title,
  :body,
  :action,
  :sound,
  :url,
  :media_url,
  :raw_content)
  SENSITIVE = [:title, :sound, :url, :media_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) 


8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
 
# File 'gems/aws-sdk-qconnect/lib/aws-sdk-qconnect/types.rb', line 8377

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