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

Class: Aws::Pinpoint::Types::DirectMessageConfiguration

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

{
  adm_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    consolidation_key: "__string",
    data: {
      "__string" => "__string",
    },
    expires_after: "__string",
    icon_reference: "__string",
    image_icon_url: "__string",
    image_url: "__string",
    json_data: "__string",
    md5: "__string",
    raw_content: "__string",
    silent_push: false,
    small_image_icon_url: "__string",
    sound: "__string",
    substitutions: {
      "__string" => ["__string"],
    },
    title: "__string",
    url: "__string",
  },
  apns_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    badge: 1,
    body: "__string",
    category: "__string",
    data: {
      "__string" => "__string",
    },
    json_data: "__string",
    media_url: "__string",
    preferred_authentication_method: "__string",
    raw_content: "__string",
    silent_push: false,
    sound: "__string",
    substitutions: {
      "__string" => ["__string"],
    },
    thread_id: "__string",
    title: "__string",
    url: "__string",
  },
  baidu_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    data: {
      "__string" => "__string",
    },
    icon_reference: "__string",
    image_icon_url: "__string",
    image_url: "__string",
    json_data: "__string",
    raw_content: "__string",
    silent_push: false,
    small_image_icon_url: "__string",
    sound: "__string",
    substitutions: {
      "__string" => ["__string"],
    },
    title: "__string",
    url: "__string",
  },
  default_message: {
    body: "__string",
    substitutions: {
      "__string" => ["__string"],
    },
  },
  default_push_notification_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    data: {
      "__string" => "__string",
    },
    json_data: "__string",
    silent_push: false,
    substitutions: {
      "__string" => ["__string"],
    },
    title: "__string",
    url: "__string",
  },
  email_message: {
    body: "__string",
    from_address: "__string",
    html_body: "__string",
    substitutions: {
      "__string" => ["__string"],
    },
    template_arn: "__string",
    title: "__string",
  },
  gcm_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    collapse_key: "__string",
    data: {
      "__string" => "__string",
    },
    icon_reference: "__string",
    image_icon_url: "__string",
    image_url: "__string",
    json_data: "__string",
    raw_content: "__string",
    restricted_package_name: "__string",
    silent_push: false,
    small_image_icon_url: "__string",
    sound: "__string",
    substitutions: {
      "__string" => ["__string"],
    },
    title: "__string",
    url: "__string",
  },
  sms_message: {
    body: "__string",
    message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
    sender_id: "__string",
    substitutions: {
      "__string" => ["__string"],
    },
  },
}

The message configuration.

Instance Attribute Summary collapse

Instance Attribute Details

#adm_messageTypes::ADMMessage

The message to ADM channels. Overrides the default push notification message.

Returns:



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2262

class DirectMessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :default_push_notification_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#apns_messageTypes::APNSMessage

The message to APNS channels. Overrides the default push notification message.

Returns:



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2262

class DirectMessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :default_push_notification_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#baidu_messageTypes::BaiduMessage

The message to Baidu GCM channels. Overrides the default push notification message.

Returns:



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2262

class DirectMessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :default_push_notification_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#default_messageTypes::DefaultMessage

The default message for all channels.



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2262

class DirectMessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :default_push_notification_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#default_push_notification_messageTypes::DefaultPushNotificationMessage

The default push notification message for all push channels.



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2262

class DirectMessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :default_push_notification_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#email_messageTypes::EmailMessage

The message to Email channels. Overrides the default message.

Returns:



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2262

class DirectMessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :default_push_notification_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#gcm_messageTypes::GCMMessage

The message to GCM channels. Overrides the default push notification message.

Returns:



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2262

class DirectMessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :default_push_notification_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end

#sms_messageTypes::SMSMessage

The message to SMS channels. Overrides the default message.

Returns:



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 2262

class DirectMessageConfiguration < Struct.new(
  :adm_message,
  :apns_message,
  :baidu_message,
  :default_message,
  :default_push_notification_message,
  :email_message,
  :gcm_message,
  :sms_message)
  include Aws::Structure
end