/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Specifies channel-specific content and settings for a message template that
* can be used in push notifications that are sent through the ADM (Amazon Device
* Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly
* Google Cloud Messaging) channel.See Also:
AWS
* API Reference
The action to occur if a recipient taps a push notification that's based on * the message template. 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.
The action to occur if a recipient taps a push notification that's based on * the message template. 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.
The action to occur if a recipient taps a push notification that's based on * the message template. 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.
The action to occur if a recipient taps a push notification that's based on * the message template. 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.
The action to occur if a recipient taps a push notification that's based on * the message template. 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.
The action to occur if a recipient taps a push notification that's based on * the message template. 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.
The message body to use in a push notification that's based on the message * template.
*/ inline const Aws::String& GetBody() const{ return m_body; } /** *The message body to use in a push notification that's based on the message * template.
*/ inline bool BodyHasBeenSet() const { return m_bodyHasBeenSet; } /** *The message body to use in a push notification that's based on the message * template.
*/ inline void SetBody(const Aws::String& value) { m_bodyHasBeenSet = true; m_body = value; } /** *The message body to use in a push notification that's based on the message * template.
*/ inline void SetBody(Aws::String&& value) { m_bodyHasBeenSet = true; m_body = std::move(value); } /** *The message body to use in a push notification that's based on the message * template.
*/ inline void SetBody(const char* value) { m_bodyHasBeenSet = true; m_body.assign(value); } /** *The message body to use in a push notification that's based on the message * template.
*/ inline AndroidPushNotificationTemplate& WithBody(const Aws::String& value) { SetBody(value); return *this;} /** *The message body to use in a push notification that's based on the message * template.
*/ inline AndroidPushNotificationTemplate& WithBody(Aws::String&& value) { SetBody(std::move(value)); return *this;} /** *The message body to use in a push notification that's based on the message * template.
*/ inline AndroidPushNotificationTemplate& WithBody(const char* value) { SetBody(value); return *this;} /** *The URL of the large icon image to display in the content view of a push * notification that's based on the message template.
*/ inline const Aws::String& GetImageIconUrl() const{ return m_imageIconUrl; } /** *The URL of the large icon image to display in the content view of a push * notification that's based on the message template.
*/ inline bool ImageIconUrlHasBeenSet() const { return m_imageIconUrlHasBeenSet; } /** *The URL of the large icon image to display in the content view of a push * notification that's based on the message template.
*/ inline void SetImageIconUrl(const Aws::String& value) { m_imageIconUrlHasBeenSet = true; m_imageIconUrl = value; } /** *The URL of the large icon image to display in the content view of a push * notification that's based on the message template.
*/ inline void SetImageIconUrl(Aws::String&& value) { m_imageIconUrlHasBeenSet = true; m_imageIconUrl = std::move(value); } /** *The URL of the large icon image to display in the content view of a push * notification that's based on the message template.
*/ inline void SetImageIconUrl(const char* value) { m_imageIconUrlHasBeenSet = true; m_imageIconUrl.assign(value); } /** *The URL of the large icon image to display in the content view of a push * notification that's based on the message template.
*/ inline AndroidPushNotificationTemplate& WithImageIconUrl(const Aws::String& value) { SetImageIconUrl(value); return *this;} /** *The URL of the large icon image to display in the content view of a push * notification that's based on the message template.
*/ inline AndroidPushNotificationTemplate& WithImageIconUrl(Aws::String&& value) { SetImageIconUrl(std::move(value)); return *this;} /** *The URL of the large icon image to display in the content view of a push * notification that's based on the message template.
*/ inline AndroidPushNotificationTemplate& WithImageIconUrl(const char* value) { SetImageIconUrl(value); return *this;} /** *The URL of an image to display in a push notification that's based on the * message template.
*/ inline const Aws::String& GetImageUrl() const{ return m_imageUrl; } /** *The URL of an image to display in a push notification that's based on the * message template.
*/ inline bool ImageUrlHasBeenSet() const { return m_imageUrlHasBeenSet; } /** *The URL of an image to display in a push notification that's based on the * message template.
*/ inline void SetImageUrl(const Aws::String& value) { m_imageUrlHasBeenSet = true; m_imageUrl = value; } /** *The URL of an image to display in a push notification that's based on the * message template.
*/ inline void SetImageUrl(Aws::String&& value) { m_imageUrlHasBeenSet = true; m_imageUrl = std::move(value); } /** *The URL of an image to display in a push notification that's based on the * message template.
*/ inline void SetImageUrl(const char* value) { m_imageUrlHasBeenSet = true; m_imageUrl.assign(value); } /** *The URL of an image to display in a push notification that's based on the * message template.
*/ inline AndroidPushNotificationTemplate& WithImageUrl(const Aws::String& value) { SetImageUrl(value); return *this;} /** *The URL of an image to display in a push notification that's based on the * message template.
*/ inline AndroidPushNotificationTemplate& WithImageUrl(Aws::String&& value) { SetImageUrl(std::move(value)); return *this;} /** *The URL of an image to display in a push notification that's based on the * message template.
*/ inline AndroidPushNotificationTemplate& WithImageUrl(const char* value) { SetImageUrl(value); return *this;} /** *The raw, JSON-formatted string to use as the payload for a push notification * that's based on the message template. If specified, this value overrides all * other content for the message template.
*/ inline const Aws::String& GetRawContent() const{ return m_rawContent; } /** *The raw, JSON-formatted string to use as the payload for a push notification * that's based on the message template. If specified, this value overrides all * other content for the message template.
*/ inline bool RawContentHasBeenSet() const { return m_rawContentHasBeenSet; } /** *The raw, JSON-formatted string to use as the payload for a push notification * that's based on the message template. If specified, this value overrides all * other content for the message template.
*/ inline void SetRawContent(const Aws::String& value) { m_rawContentHasBeenSet = true; m_rawContent = value; } /** *The raw, JSON-formatted string to use as the payload for a push notification * that's based on the message template. If specified, this value overrides all * other content for the message template.
*/ inline void SetRawContent(Aws::String&& value) { m_rawContentHasBeenSet = true; m_rawContent = std::move(value); } /** *The raw, JSON-formatted string to use as the payload for a push notification * that's based on the message template. If specified, this value overrides all * other content for the message template.
*/ inline void SetRawContent(const char* value) { m_rawContentHasBeenSet = true; m_rawContent.assign(value); } /** *The raw, JSON-formatted string to use as the payload for a push notification * that's based on the message template. If specified, this value overrides all * other content for the message template.
*/ inline AndroidPushNotificationTemplate& WithRawContent(const Aws::String& value) { SetRawContent(value); return *this;} /** *The raw, JSON-formatted string to use as the payload for a push notification * that's based on the message template. If specified, this value overrides all * other content for the message template.
*/ inline AndroidPushNotificationTemplate& WithRawContent(Aws::String&& value) { SetRawContent(std::move(value)); return *this;} /** *The raw, JSON-formatted string to use as the payload for a push notification * that's based on the message template. If specified, this value overrides all * other content for the message template.
*/ inline AndroidPushNotificationTemplate& WithRawContent(const char* value) { SetRawContent(value); return *this;} /** *The URL of the small icon image to display in the status bar and the content * view of a push notification that's based on the message template.
*/ inline const Aws::String& GetSmallImageIconUrl() const{ return m_smallImageIconUrl; } /** *The URL of the small icon image to display in the status bar and the content * view of a push notification that's based on the message template.
*/ inline bool SmallImageIconUrlHasBeenSet() const { return m_smallImageIconUrlHasBeenSet; } /** *The URL of the small icon image to display in the status bar and the content * view of a push notification that's based on the message template.
*/ inline void SetSmallImageIconUrl(const Aws::String& value) { m_smallImageIconUrlHasBeenSet = true; m_smallImageIconUrl = value; } /** *The URL of the small icon image to display in the status bar and the content * view of a push notification that's based on the message template.
*/ inline void SetSmallImageIconUrl(Aws::String&& value) { m_smallImageIconUrlHasBeenSet = true; m_smallImageIconUrl = std::move(value); } /** *The URL of the small icon image to display in the status bar and the content * view of a push notification that's based on the message template.
*/ inline void SetSmallImageIconUrl(const char* value) { m_smallImageIconUrlHasBeenSet = true; m_smallImageIconUrl.assign(value); } /** *The URL of the small icon image to display in the status bar and the content * view of a push notification that's based on the message template.
*/ inline AndroidPushNotificationTemplate& WithSmallImageIconUrl(const Aws::String& value) { SetSmallImageIconUrl(value); return *this;} /** *The URL of the small icon image to display in the status bar and the content * view of a push notification that's based on the message template.
*/ inline AndroidPushNotificationTemplate& WithSmallImageIconUrl(Aws::String&& value) { SetSmallImageIconUrl(std::move(value)); return *this;} /** *The URL of the small icon image to display in the status bar and the content * view of a push notification that's based on the message template.
*/ inline AndroidPushNotificationTemplate& WithSmallImageIconUrl(const char* value) { SetSmallImageIconUrl(value); return *this;} /** *The sound to play when a recipient receives a push notification that's based * on the message template. 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/.
*/ inline const Aws::String& GetSound() const{ return m_sound; } /** *The sound to play when a recipient receives a push notification that's based * on the message template. 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/.
*/ inline bool SoundHasBeenSet() const { return m_soundHasBeenSet; } /** *The sound to play when a recipient receives a push notification that's based * on the message template. 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/.
*/ inline void SetSound(const Aws::String& value) { m_soundHasBeenSet = true; m_sound = value; } /** *The sound to play when a recipient receives a push notification that's based * on the message template. 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/.
*/ inline void SetSound(Aws::String&& value) { m_soundHasBeenSet = true; m_sound = std::move(value); } /** *The sound to play when a recipient receives a push notification that's based * on the message template. 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/.
*/ inline void SetSound(const char* value) { m_soundHasBeenSet = true; m_sound.assign(value); } /** *The sound to play when a recipient receives a push notification that's based * on the message template. 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/.
*/ inline AndroidPushNotificationTemplate& WithSound(const Aws::String& value) { SetSound(value); return *this;} /** *The sound to play when a recipient receives a push notification that's based * on the message template. 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/.
*/ inline AndroidPushNotificationTemplate& WithSound(Aws::String&& value) { SetSound(std::move(value)); return *this;} /** *The sound to play when a recipient receives a push notification that's based * on the message template. 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/.
*/ inline AndroidPushNotificationTemplate& WithSound(const char* value) { SetSound(value); return *this;} /** *The title to use in a push notification that's based on the message template. * This title appears above the notification message on a recipient's device.
*/ inline const Aws::String& GetTitle() const{ return m_title; } /** *The title to use in a push notification that's based on the message template. * This title appears above the notification message on a recipient's device.
*/ inline bool TitleHasBeenSet() const { return m_titleHasBeenSet; } /** *The title to use in a push notification that's based on the message template. * This title appears above the notification message on a recipient's device.
*/ inline void SetTitle(const Aws::String& value) { m_titleHasBeenSet = true; m_title = value; } /** *The title to use in a push notification that's based on the message template. * This title appears above the notification message on a recipient's device.
*/ inline void SetTitle(Aws::String&& value) { m_titleHasBeenSet = true; m_title = std::move(value); } /** *The title to use in a push notification that's based on the message template. * This title appears above the notification message on a recipient's device.
*/ inline void SetTitle(const char* value) { m_titleHasBeenSet = true; m_title.assign(value); } /** *The title to use in a push notification that's based on the message template. * This title appears above the notification message on a recipient's device.
*/ inline AndroidPushNotificationTemplate& WithTitle(const Aws::String& value) { SetTitle(value); return *this;} /** *The title to use in a push notification that's based on the message template. * This title appears above the notification message on a recipient's device.
*/ inline AndroidPushNotificationTemplate& WithTitle(Aws::String&& value) { SetTitle(std::move(value)); return *this;} /** *The title to use in a push notification that's based on the message template. * This title appears above the notification message on a recipient's device.
*/ inline AndroidPushNotificationTemplate& WithTitle(const char* value) { SetTitle(value); return *this;} /** *The URL to open in a recipient's default mobile browser, if a recipient taps * a push notification that's based on the message template and the value of the * Action property is URL.
*/ inline const Aws::String& GetUrl() const{ return m_url; } /** *The URL to open in a recipient's default mobile browser, if a recipient taps * a push notification that's based on the message template and the value of the * Action property is URL.
*/ inline bool UrlHasBeenSet() const { return m_urlHasBeenSet; } /** *The URL to open in a recipient's default mobile browser, if a recipient taps * a push notification that's based on the message template and the value of the * Action property is URL.
*/ inline void SetUrl(const Aws::String& value) { m_urlHasBeenSet = true; m_url = value; } /** *The URL to open in a recipient's default mobile browser, if a recipient taps * a push notification that's based on the message template and the value of the * Action property is URL.
*/ inline void SetUrl(Aws::String&& value) { m_urlHasBeenSet = true; m_url = std::move(value); } /** *The URL to open in a recipient's default mobile browser, if a recipient taps * a push notification that's based on the message template and the value of the * Action property is URL.
*/ inline void SetUrl(const char* value) { m_urlHasBeenSet = true; m_url.assign(value); } /** *The URL to open in a recipient's default mobile browser, if a recipient taps * a push notification that's based on the message template and the value of the * Action property is URL.
*/ inline AndroidPushNotificationTemplate& WithUrl(const Aws::String& value) { SetUrl(value); return *this;} /** *The URL to open in a recipient's default mobile browser, if a recipient taps * a push notification that's based on the message template and the value of the * Action property is URL.
*/ inline AndroidPushNotificationTemplate& WithUrl(Aws::String&& value) { SetUrl(std::move(value)); return *this;} /** *The URL to open in a recipient's default mobile browser, if a recipient taps * a push notification that's based on the message template and the value of the * Action property is URL.
*/ inline AndroidPushNotificationTemplate& WithUrl(const char* value) { SetUrl(value); return *this;} private: Action m_action; bool m_actionHasBeenSet = false; Aws::String m_body; bool m_bodyHasBeenSet = false; Aws::String m_imageIconUrl; bool m_imageIconUrlHasBeenSet = false; Aws::String m_imageUrl; bool m_imageUrlHasBeenSet = false; Aws::String m_rawContent; bool m_rawContentHasBeenSet = false; Aws::String m_smallImageIconUrl; bool m_smallImageIconUrlHasBeenSet = false; Aws::String m_sound; bool m_soundHasBeenSet = false; Aws::String m_title; bool m_titleHasBeenSet = false; Aws::String m_url; bool m_urlHasBeenSet = false; }; } // namespace Model } // namespace Pinpoint } // namespace Aws