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

filter: Statementstmt 0.0% 0 / 19 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 20 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::ADMMessage;
3 use Moose;
4 has Action => (is => 'ro', isa => 'Str');
5 has Body => (is => 'ro', isa => 'Str');
6 has ConsolidationKey => (is => 'ro', isa => 'Str');
7 has Data => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string');
8 has ExpiresAfter => (is => 'ro', isa => 'Str');
9 has IconReference => (is => 'ro', isa => 'Str');
10 has ImageIconUrl => (is => 'ro', isa => 'Str');
11 has ImageUrl => (is => 'ro', isa => 'Str');
12 has MD5 => (is => 'ro', isa => 'Str');
13 has RawContent => (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 Title => (is => 'ro', isa => 'Str');
19 has Url => (is => 'ro', isa => 'Str');
20  
21 1;
22  
23 ### main pod documentation begin ###
24  
25 =head1 NAME
26  
27 Paws::Pinpoint::ADMMessage
28  
29 =head1 USAGE
30  
31 This class represents one of two things:
32  
33 =head3 Arguments in a call to a service
34  
35 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
36 Each attribute should be used as a named argument in the calls that expect this type of object.
37  
38 As an example, if Att1 is expected to be a Paws::Pinpoint::ADMMessage object:
39  
40 $service_obj->Method(Att1 => { Action => $value, ..., Url => $value });
41  
42 =head3 Results returned from an API call
43  
44 Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::ADMMessage object:
45  
46 $result = $service_obj->Method(...);
47 $result->Att1->Action
48  
49 =head1 DESCRIPTION
50  
51 Specifies the settings for a one-time message that's sent directly to
52 an endpoint through the ADM (Amazon Device Messaging) channel.
53  
54 =head1 ATTRIBUTES
55  
56  
57 =head2 Action => Str
58  
59 The action to occur if the recipient taps the push notification. Valid
60 values are:
61  
62 =over
63  
64 =item *
65  
66 OPEN_APP - Your app opens or it becomes the foreground app if it was
67 sent to the background. This is the default action.
68  
69 =item *
70  
71 DEEP_LINK - Your app opens and displays a designated user interface in
72 the app. This action uses the deep-linking features of the Android
73 platform.
74  
75 =item *
76  
77 URL - The default mobile browser on the recipient's device opens and
78 loads the web page at a URL that you specify.
79  
80 =back
81  
82  
83  
84 =head2 Body => Str
85  
86 The body of the notification message.
87  
88  
89 =head2 ConsolidationKey => Str
90  
91 An arbitrary string that indicates that multiple messages are logically
92 the same and that Amazon Device Messaging (ADM) can drop previously
93 enqueued messages in favor of this message.
94  
95  
96 =head2 Data => L<Paws::Pinpoint::MapOf__string>
97  
98 The JSON data payload to use for the push notification, if the
99 notification is a silent push notification. This payload is added to
100 the data.pinpoint.jsonBody object of the notification.
101  
102  
103 =head2 ExpiresAfter => Str
104  
105 The amount of time, in seconds, that ADM should store the message if
106 the recipient's device is offline. Amazon Pinpoint specifies this value
107 in the expiresAfter parameter when it sends the notification message to
108 ADM.
109  
110  
111 =head2 IconReference => Str
112  
113 The icon image name of the asset saved in your app.
114  
115  
116 =head2 ImageIconUrl => Str
117  
118 The URL of the large icon image to display in the content view of the
119 push notification.
120  
121  
122 =head2 ImageUrl => Str
123  
124 The URL of an image to display in the push notification.
125  
126  
127 =head2 MD5 => Str
128  
129 The base64-encoded, MD5 checksum of the value specified by the Data
130 property. ADM uses the MD5 value to verify the integrity of the data.
131  
132  
133 =head2 RawContent => Str
134  
135 The raw, JSON-formatted string to use as the payload for the
136 notification message. If specified, this value overrides all other
137 content for the message.
138  
139  
140 =head2 SilentPush => Bool
141  
142 Specifies whether the notification is a silent push notification, which
143 is a push notification that doesn't display on a recipient's device.
144 Silent push notifications can be used for cases such as updating an
145 app's configuration or supporting phone home functionality.
146  
147  
148 =head2 SmallImageIconUrl => Str
149  
150 The URL of the small icon image to display in the status bar and the
151 content view of the push notification.
152  
153  
154 =head2 Sound => Str
155  
156 The sound to play when the recipient receives the push notification.
157 You can use the default stream or specify the file name of a sound
158 resource that's bundled in your app. On an Android platform, the sound
159 file must reside in /res/raw/.
160  
161  
162 =head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string>
163  
164 The default message variables to use in the notification message. You
165 can override the default variables with individual address variables.
166  
167  
168 =head2 Title => Str
169  
170 The title to display above the notification message on the recipient's
171 device.
172  
173  
174 =head2 Url => Str
175  
176 The URL to open in the recipient's default mobile browser, if a
177 recipient taps the push notification and the value of the Action
178 property is URL.
179  
180  
181  
182 =head1 SEE ALSO
183  
184 This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
185  
186 =head1 BUGS and CONTRIBUTIONS
187  
188 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
189  
190 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
191  
192 =cut
193