line |
stmt |
bran |
cond |
sub |
pod |
time |
code |
1
|
|
|
|
|
|
|
package Paws::Pinpoint::GCMMessage; |
2
|
1
|
|
|
1
|
|
422
|
use Moose; |
|
1
|
|
|
|
|
3
|
|
|
1
|
|
|
|
|
6
|
|
3
|
|
|
|
|
|
|
has Action => (is => 'ro', isa => 'Str'); |
4
|
|
|
|
|
|
|
has Body => (is => 'ro', isa => 'Str'); |
5
|
|
|
|
|
|
|
has CollapseKey => (is => 'ro', isa => 'Str'); |
6
|
|
|
|
|
|
|
has Data => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string'); |
7
|
|
|
|
|
|
|
has IconReference => (is => 'ro', isa => 'Str'); |
8
|
|
|
|
|
|
|
has ImageIconUrl => (is => 'ro', isa => 'Str'); |
9
|
|
|
|
|
|
|
has ImageUrl => (is => 'ro', isa => 'Str'); |
10
|
|
|
|
|
|
|
has JsonData => (is => 'ro', isa => 'Str'); |
11
|
|
|
|
|
|
|
has RawContent => (is => 'ro', isa => 'Str'); |
12
|
|
|
|
|
|
|
has RestrictedPackageName => (is => 'ro', isa => 'Str'); |
13
|
|
|
|
|
|
|
has SilentPush => (is => 'ro', isa => 'Bool'); |
14
|
|
|
|
|
|
|
has SmallImageIconUrl => (is => 'ro', isa => 'Str'); |
15
|
|
|
|
|
|
|
has Sound => (is => 'ro', isa => 'Str'); |
16
|
|
|
|
|
|
|
has Substitutions => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string'); |
17
|
|
|
|
|
|
|
has Title => (is => 'ro', isa => 'Str'); |
18
|
|
|
|
|
|
|
has Url => (is => 'ro', isa => 'Str'); |
19
|
|
|
|
|
|
|
1; |
20
|
|
|
|
|
|
|
|
21
|
|
|
|
|
|
|
### main pod documentation begin ### |
22
|
|
|
|
|
|
|
|
23
|
|
|
|
|
|
|
=head1 NAME |
24
|
|
|
|
|
|
|
|
25
|
|
|
|
|
|
|
Paws::Pinpoint::GCMMessage |
26
|
|
|
|
|
|
|
|
27
|
|
|
|
|
|
|
=head1 USAGE |
28
|
|
|
|
|
|
|
|
29
|
|
|
|
|
|
|
This class represents one of two things: |
30
|
|
|
|
|
|
|
|
31
|
|
|
|
|
|
|
=head3 Arguments in a call to a service |
32
|
|
|
|
|
|
|
|
33
|
|
|
|
|
|
|
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. |
34
|
|
|
|
|
|
|
Each attribute should be used as a named argument in the calls that expect this type of object. |
35
|
|
|
|
|
|
|
|
36
|
|
|
|
|
|
|
As an example, if Att1 is expected to be a Paws::Pinpoint::GCMMessage object: |
37
|
|
|
|
|
|
|
|
38
|
|
|
|
|
|
|
$service_obj->Method(Att1 => { Action => $value, ..., Url => $value }); |
39
|
|
|
|
|
|
|
|
40
|
|
|
|
|
|
|
=head3 Results returned from an API call |
41
|
|
|
|
|
|
|
|
42
|
|
|
|
|
|
|
Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::GCMMessage object: |
43
|
|
|
|
|
|
|
|
44
|
|
|
|
|
|
|
$result = $service_obj->Method(...); |
45
|
|
|
|
|
|
|
$result->Att1->Action |
46
|
|
|
|
|
|
|
|
47
|
|
|
|
|
|
|
=head1 DESCRIPTION |
48
|
|
|
|
|
|
|
|
49
|
|
|
|
|
|
|
GCM Message. |
50
|
|
|
|
|
|
|
|
51
|
|
|
|
|
|
|
=head1 ATTRIBUTES |
52
|
|
|
|
|
|
|
|
53
|
|
|
|
|
|
|
|
54
|
|
|
|
|
|
|
=head2 Action => Str |
55
|
|
|
|
|
|
|
|
56
|
|
|
|
|
|
|
The action that occurs if the user taps a push notification delivered |
57
|
|
|
|
|
|
|
by the campaign: OPEN_APP - Your app launches, or it becomes the |
58
|
|
|
|
|
|
|
foreground app if it has been sent to the background. This is the |
59
|
|
|
|
|
|
|
default action. DEEP_LINK - Uses deep linking features in iOS and |
60
|
|
|
|
|
|
|
Android to open your app and display a designated user interface within |
61
|
|
|
|
|
|
|
the app. URL - The default mobile browser on the user's device launches |
62
|
|
|
|
|
|
|
and opens a web page at the URL you specify. Possible values include: |
63
|
|
|
|
|
|
|
OPEN_APP | DEEP_LINK | URL |
64
|
|
|
|
|
|
|
|
65
|
|
|
|
|
|
|
|
66
|
|
|
|
|
|
|
=head2 Body => Str |
67
|
|
|
|
|
|
|
|
68
|
|
|
|
|
|
|
The message body of the notification, the email body or the text |
69
|
|
|
|
|
|
|
message. |
70
|
|
|
|
|
|
|
|
71
|
|
|
|
|
|
|
|
72
|
|
|
|
|
|
|
=head2 CollapseKey => Str |
73
|
|
|
|
|
|
|
|
74
|
|
|
|
|
|
|
This parameter identifies a group of messages (e.g., with collapse_key: |
75
|
|
|
|
|
|
|
"Updates Available") that can be collapsed, so that only the last |
76
|
|
|
|
|
|
|
message gets sent when delivery can be resumed. This is intended to |
77
|
|
|
|
|
|
|
avoid sending too many of the same messages when the device comes back |
78
|
|
|
|
|
|
|
online or becomes active. |
79
|
|
|
|
|
|
|
|
80
|
|
|
|
|
|
|
|
81
|
|
|
|
|
|
|
=head2 Data => L<Paws::Pinpoint::MapOf__string> |
82
|
|
|
|
|
|
|
|
83
|
|
|
|
|
|
|
The data payload used for a silent push. This payload is added to the |
84
|
|
|
|
|
|
|
notifications' data.pinpoint.jsonBody' object |
85
|
|
|
|
|
|
|
|
86
|
|
|
|
|
|
|
|
87
|
|
|
|
|
|
|
=head2 IconReference => Str |
88
|
|
|
|
|
|
|
|
89
|
|
|
|
|
|
|
The icon image name of the asset saved in your application. |
90
|
|
|
|
|
|
|
|
91
|
|
|
|
|
|
|
|
92
|
|
|
|
|
|
|
=head2 ImageIconUrl => Str |
93
|
|
|
|
|
|
|
|
94
|
|
|
|
|
|
|
The URL that points to an image used as the large icon to the |
95
|
|
|
|
|
|
|
notification content view. |
96
|
|
|
|
|
|
|
|
97
|
|
|
|
|
|
|
|
98
|
|
|
|
|
|
|
=head2 ImageUrl => Str |
99
|
|
|
|
|
|
|
|
100
|
|
|
|
|
|
|
The URL that points to an image used in the push notification. |
101
|
|
|
|
|
|
|
|
102
|
|
|
|
|
|
|
|
103
|
|
|
|
|
|
|
=head2 JsonData => Str |
104
|
|
|
|
|
|
|
|
105
|
|
|
|
|
|
|
The data payload used for a silent push. This payload is added to the |
106
|
|
|
|
|
|
|
notifications' data.pinpoint.jsonBody' object |
107
|
|
|
|
|
|
|
|
108
|
|
|
|
|
|
|
|
109
|
|
|
|
|
|
|
=head2 RawContent => Str |
110
|
|
|
|
|
|
|
|
111
|
|
|
|
|
|
|
The Raw JSON formatted string to be used as the payload. This value |
112
|
|
|
|
|
|
|
overrides the message. |
113
|
|
|
|
|
|
|
|
114
|
|
|
|
|
|
|
|
115
|
|
|
|
|
|
|
=head2 RestrictedPackageName => Str |
116
|
|
|
|
|
|
|
|
117
|
|
|
|
|
|
|
This parameter specifies the package name of the application where the |
118
|
|
|
|
|
|
|
registration tokens must match in order to receive the message. |
119
|
|
|
|
|
|
|
|
120
|
|
|
|
|
|
|
|
121
|
|
|
|
|
|
|
=head2 SilentPush => Bool |
122
|
|
|
|
|
|
|
|
123
|
|
|
|
|
|
|
Indicates if the message should display on the users device. Silent |
124
|
|
|
|
|
|
|
pushes can be used for Remote Configuration and Phone Home use cases. |
125
|
|
|
|
|
|
|
|
126
|
|
|
|
|
|
|
|
127
|
|
|
|
|
|
|
=head2 SmallImageIconUrl => Str |
128
|
|
|
|
|
|
|
|
129
|
|
|
|
|
|
|
The URL that points to an image used as the small icon for the |
130
|
|
|
|
|
|
|
notification which will be used to represent the notification in the |
131
|
|
|
|
|
|
|
status bar and content view |
132
|
|
|
|
|
|
|
|
133
|
|
|
|
|
|
|
|
134
|
|
|
|
|
|
|
=head2 Sound => Str |
135
|
|
|
|
|
|
|
|
136
|
|
|
|
|
|
|
Indicates a sound to play when the device receives the notification. |
137
|
|
|
|
|
|
|
Supports default, or the filename of a sound resource bundled in the |
138
|
|
|
|
|
|
|
app. Android sound files must reside in /res/raw/ |
139
|
|
|
|
|
|
|
|
140
|
|
|
|
|
|
|
|
141
|
|
|
|
|
|
|
=head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string> |
142
|
|
|
|
|
|
|
|
143
|
|
|
|
|
|
|
Default message substitutions. Can be overridden by individual address |
144
|
|
|
|
|
|
|
substitutions. |
145
|
|
|
|
|
|
|
|
146
|
|
|
|
|
|
|
|
147
|
|
|
|
|
|
|
=head2 Title => Str |
148
|
|
|
|
|
|
|
|
149
|
|
|
|
|
|
|
The message title that displays above the message on the user's device. |
150
|
|
|
|
|
|
|
|
151
|
|
|
|
|
|
|
|
152
|
|
|
|
|
|
|
=head2 Url => Str |
153
|
|
|
|
|
|
|
|
154
|
|
|
|
|
|
|
The URL to open in the user's mobile browser. Used if the value for |
155
|
|
|
|
|
|
|
Action is URL. |
156
|
|
|
|
|
|
|
|
157
|
|
|
|
|
|
|
|
158
|
|
|
|
|
|
|
|
159
|
|
|
|
|
|
|
=head1 SEE ALSO |
160
|
|
|
|
|
|
|
|
161
|
|
|
|
|
|
|
This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> |
162
|
|
|
|
|
|
|
|
163
|
|
|
|
|
|
|
=head1 BUGS and CONTRIBUTIONS |
164
|
|
|
|
|
|
|
|
165
|
|
|
|
|
|
|
The source code is located here: https://github.com/pplu/aws-sdk-perl |
166
|
|
|
|
|
|
|
|
167
|
|
|
|
|
|
|
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues |
168
|
|
|
|
|
|
|
|
169
|
|
|
|
|
|
|
=cut |
170
|
|
|
|
|
|
|
|