You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Pinpoint::Types::PushNotificationTemplateRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing PushNotificationTemplateRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  adm: {
    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",
  },
  apns: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    media_url: "__string",
    raw_content: "__string",
    sound: "__string",
    title: "__string",
    url: "__string",
  },
  baidu: {
    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",
  },
  default: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    sound: "__string",
    title: "__string",
    url: "__string",
  },
  default_substitutions: "__string",
  gcm: {
    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",
  },
  recommender_id: "__string",
  tags: {
    "__string" => "__string",
  },
  template_description: "__string",
}

Specifies the content and settings for a message template that can be used in messages that are sent through a push notification channel.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#adm ⇒ Types::AndroidPushNotificationTemplate

The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

#apns ⇒ Types::APNSPushNotificationTemplate

The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

#baidu ⇒ Types::AndroidPushNotificationTemplate

The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

#default ⇒ Types::DefaultPushNotificationTemplate

The default message template to use for push notification channels.

Returns:

#default_substitutions ⇒ String

A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that\'s based on the template, you can override these defaults with message-specific and address-specific variables and values.

Returns:

  • (String) —

    A JSON object that specifies the default values to use for message variables in the message template.

#gcm ⇒ Types::AndroidPushNotificationTemplate

The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).

Returns:

  • (Types::AndroidPushNotificationTemplate) —

    The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.

#recommender_id ⇒ String

The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.

Returns:

  • (String) —

    The unique identifier for the recommender model to use for the message template.

#tags ⇒ Hash<String,String>

A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.

Returns:

  • (Hash<String,String>) —

    A string-to-string map of key-value pairs that defines the tags to associate with the message template.

#template_description ⇒ String

A custom description of the message template.

Returns:

  • (String) —

    A custom description of the message template.