File Coverage

blib/lib/Paws/Pinpoint/BaiduMessage.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	sub	time	code
1				package Paws::Pinpoint::BaiduMessage;
2	1	1	859	use Moose;
	1		4
	1		11
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 IconReference => (is => 'ro', isa => 'Str');
7				has ImageIconUrl => (is => 'ro', isa => 'Str');
8				has ImageUrl => (is => 'ro', isa => 'Str');
9				has JsonData => (is => 'ro', isa => 'Str');
10				has RawContent => (is => 'ro', isa => 'Str');
11				has SilentPush => (is => 'ro', isa => 'Bool');
12				has SmallImageIconUrl => (is => 'ro', isa => 'Str');
13				has Sound => (is => 'ro', isa => 'Str');
14				has Substitutions => (is => 'ro', isa => 'Paws::Pinpoint::MapOfListOf__string');
15				has Title => (is => 'ro', isa => 'Str');
16				has Url => (is => 'ro', isa => 'Str');
17				1;
18
19				### main pod documentation begin ###
20
21				=head1 NAME
22
23				Paws::Pinpoint::BaiduMessage
24
25				=head1 USAGE
26
27				This class represents one of two things:
28
29				=head3 Arguments in a call to a service
30
31				Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
32				Each attribute should be used as a named argument in the calls that expect this type of object.
33
34				As an example, if Att1 is expected to be a Paws::Pinpoint::BaiduMessage object:
35
36				$service_obj->Method(Att1 => { Action => $value, ..., Url => $value });
37
38				=head3 Results returned from an API call
39
40				Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::BaiduMessage object:
41
42				$result = $service_obj->Method(...);
43				$result->Att1->Action
44
45				=head1 DESCRIPTION
46
47				Baidu Message.
48
49				=head1 ATTRIBUTES
50
51
52				=head2 Action => Str
53
54				The action that occurs if the user taps a push notification delivered
55				by the campaign: OPEN_APP - Your app launches, or it becomes the
56				foreground app if it has been sent to the background. This is the
57				default action. DEEP_LINK - Uses deep linking features in iOS and
58				Android to open your app and display a designated user interface within
59				the app. URL - The default mobile browser on the user's device launches
60				and opens a web page at the URL you specify. Possible values include:
61				OPEN_APP \| DEEP_LINK \| URL
62
63
64				=head2 Body => Str
65
66				The message body of the notification, the email body or the text
67				message.
68
69
70				=head2 Data => L<Paws::Pinpoint::MapOf__string>
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 IconReference => Str
77
78				The icon image name of the asset saved in your application.
79
80
81				=head2 ImageIconUrl => Str
82
83				The URL that points to an image used as the large icon to the
84				notification content view.
85
86
87				=head2 ImageUrl => Str
88
89				The URL that points to an image used in the push notification.
90
91
92				=head2 JsonData => Str
93
94				The data payload used for a silent push. This payload is added to the
95				notifications' data.pinpoint.jsonBody' object
96
97
98				=head2 RawContent => Str
99
100				The Raw JSON formatted string to be used as the payload. This value
101				overrides the message.
102
103
104				=head2 SilentPush => Bool
105
106				Indicates if the message should display on the users device. Silent
107				pushes can be used for Remote Configuration and Phone Home use cases.
108
109
110				=head2 SmallImageIconUrl => Str
111
112				The URL that points to an image used as the small icon for the
113				notification which will be used to represent the notification in the
114				status bar and content view
115
116
117				=head2 Sound => Str
118
119				Indicates a sound to play when the device receives the notification.
120				Supports default, or the filename of a sound resource bundled in the
121				app. Android sound files must reside in /res/raw/
122
123
124				=head2 Substitutions => L<Paws::Pinpoint::MapOfListOf__string>
125
126				Default message substitutions. Can be overridden by individual address
127				substitutions.
128
129
130				=head2 Title => Str
131
132				The message title that displays above the message on the user's device.
133
134
135				=head2 Url => Str
136
137				The URL to open in the user's mobile browser. Used if the value for
138				Action is URL.
139
140
141
142				=head1 SEE ALSO
143
144				This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
145
146				=head1 BUGS and CONTRIBUTIONS
147
148				The source code is located here: https://github.com/pplu/aws-sdk-perl
149
150				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
151
152				=cut
153