Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Pinpoint.Types.APNSPushNotificationTemplate

Description

Synopsis

data APNSPushNotificationTemplate = APNSPushNotificationTemplate' {
- rawContent :: Maybe Text
- body :: Maybe Text
- url :: Maybe Text
- sound :: Maybe Text
- action :: Maybe Action
- mediaUrl :: Maybe Text
- title :: Maybe Text
}
newAPNSPushNotificationTemplate :: APNSPushNotificationTemplate
aPNSPushNotificationTemplate_rawContent :: Lens' APNSPushNotificationTemplate (Maybe Text)
aPNSPushNotificationTemplate_body :: Lens' APNSPushNotificationTemplate (Maybe Text)
aPNSPushNotificationTemplate_url :: Lens' APNSPushNotificationTemplate (Maybe Text)
aPNSPushNotificationTemplate_sound :: Lens' APNSPushNotificationTemplate (Maybe Text)
aPNSPushNotificationTemplate_action :: Lens' APNSPushNotificationTemplate (Maybe Action)
aPNSPushNotificationTemplate_mediaUrl :: Lens' APNSPushNotificationTemplate (Maybe Text)
aPNSPushNotificationTemplate_title :: Lens' APNSPushNotificationTemplate (Maybe Text)

Documentation

data APNSPushNotificationTemplate Source #

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.

See: newAPNSPushNotificationTemplate smart constructor.

Constructors

APNSPushNotificationTemplate'

Fields

rawContent :: Maybe Text
The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
body :: Maybe Text
The message body to use in push notifications that are based on the message template.
url :: Maybe Text
The URL to open in the 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.
sound :: Maybe Text
The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
action :: Maybe Action
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 setting uses the deep-linking features of the iOS platform.
- URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
mediaUrl :: Maybe Text
The URL of an image or video to display in push notifications that are based on the message template.
title :: Maybe Text
The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

Instances

Instances details

Eq APNSPushNotificationTemplate Source #
Instance details Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate Methods (==) :: APNSPushNotificationTemplate -> APNSPushNotificationTemplate -> Bool # (/=) :: APNSPushNotificationTemplate -> APNSPushNotificationTemplate -> Bool #
Read APNSPushNotificationTemplate Source #
Instance details Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate Methods readsPrec :: Int -> ReadS APNSPushNotificationTemplate # readList :: ReadS [APNSPushNotificationTemplate] # readPrec :: ReadPrec APNSPushNotificationTemplate # readListPrec :: ReadPrec [APNSPushNotificationTemplate] #
Show APNSPushNotificationTemplate Source #
Instance details Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate Methods showsPrec :: Int -> APNSPushNotificationTemplate -> ShowS # show :: APNSPushNotificationTemplate -> String # showList :: [APNSPushNotificationTemplate] -> ShowS #
Generic APNSPushNotificationTemplate Source #
Instance details Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate Associated Types type Rep APNSPushNotificationTemplate :: Type -> Type # Methods from :: APNSPushNotificationTemplate -> Rep APNSPushNotificationTemplate x # to :: Rep APNSPushNotificationTemplate x -> APNSPushNotificationTemplate #
NFData APNSPushNotificationTemplate Source #
Instance details Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate Methods rnf :: APNSPushNotificationTemplate -> () #
Hashable APNSPushNotificationTemplate Source #
Instance details Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate Methods hashWithSalt :: Int -> APNSPushNotificationTemplate -> Int # hash :: APNSPushNotificationTemplate -> Int #
ToJSON APNSPushNotificationTemplate Source #
Instance details Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate Methods toJSON :: APNSPushNotificationTemplate -> Value # toEncoding :: APNSPushNotificationTemplate -> Encoding # toJSONList :: [APNSPushNotificationTemplate] -> Value # toEncodingList :: [APNSPushNotificationTemplate] -> Encoding #
FromJSON APNSPushNotificationTemplate Source #
Instance details Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate Methods parseJSON :: Value -> Parser APNSPushNotificationTemplate # parseJSONList :: Value -> Parser [APNSPushNotificationTemplate] #
type Rep APNSPushNotificationTemplate Source #
Instance details Defined in Amazonka.Pinpoint.Types.APNSPushNotificationTemplate type Rep APNSPushNotificationTemplate = D1 ('MetaData "APNSPushNotificationTemplate" "Amazonka.Pinpoint.Types.APNSPushNotificationTemplate" "libZSservicesZSamazonka-pinpointZSamazonka-pinpoint" 'False) (C1 ('MetaCons "APNSPushNotificationTemplate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "rawContent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "sound") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Action))) :: (S1 ('MetaSel ('Just "mediaUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "title") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newAPNSPushNotificationTemplate :: APNSPushNotificationTemplate Source #

Create a value of APNSPushNotificationTemplate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:rawContent:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_rawContent - The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

$sel:body:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_body - The message body to use in push notifications that are based on the message template.

$sel:url:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_url - The URL to open in the 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.

$sel:sound:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_sound - The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

$sel:action:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_action - 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 setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

$sel:mediaUrl:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_mediaUrl - The URL of an image or video to display in push notifications that are based on the message template.

$sel:title:APNSPushNotificationTemplate', aPNSPushNotificationTemplate_title - The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.

aPNSPushNotificationTemplate_rawContent :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.

aPNSPushNotificationTemplate_body :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The message body to use in push notifications that are based on the message template.

aPNSPushNotificationTemplate_url :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The URL to open in the 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.

aPNSPushNotificationTemplate_sound :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.

aPNSPushNotificationTemplate_action :: Lens' APNSPushNotificationTemplate (Maybe Action) Source #

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 setting uses the deep-linking features of the iOS platform.
URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.

aPNSPushNotificationTemplate_mediaUrl :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The URL of an image or video to display in push notifications that are based on the message template.

aPNSPushNotificationTemplate_title :: Lens' APNSPushNotificationTemplate (Maybe Text) Source #

The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.