File Coverage

blib/lib/Paws/Pinpoint/MessageRequest.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::MessageRequest;
2 1     1   302 use Moose;
  1         2  
  1         6  
3             has Addresses => (is => 'ro', isa => 'Paws::Pinpoint::MapOfAddressConfiguration');
4             has Campaign => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string');
5             has Context => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string');
6             has Endpoints => (is => 'ro', isa => 'Paws::Pinpoint::MapOfEndpointSendConfiguration');
7             has MessageConfiguration => (is => 'ro', isa => 'Paws::Pinpoint::DirectMessageConfiguration');
8             has RequestId => (is => 'ro', isa => 'Str');
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::Pinpoint::MessageRequest
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::Pinpoint::MessageRequest object:
27              
28             $service_obj->Method(Att1 => { Addresses => $value, ..., RequestId => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::Pinpoint::MessageRequest object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->Addresses
36              
37             =head1 DESCRIPTION
38              
39             Send message request.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 Addresses => L<Paws::Pinpoint::MapOfAddressConfiguration>
45              
46             A map of destination addresses, with the address as the key(Email
47             address, phone number or push token) and the Address Configuration as
48             the value.
49              
50              
51             =head2 Campaign => L<Paws::Pinpoint::MapOf__string>
52              
53             The JSON payload used for campaign attributes. This payload is added to
54             the notifications' data-E<gt>pinpoint-E<gt>campaign' object in iOS and
55             flattened to pinpoint.campaign.{AttributeName} keys in Android. Email
56             will use the attribute campaign_id to save the templates.
57              
58              
59             =head2 Context => L<Paws::Pinpoint::MapOf__string>
60              
61             A map of custom attributes to attributes to be attached to the message.
62             This payload is added to the push notification's 'data.pinpoint' object
63             or added to the email/sms delivery receipt event attributes.
64              
65              
66             =head2 Endpoints => L<Paws::Pinpoint::MapOfEndpointSendConfiguration>
67              
68             A map of destination addresses, with the address as the key(Email
69             address, phone number or push token) and the Address Configuration as
70             the value.
71              
72              
73             =head2 MessageConfiguration => L<Paws::Pinpoint::DirectMessageConfiguration>
74              
75             Message configuration.
76              
77              
78             =head2 RequestId => Str
79              
80             Original request Id for which this message is delivered.
81              
82              
83              
84             =head1 SEE ALSO
85              
86             This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint>
87              
88             =head1 BUGS and CONTRIBUTIONS
89              
90             The source code is located here: https://github.com/pplu/aws-sdk-perl
91              
92             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
93              
94             =cut
95