/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::Pinpoint::APNSPushNotificationTemplate

NAME

Paws::Pinpoint::APNSPushNotificationTemplate

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Pinpoint::APNSPushNotificationTemplate object:

$service_obj->Method(Att1 => { Action => $value, ..., Url => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::APNSPushNotificationTemplate object:

$result = $service_obj->Method(...);
$result->Att1->Action

DESCRIPTION

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.

ATTRIBUTES

Action => Str

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.

Body => Str

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

MediaUrl => Str

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

RawContent => Str

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.

Sound => Str

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.

Title => Str

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.

Url => Str

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.

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Pinpoint

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues