blib/lib/Paws/Pinpoint/GCMMessage.pm untested

filter: Statementstmt 0.0% 0 / 20 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 21 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Pinpoint::GCMMessage;
3 use Moose;
4 has Action => (is => 'ro', isa => 'Str');
5 has Body => (is => 'ro', isa => 'Str');
6 has CollapseKey => (is => 'ro', isa => 'Str');
7 has Data => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string');
8 has IconReference => (is => 'ro', isa => 'Str');
9 has ImageIconUrl => (is => 'ro', isa => 'Str');
10 has ImageUrl => (is => 'ro', isa => 'Str');
11 has Priority => (is => 'ro', isa => 'Str');
12 has RawContent => (is => 'ro', isa => 'Str');
13 has RestrictedPackageName => (is => 'ro', isa => 'Str');
14 has SilentPush => (is => 'ro', isa => 'Bool');
15 has SmallImageIconUrl => (is => 'ro', isa => 'Str');
16 has Sound => (is => 'ro', isa => 'Str');
17 has Substitutions => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string');
18 has TimeToLive => (is => 'ro', isa => 'Int');
19 has Title => (is => 'ro', isa => 'Str');
20 has Url => (is => 'ro', isa => 'Str');
21  
22 1;
23  
24 ### main pod documentation begin ###
25  
26 =head1 NAME
27  
28 Paws::Pinpoint::GCMMessage
29  
30 =head1 USAGE
31  
32 This class represents one of two things:
33  
34 =head3 Arguments in a call to a service
35  
36 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
37 Each attribute should be used as a named argument in the calls that expect this type of object.
38  
39 As an example, if Att1 is expected to be a Paws::Pinpoint::GCMMessage object:
40  
41 $service_obj->Method(Att1 => { Action => $value, ..., Url => $value });
42  
43 =head3 Results returned from an API call
44  
45 Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::GCMMessage object:
46  
47 $result = $service_obj->Method(...);
48 $result->Att1->Action
49  
50 =head1 DESCRIPTION
51  
52 Specifies the settings for a one-time message that's sent directly to
53 an endpoint through the GCM channel. The GCM channel enables Amazon
54 Pinpoint to send messages to the Firebase Cloud Messaging (FCM),
55 formerly Google Cloud Messaging (GCM), service.
56  
57 =head1 ATTRIBUTES
58  
59  
60 =head2 Action => Str
61  
62 The action to occur if the recipient taps the push notification. Valid
63 values are:
64  
65 =over
66  
67 =item *
68  
69 OPEN_APP - Your app opens or it becomes the foreground app if it was
70 sent to the background. This is the default action.
71  
72 =item *
73  
74 DEEP_LINK - Your app opens and displays a designated user interface in
75 the app. This action uses the deep-linking features of the Android
76 platform.
77  
78 =item *
79  
80 URL - The default mobile browser on the recipient's device opens and
81 loads the web page at a URL that you specify.
82  
83 =back
84  
85  
86  
87 =head2 Body => Str
88  
89 The body of the notification message.
90  
91  
92 =head2 CollapseKey => Str
93  
94 An arbitrary string that identifies a group of messages that can be
95 collapsed to ensure that only the last message is sent when delivery
96 can resume. This helps avoid sending too many instances of the same
97 messages when the recipient's device comes online again or becomes
98 active.
99  
100 Amazon Pinpoint specifies this value in the Firebase Cloud Messaging
101 (FCM) collapse_key parameter when it sends the notification message to
102 FCM.
103  
104  
105 =head2 Data => L<Paws::Pinpoint::MapOf__string>
106  
107 The JSON data payload to use for the push notification, if the
108 notification is a silent push notification. This payload is added to
109 the data.pinpoint.jsonBody object of the notification.
110  
111  
112 =head2 IconReference => Str
113  
114 The icon image name of the asset saved in your app.
115  
116  
117 =head2 ImageIconUrl => Str
118  
119 The URL of the large icon image to display in the content view of the
120 push notification.
121  
122  
123 =head2 ImageUrl => Str
124  
125 The URL of an image to display in the push notification.
126  
127  
128 =head2 Priority => Str
129  
130 paraE<gt>normal - The notification might be delayed. Delivery is
131 optimized for battery usage on the recipient's device. Use this value
132 unless immediate delivery is required.
133  
134 /listitemE<gt>
135  
136 =over
137  
138 =item *
139  
140 high - The notification is sent immediately and might wake a sleeping
141 device.
142  
143 /paraE<gt>
144  
145 Amazon Pinpoint specifies this value in the FCM priority parameter when
146 it sends the notification message to FCM.
147  
148 The equivalent values for Apple Push Notification service (APNs) are 5,
149 for normal, and 10, for high. If you specify an APNs value for this
150 property, Amazon Pinpoint accepts and converts the value to the
151 corresponding FCM value.
152  
153 =back
154  
155  
156  
157 =head2 RawContent => Str
158  
159 The raw, JSON-formatted string to use as the payload for the
160 notification message. If specified, this value overrides all other
161 content for the message.
162  
163  
164 =head2 RestrictedPackageName => Str
165  
166 The package name of the application where registration tokens must
167 match in order for the recipient to receive the message.
168  
169  
170 =head2 SilentPush => Bool
171  
172 Specifies whether the notification is a silent push notification, which
173 is a push notification that doesn't display on a recipient's device.
174 Silent push notifications can be used for cases such as updating an
175 app's configuration or supporting phone home functionality.
176  
177  
178 =head2 SmallImageIconUrl => Str
179  
180 The URL of the small icon image to display in the status bar and the
181 content view of the push notification.
182  
183  
184 =head2 Sound => Str
185  
186 The sound to play when the recipient receives the push notification.
187 You can use the default stream or specify the file name of a sound
188 resource that's bundled in your app. On an Android platform, the sound
189 file must reside in /res/raw/.
190  
191  
192 =head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string>
193  
194 The default message variables to use in the notification message. You
195 can override the default variables with individual address variables.
196  
197  
198 =head2 TimeToLive => Int
199  
200 The amount of time, in seconds, that FCM should store and attempt to
201 deliver the push notification, if the service is unable to deliver the
202 notification the first time. If you don't specify this value, FCM
203 defaults to the maximum value, which is 2,419,200 seconds (28 days).
204  
205 Amazon Pinpoint specifies this value in the FCM time_to_live parameter
206 when it sends the notification message to FCM.
207  
208  
209 =head2 Title => Str
210  
211 The title to display above the notification message on the recipient's
212 device.
213  
214  
215 =head2 Url => Str
216  
217 The URL to open in the recipient's default mobile browser, if a
218 recipient taps the push notification and the value of the Action
219 property is URL.
220  
221  
222  
223 =head1 SEE ALSO
224  
225 This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
226  
227 =head1 BUGS and CONTRIBUTIONS
228  
229 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
230  
231 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
232  
233 =cut
234