File Coverage

blib/lib/Paws/Pinpoint/DefaultPushNotificationMessage.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::DefaultPushNotificationMessage;
2 1     1   424 use Moose;
  1         3  
  1         6  
3             has Action => (is => 'ro', isa => 'Str');
4             has Body => (is => 'ro', isa => 'Str');
5             has Data => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string');
6             has SilentPush => (is => 'ro', isa => 'Bool');
7             has Substitutions => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string');
8             has Title => (is => 'ro', isa => 'Str');
9             has Url => (is => 'ro', isa => 'Str');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::Pinpoint::DefaultPushNotificationMessage
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::Pinpoint::DefaultPushNotificationMessage object:
28              
29             $service_obj->Method(Att1 => { Action => $value, ..., Url => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::DefaultPushNotificationMessage object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->Action
37              
38             =head1 DESCRIPTION
39              
40             Default Push Notification Message.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 Action => Str
46              
47             The action that occurs if the user taps a push notification delivered
48             by the campaign: OPEN_APP - Your app launches, or it becomes the
49             foreground app if it has been sent to the background. This is the
50             default action. DEEP_LINK - Uses deep linking features in iOS and
51             Android to open your app and display a designated user interface within
52             the app. URL - The default mobile browser on the user's device launches
53             and opens a web page at the URL you specify. Possible values include:
54             OPEN_APP | DEEP_LINK | URL
55              
56              
57             =head2 Body => Str
58              
59             The message body of the notification, the email body or the text
60             message.
61              
62              
63             =head2 Data => L<Paws::Pinpoint::MapOf__string>
64              
65             The data payload used for a silent push. This payload is added to the
66             notifications' data.pinpoint.jsonBody' object
67              
68              
69             =head2 SilentPush => Bool
70              
71             Indicates if the message should display on the users device. Silent
72             pushes can be used for Remote Configuration and Phone Home use cases.
73              
74              
75             =head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string>
76              
77             Default message substitutions. Can be overridden by individual address
78             substitutions.
79              
80              
81             =head2 Title => Str
82              
83             The message title that displays above the message on the user's device.
84              
85              
86             =head2 Url => Str
87              
88             The URL to open in the user's mobile browser. Used if the value for
89             Action is URL.
90              
91              
92              
93             =head1 SEE ALSO
94              
95             This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
96              
97             =head1 BUGS and CONTRIBUTIONS
98              
99             The source code is located here: https://github.com/pplu/aws-sdk-perl
100              
101             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
102              
103             =cut
104