| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Pinpoint::Message; | ||
| 3 | use Moose; | ||
| 4 | has Action => (is => 'ro', isa => 'Str'); | ||
| 5 | has Body => (is => 'ro', isa => 'Str'); | ||
| 6 | has ImageIconUrl => (is => 'ro', isa => 'Str'); | ||
| 7 | has ImageSmallIconUrl => (is => 'ro', isa => 'Str'); | ||
| 8 | has ImageUrl => (is => 'ro', isa => 'Str'); | ||
| 9 | has JsonBody => (is => 'ro', isa => 'Str'); | ||
| 10 | has MediaUrl => (is => 'ro', isa => 'Str'); | ||
| 11 | has RawContent => (is => 'ro', isa => 'Str'); | ||
| 12 | has SilentPush => (is => 'ro', isa => 'Bool'); | ||
| 13 | has TimeToLive => (is => 'ro', isa => 'Int'); | ||
| 14 | has Title => (is => 'ro', isa => 'Str'); | ||
| 15 | has Url => (is => 'ro', isa => 'Str'); | ||
| 16 | |||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Pinpoint::Message | ||
| 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::Message 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::Message object: | ||
| 41 | |||
| 42 | $result = $service_obj->Method(...); | ||
| 43 | $result->Att1->Action | ||
| 44 | |||
| 45 | =head1 DESCRIPTION | ||
| 46 | |||
| 47 | Specifies the content and settings for a push notification that's sent | ||
| 48 | to recipients of a campaign. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Action => Str | ||
| 54 | |||
| 55 | The action to occur if a recipient taps the push notification. Valid | ||
| 56 | values are: | ||
| 57 | |||
| 58 | =over | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | OPEN_APP - Your app opens or it becomes the foreground app if it was | ||
| 63 | sent to the background. This is the default action. | ||
| 64 | |||
| 65 | =item * | ||
| 66 | |||
| 67 | DEEP_LINK - Your app opens and displays a designated user interface in | ||
| 68 | the app. This setting uses the deep-linking features of iOS and | ||
| 69 | Android. | ||
| 70 | |||
| 71 | =item * | ||
| 72 | |||
| 73 | URL - The default mobile browser on the recipient's device opens and | ||
| 74 | loads the web page at a URL that you specify. | ||
| 75 | |||
| 76 | =back | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 Body => Str | ||
| 81 | |||
| 82 | The body of the notification message. The maximum number of characters | ||
| 83 | is 200. | ||
| 84 | |||
| 85 | |||
| 86 | =head2 ImageIconUrl => Str | ||
| 87 | |||
| 88 | The URL of the image to display as the push-notification icon, such as | ||
| 89 | the icon for the app. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 ImageSmallIconUrl => Str | ||
| 93 | |||
| 94 | The URL of the image to display as the small, push-notification icon, | ||
| 95 | such as a small version of the icon for the app. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 ImageUrl => Str | ||
| 99 | |||
| 100 | The URL of an image to display in the push notification. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 JsonBody => Str | ||
| 104 | |||
| 105 | The JSON payload to use for a silent push notification. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 MediaUrl => Str | ||
| 109 | |||
| 110 | The URL of the image or video to display in the push notification. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 RawContent => Str | ||
| 114 | |||
| 115 | The raw, JSON-formatted string to use as the payload for the | ||
| 116 | notification message. If specified, this value overrides all other | ||
| 117 | content for the message. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 SilentPush => Bool | ||
| 121 | |||
| 122 | Specifies whether the notification is a silent push notification, which | ||
| 123 | is a push notification that doesn't display on a recipient's device. | ||
| 124 | Silent push notifications can be used for cases such as updating an | ||
| 125 | app's configuration, displaying messages in an in-app message center, | ||
| 126 | or supporting phone home functionality. | ||
| 127 | |||
| 128 | |||
| 129 | =head2 TimeToLive => Int | ||
| 130 | |||
| 131 | The number of seconds that the push-notification service should keep | ||
| 132 | the message, if the service is unable to deliver the notification the | ||
| 133 | first time. This value is converted to an expiration value when it's | ||
| 134 | sent to a push-notification service. If this value is 0, the service | ||
| 135 | treats the notification as if it expires immediately and the service | ||
| 136 | doesn't store or try to deliver the notification again. | ||
| 137 | |||
| 138 | This value doesn't apply to messages that are sent through the Amazon | ||
| 139 | Device Messaging (ADM) service. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 Title => Str | ||
| 143 | |||
| 144 | The title to display above the notification message on a recipient's | ||
| 145 | device. | ||
| 146 | |||
| 147 | |||
| 148 | =head2 Url => Str | ||
| 149 | |||
| 150 | The URL to open in a recipient's default mobile browser, if a recipient | ||
| 151 | taps the push notification and the value of the Action property is URL. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head1 SEE ALSO | ||
| 156 | |||
| 157 | This class forms part of L<Paws>, describing an object used in L<Paws::Pinpoint> | ||
| 158 | |||
| 159 | =head1 BUGS and CONTRIBUTIONS | ||
| 160 | |||
| 161 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 162 | |||
| 163 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 164 | |||
| 165 | =cut | ||
| 166 |