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 bran cond sub pod time code
1             package Paws::Pinpoint::APNSMessage;
2 1     1   404 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 JsonData => (is => 'ro', isa => 'Str');
9             has MediaUrl => (is => 'ro', isa => 'Str');
10             has PreferredAuthenticationMethod => (is => 'ro', isa => 'Str');
11             has RawContent => (is => 'ro', isa => 'Str');
12             has SilentPush => (is => 'ro', isa => 'Bool');
13             has Sound => (is => 'ro', isa => 'Str');
14             has Substitutions => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string');
15             has ThreadId => (is => 'ro', isa => 'Str');
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::APNSMessage
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::APNSMessage 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::APNSMessage object:
42              
43             $result = $service_obj->Method(...);
44             $result->Att1->Action
45              
46             =head1 DESCRIPTION
47              
48             APNS 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 Badge => Int
66              
67             Include this key when you want the system to modify the badge of your
68             app icon. If this key is not included in the dictionary, the badge is
69             not changed. To remove the badge, set the value of this key to 0.
70              
71              
72             =head2 Body => Str
73              
74             The message body of the notification, the email body or the text
75             message.
76              
77              
78             =head2 Category => Str
79              
80             Provide this key with a string value that represents the notification's
81             type. This value corresponds to the value in the identifier property of
82             one of your app's registered categories.
83              
84              
85             =head2 Data => L<Paws::Pinpoint::MapOf__string>
86              
87             The data payload used for a silent push. This payload is added to the
88             notifications' data.pinpoint.jsonBody' object
89              
90              
91             =head2 JsonData => Str
92              
93             The data payload used for a silent push. This payload is added to the
94             notifications' data.pinpoint.jsonBody' object
95              
96              
97             =head2 MediaUrl => Str
98              
99             The URL that points to a video used in the push notification.
100              
101              
102             =head2 PreferredAuthenticationMethod => Str
103              
104             The preferred authentication method, either "CERTIFICATE" or "TOKEN"
105              
106              
107             =head2 RawContent => Str
108              
109             The Raw JSON formatted string to be used as the payload. This value
110             overrides the message.
111              
112              
113             =head2 SilentPush => Bool
114              
115             Indicates if the message should display on the users device. Silent
116             pushes can be used for Remote Configuration and Phone Home use cases.
117              
118              
119             =head2 Sound => Str
120              
121             Include this key when you want the system to play a sound. The value of
122             this key is the name of a sound file in your app's main bundle or in
123             the Library/Sounds folder of your app's data container. If the sound
124             file cannot be found, or if you specify defaultfor the value, the
125             system plays the default alert sound.
126              
127              
128             =head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string>
129              
130             Default message substitutions. Can be overridden by individual address
131             substitutions.
132              
133              
134             =head2 ThreadId => Str
135              
136             Provide this key with a string value that represents the app-specific
137             identifier for grouping notifications. If you provide a Notification
138             Content app extension, you can use this value to group your
139             notifications together.
140              
141              
142             =head2 Title => Str
143              
144             The message title that displays above the message on the user's device.
145              
146              
147             =head2 Url => Str
148              
149             The URL to open in the user's mobile browser. Used if the value for
150             Action is URL.
151              
152              
153              
154             =head1 SEE ALSO
155              
156             This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
157              
158             =head1 BUGS and CONTRIBUTIONS
159              
160             The source code is located here: https://github.com/pplu/aws-sdk-perl
161              
162             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
163              
164             =cut
165