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