File Coverage

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