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