« blib/lib/Paws/Pinpoint/APNSMessage.pm
↑ Summary
blib/lib/Paws/Pinpoint/APNSSandboxChannelRequest.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::APNSPushNotificationTemplate; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has Body => (is => 'ro', isa => 'Str'); | ||
| 6 | has MediaUrl => (is => 'ro', isa => 'Str'); | ||
| 7 | has RawContent => (is => 'ro', isa => 'Str'); | ||
| 8 | has Sound => (is => 'ro', isa => 'Str'); | ||
| 9 | has Title => (is => 'ro', isa => 'Str'); | ||
| 10 | has Url => (is => 'ro', isa => 'Str'); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Pinpoint::APNSPushNotificationTemplate | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::Pinpoint::APNSPushNotificationTemplate object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { Action => $value, ..., Url => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::APNSPushNotificationTemplate object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->Action | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Specifies channel-specific content and settings for a message template | ||
| 43 | that can be used in push notifications that are sent through the APNs | ||
| 44 | (Apple Push Notification service) channel. | ||
| 45 | |||
| 46 | =head1 ATTRIBUTES | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Action => Str | ||
| 50 | |||
| 51 | The action to occur if a recipient taps a push notification that's | ||
| 52 | based on the message template. Valid values are: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | OPEN_APP - Your app opens or it becomes the foreground app if it was | ||
| 59 | sent to the background. This is the default action. | ||
| 60 | |||
| 61 | =item * | ||
| 62 | |||
| 63 | DEEP_LINK - Your app opens and displays a designated user interface in | ||
| 64 | the app. This setting uses the deep-linking features of the iOS | ||
| 65 | platform. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | URL - The default mobile browser on the recipient's device opens and | ||
| 70 | loads the web page at a URL that you specify. | ||
| 71 | |||
| 72 | =back | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Body => Str | ||
| 77 | |||
| 78 | The message body to use in push notifications that are based on the | ||
| 79 | message template. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 MediaUrl => Str | ||
| 83 | |||
| 84 | The URL of an image or video to display in push notifications that are | ||
| 85 | based on the message template. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 RawContent => Str | ||
| 89 | |||
| 90 | The raw, JSON-formatted string to use as the payload for push | ||
| 91 | notifications that are based on the message template. If specified, | ||
| 92 | this value overrides all other content for the message template. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 Sound => Str | ||
| 96 | |||
| 97 | The key for the sound to play when the recipient receives a push | ||
| 98 | notification that's based on the message template. The value for this | ||
| 99 | key is the name of a sound file in your app's main bundle or the | ||
| 100 | Library/Sounds folder in your app's data container. If the sound file | ||
| 101 | can't be found or you specify default for the value, the system plays | ||
| 102 | the default alert sound. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 Title => Str | ||
| 106 | |||
| 107 | The title to use in push notifications that are based on the message | ||
| 108 | template. This title appears above the notification message on a | ||
| 109 | recipient's device. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 Url => Str | ||
| 113 | |||
| 114 | The URL to open in the recipient's default mobile browser, if a | ||
| 115 | recipient taps a push notification that's based on the message template | ||
| 116 | and the value of the Action property is URL. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head1 SEE ALSO | ||
| 121 | |||
| 122 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 123 | |||
| 124 | =head1 BUGS and CONTRIBUTIONS | ||
| 125 | |||
| 126 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 127 | |||
| 128 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 129 | |||
| 130 | =cut | ||
| 131 |