« blib/lib/Paws/Pinpoint/DefaultMessage.pm
↑ Summary
blib/lib/Paws/Pinpoint/DefaultPushNotificationTemplate.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::DefaultPushNotificationMessage; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has Body => (is => 'ro', isa => 'Str'); | ||
| 6 | has Data => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string'); | ||
| 7 | has SilentPush => (is => 'ro', isa => 'Bool'); | ||
| 8 | has Substitutions => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string'); | ||
| 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::DefaultPushNotificationMessage | ||
| 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::DefaultPushNotificationMessage 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::DefaultPushNotificationMessage object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->Action | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | Specifies the default settings and content for a push notification | ||
| 43 | that's sent directly to an endpoint. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 Action => Str | ||
| 49 | |||
| 50 | The default action to occur if a recipient taps the push notification. | ||
| 51 | Valid values are: | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | OPEN_APP - Your app opens or it becomes the foreground app if it was | ||
| 58 | sent to the background. This is the default action. | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | DEEP_LINK - Your app opens and displays a designated user interface in | ||
| 63 | the app. This setting uses the deep-linking features of the iOS and | ||
| 64 | Android platforms. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | URL - The default mobile browser on the recipient's device opens and | ||
| 69 | loads the web page at a URL that you specify. | ||
| 70 | |||
| 71 | =back | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head2 Body => Str | ||
| 76 | |||
| 77 | The default body of the notification message. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 Data => L<Paws::Pinpoint::MapOf__string> | ||
| 81 | |||
| 82 | The JSON data payload to use for the default push notification, if the | ||
| 83 | notification is a silent push notification. This payload is added to | ||
| 84 | the data.pinpoint.jsonBody object of the notification. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 SilentPush => Bool | ||
| 88 | |||
| 89 | Specifies whether the default notification is a silent push | ||
| 90 | notification, which is a push notification that doesn't display on a | ||
| 91 | recipient's device. Silent push notifications can be used for cases | ||
| 92 | such as updating an app's configuration or delivering messages to an | ||
| 93 | in-app notification center. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string> | ||
| 97 | |||
| 98 | The default message variables to use in the notification message. You | ||
| 99 | can override the default variables with individual address variables. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 Title => Str | ||
| 103 | |||
| 104 | The default title to display above the notification message on a | ||
| 105 | recipient's device. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 Url => Str | ||
| 109 | |||
| 110 | The default URL to open in a recipient's default mobile browser, if a | ||
| 111 | recipient taps the push notification and the value of the Action | ||
| 112 | property is URL. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |