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

Class: Aws::Pinpoint::Types::Message

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

{
  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,
  time_to_live: 1,
  title: "__string",
  url: "__string",
}

Message to send

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action that occurs if the user taps a push notification delivered by the campaign: OPEN_APP - Your app launches, or it becomes the foreground app if it has been sent to the background. This is the default action. DEEP_LINK - Uses deep linking features in iOS and Android to open your app and display a designated user interface within the app. URL - The default mobile browser on the user's device launches and opens a web page at the URL you specify.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#bodyString

The message body. Can include up to 140 characters.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#image_icon_urlString

The URL that points to the icon image for the push notification icon, for example, the app icon.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#image_small_icon_urlString

The URL that points to the small icon image for the push notification icon, for example, the app icon.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#image_urlString

The URL that points to an image used in the push notification.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#json_bodyString

The JSON payload used for a silent push.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#media_urlString

The URL that points to the media resource, for example a .mp4 or .gif file.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#raw_contentString

The Raw JSON formatted string to be used as the payload. This value overrides the message.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#silent_pushBoolean

Indicates if the message should display on the users device. Silent pushes can be used for Remote Configuration and Phone Home use cases.

Returns:

  • (Boolean)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#time_to_liveInteger

This parameter specifies how long (in seconds) the message should be kept if the service is unable to deliver the notification the first time. If the value is 0, it treats the notification as if it expires immediately and does not store the notification or attempt to redeliver it. This value is converted to the expiration field when sent to the service. It only applies to APNs and GCM

Returns:

  • (Integer)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#titleString

The message title that displays above the message on the user's device.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#urlString

The URL to open in the user's mobile browser. Used if the value for Action is URL.

Returns:

  • (String)


6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 6071

class Message < Struct.new(
  :action,
  :body,
  :image_icon_url,
  :image_small_icon_url,
  :image_url,
  :json_body,
  :media_url,
  :raw_content,
  :silent_push,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end