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

Class: Aws::Pinpoint::Types::BaiduMessage

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

{
  action: "OPEN_APP", # accepts OPEN_APP, DEEP_LINK, URL
  body: "__string",
  data: {
    "__string" => "__string",
  },
  icon_reference: "__string",
  image_icon_url: "__string",
  image_url: "__string",
  raw_content: "__string",
  silent_push: false,
  small_image_icon_url: "__string",
  sound: "__string",
  substitutions: {
    "__string" => ["__string"],
  },
  time_to_live: 1,
  title: "__string",
  url: "__string",
}

Specifies the settings for a one-time message that's sent directly to an endpoint through the Baidu (Baidu Cloud Push) channel.

Instance Attribute Summary collapse

Instance Attribute Details

#actionString

The action to occur if the recipient taps the push notification. 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 Android 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)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#bodyString

The body of the notification message.

Returns:

  • (String)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#dataHash<String,String>

The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.

Returns:

  • (Hash<String,String>)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#icon_referenceString

The icon image name of the asset saved in your app.

Returns:

  • (String)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#image_icon_urlString

The URL of the large icon image to display in the content view of the push notification.

Returns:

  • (String)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#image_urlString

The URL of an image to display in the push notification.

Returns:

  • (String)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#raw_contentString

The raw, JSON-formatted string to use as the payload for the notification message. This value overrides the message.

Returns:

  • (String)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#silent_pushBoolean

Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.

Returns:

  • (Boolean)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#small_image_icon_urlString

The URL of the small icon image to display in the status bar and the content view of the push notification.

Returns:

  • (String)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#soundString

The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.

Returns:

  • (String)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#substitutionsHash<String,Array<String>>

The default message variables to use in the notification message. You can override the default variables with individual address variables.

Returns:

  • (Hash<String,Array<String>>)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#time_to_liveInteger

The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).

Returns:

  • (Integer)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#titleString

The title to display above the notification message on the recipient's device.

Returns:

  • (String)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end

#urlString

The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.

Returns:

  • (String)


1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
# File 'gems/aws-sdk-pinpoint/lib/aws-sdk-pinpoint/types.rb', line 1677

class BaiduMessage < Struct.new(
  :action,
  :body,
  :data,
  :icon_reference,
  :image_icon_url,
  :image_url,
  :raw_content,
  :silent_push,
  :small_image_icon_url,
  :sound,
  :substitutions,
  :time_to_live,
  :title,
  :url)
  include Aws::Structure
end