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

Class: Aws::Pinpoint::Types::MessageConfiguration

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

Overview

Note:

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

{
  apns_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    title: "__string",
    url: "__string",
  },
  default_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    title: "__string",
    url: "__string",
  },
  email_message: {
    body: "__string",
    from_address: "__string",
    html_body: "__string",
    title: "__string",
  },
  gcm_message: {
    action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
    body: "__string",
    image_icon_url: "__string",
    image_small_icon_url: "__string",
    image_url: "__string",
    json_body: "__string",
    media_url: "__string",
    raw_content: "__string",
    silent_push: false,
    title: "__string",
    url: "__string",
  },
  sms_message: {
    body: "__string",
    message_type: "TRANSACTIONAL", # accepts TRANSACTIONAL, PROMOTIONAL
    sender_id: "__string",
  },
}

Message configuration for a campaign.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#apns_messageTypes::Message

The message that the campaign delivers to APNS channels. Overrides the default message.

Returns:

  • (Types::Message)

    The message that the campaign delivers to APNS channels.

#default_messageTypes::Message

The default message for all channels.

Returns:

#email_messageTypes::CampaignEmailMessage

The email message configuration.

Returns:

#gcm_messageTypes::Message

The message that the campaign delivers to GCM channels. Overrides the default message.

Returns:

  • (Types::Message)

    The message that the campaign delivers to GCM channels.

#sms_messageTypes::CampaignSmsMessage

The SMS message configuration.

Returns: