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