File Coverage

blib/lib/Paws/Pinpoint/GCMMessage.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

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