File Coverage

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