File Coverage

blib/lib/Paws/Pinpoint/APNSMessage.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::APNSMessage;
2	1	1	403	use Moose;
	1		3
	1		7
3				has Action => (is => 'ro', isa => 'Str');
4				has Badge => (is => 'ro', isa => 'Int');
5				has Body => (is => 'ro', isa => 'Str');
6				has Category => (is => 'ro', isa => 'Str');
7				has Data => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string');
8				has MediaUrl => (is => 'ro', isa => 'Str');
9				has RawContent => (is => 'ro', isa => 'Str');
10				has SilentPush => (is => 'ro', isa => 'Bool');
11				has Sound => (is => 'ro', isa => 'Str');
12				has Substitutions => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string');
13				has ThreadId => (is => 'ro', isa => 'Str');
14				has Title => (is => 'ro', isa => 'Str');
15				has Url => (is => 'ro', isa => 'Str');
16				1;
17
18				### main pod documentation begin ###
19
20				=head1 NAME
21
22				Paws::Pinpoint::APNSMessage
23
24				=head1 USAGE
25
26				This class represents one of two things:
27
28				=head3 Arguments in a call to a service
29
30				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
31				Each attribute should be used as a named argument in the calls that expect this type of object.
32
33				As an example, if Att1 is expected to be a Paws::Pinpoint::APNSMessage object:
34
35				$service_obj->Method(Att1 => { Action => $value, ..., Url => $value });
36
37				=head3 Results returned from an API call
38
39				Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::APNSMessage object:
40
41				$result = $service_obj->Method(...);
42				$result->Att1->Action
43
44				=head1 DESCRIPTION
45
46				APNS Message.
47
48				=head1 ATTRIBUTES
49
50
51				=head2 Action => Str
52
53				The action that occurs if the user taps a push notification delivered
54				by the campaign: OPEN_APP - Your app launches, or it becomes the
55				foreground app if it has been sent to the background. This is the
56				default action. DEEP_LINK - Uses deep linking features in iOS and
57				Android to open your app and display a designated user interface within
58				the app. URL - The default mobile browser on the user's device launches
59				and opens a web page at the URL you specify. Possible values include:
60				OPEN_APP \| DEEP_LINK \| URL
61
62
63				=head2 Badge => Int
64
65				Include this key when you want the system to modify the badge of your
66				app icon. If this key is not included in the dictionary, the badge is
67				not changed. To remove the badge, set the value of this key to 0.
68
69
70				=head2 Body => Str
71
72				The message body of the notification, the email body or the text
73				message.
74
75
76				=head2 Category => Str
77
78				Provide this key with a string value that represents the notification's
79				type. This value corresponds to the value in the identifier property of
80				one of your app's registered categories.
81
82
83				=head2 Data => L<Paws::Pinpoint::MapOf__string>
84
85				The data payload used for a silent push. This payload is added to the
86				notifications' data.pinpoint.jsonBody' object
87
88
89				=head2 MediaUrl => Str
90
91				The URL that points to a video used in the push notification.
92
93
94				=head2 RawContent => Str
95
96				The Raw JSON formatted string to be used as the payload. This value
97				overrides the message.
98
99
100				=head2 SilentPush => Bool
101
102				Indicates if the message should display on the users device. Silent
103				pushes can be used for Remote Configuration and Phone Home use cases.
104
105
106				=head2 Sound => Str
107
108				Include this key when you want the system to play a sound. The value of
109				this key is the name of a sound file in your app's main bundle or in
110				the Library/Sounds folder of your app's data container. If the sound
111				file cannot be found, or if you specify defaultfor the value, the
112				system plays the default alert sound.
113
114
115				=head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string>
116
117				Default message substitutions. Can be overridden by individual address
118				substitutions.
119
120
121				=head2 ThreadId => Str
122
123				Provide this key with a string value that represents the app-specific
124				identifier for grouping notifications. If you provide a Notification
125				Content app extension, you can use this value to group your
126				notifications together.
127
128
129				=head2 Title => Str
130
131				The message title that displays above the message on the user's device.
132
133
134				=head2 Url => Str
135
136				The URL to open in the user's mobile browser. Used if the value for
137				Action is URL.
138
139
140
141				=head1 SEE ALSO
142
143				This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
144
145				=head1 BUGS and CONTRIBUTIONS
146
147				The source code is located here: https://github.com/pplu/aws-sdk-perl
148
149				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
150
151				=cut
152