« blib/lib/Paws/Pinpoint/PushMessageActivity.pm
↑ Summary
blib/lib/Paws/Pinpoint/PushNotificationTemplateResponse.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::PushNotificationTemplateRequest; | ||
| 3 | use Moose; | ||
| 4 | has ADM => (is => 'ro', isa => 'Paws::Pinpoint::AndroidPushNotificationTemplate'); | ||
| 5 | has APNS => (is => 'ro', isa => 'Paws::Pinpoint::APNSPushNotificationTemplate'); | ||
| 6 | has Baidu => (is => 'ro', isa => 'Paws::Pinpoint::AndroidPushNotificationTemplate'); | ||
| 7 | has Default => (is => 'ro', isa => 'Paws::Pinpoint::DefaultPushNotificationTemplate'); | ||
| 8 | has DefaultSubstitutions => (is => 'ro', isa => 'Str'); | ||
| 9 | has GCM => (is => 'ro', isa => 'Paws::Pinpoint::AndroidPushNotificationTemplate'); | ||
| 10 | has RecommenderId => (is => 'ro', isa => 'Str'); | ||
| 11 | has Tags => (is => 'ro', isa => 'Paws::Pinpoint::MapOf__string', request_name => 'tags', traits => ['NameInRequest']); | ||
| 12 | has TemplateDescription => (is => 'ro', isa => 'Str'); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::Pinpoint::PushNotificationTemplateRequest | ||
| 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::PushNotificationTemplateRequest object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { ADM => $value, ..., TemplateDescription => $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::PushNotificationTemplateRequest object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->ADM | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Specifies the content and settings for a message template that can be | ||
| 45 | used in messages that are sent through a push notification channel. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 ADM => L<Paws::Pinpoint::AndroidPushNotificationTemplate> | ||
| 51 | |||
| 52 | The message template to use for the ADM (Amazon Device Messaging) | ||
| 53 | channel. This message template overrides the default template for push | ||
| 54 | notification channels (DefaultPushNotificationTemplate). | ||
| 55 | |||
| 56 | |||
| 57 | =head2 APNS => L<Paws::Pinpoint::APNSPushNotificationTemplate> | ||
| 58 | |||
| 59 | The message template to use for the APNs (Apple Push Notification | ||
| 60 | service) channel. This message template overrides the default template | ||
| 61 | for push notification channels (DefaultPushNotificationTemplate). | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Baidu => L<Paws::Pinpoint::AndroidPushNotificationTemplate> | ||
| 65 | |||
| 66 | The message template to use for the Baidu (Baidu Cloud Push) channel. | ||
| 67 | This message template overrides the default template for push | ||
| 68 | notification channels (DefaultPushNotificationTemplate). | ||
| 69 | |||
| 70 | |||
| 71 | =head2 Default => L<Paws::Pinpoint::DefaultPushNotificationTemplate> | ||
| 72 | |||
| 73 | The default message template to use for push notification channels. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 DefaultSubstitutions => Str | ||
| 77 | |||
| 78 | A JSON object that specifies the default values to use for message | ||
| 79 | variables in the message template. This object is a set of key-value | ||
| 80 | pairs. Each key defines a message variable in the template. The | ||
| 81 | corresponding value defines the default value for that variable. When | ||
| 82 | you create a message that's based on the template, you can override | ||
| 83 | these defaults with message-specific and address-specific variables and | ||
| 84 | values. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 GCM => L<Paws::Pinpoint::AndroidPushNotificationTemplate> | ||
| 88 | |||
| 89 | The message template to use for the GCM channel, which is used to send | ||
| 90 | notifications through the Firebase Cloud Messaging (FCM), formerly | ||
| 91 | Google Cloud Messaging (GCM), service. This message template overrides | ||
| 92 | the default template for push notification channels | ||
| 93 | (DefaultPushNotificationTemplate). | ||
| 94 | |||
| 95 | |||
| 96 | =head2 RecommenderId => Str | ||
| 97 | |||
| 98 | The unique identifier for the recommender model to use for the message | ||
| 99 | template. Amazon Pinpoint uses this value to determine how to retrieve | ||
| 100 | and process data from a recommender model when it sends messages that | ||
| 101 | use the template, if the template contains message variables for | ||
| 102 | recommendation data. | ||
| 103 | |||
| 104 | |||
| 105 | =head2 Tags => L<Paws::Pinpoint::MapOf__string> | ||
| 106 | |||
| 107 | A string-to-string map of key-value pairs that defines the tags to | ||
| 108 | associate with the message template. Each tag consists of a required | ||
| 109 | tag key and an associated tag value. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 TemplateDescription => Str | ||
| 113 | |||
| 114 | A custom description of the message template. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | =head1 SEE ALSO | ||
| 119 | |||
| 120 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 121 | |||
| 122 | =head1 BUGS and CONTRIBUTIONS | ||
| 123 | |||
| 124 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 125 | |||
| 126 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 127 | |||
| 128 | =cut | ||
| 129 |