all
all
Select all, to do a broadcast.
Used in both audience and deviceTypes.
absoluteDate( $resolution, $start, $end) : array
Produces a time specifier that represents an absolute amount of time, such as from 2012-01-01 12:00 to 2012-01-01 12:00
| $resolution | string Valid time resolution |
|
| $start | string Beginning of absolute window |
|
| $end | string End of absolute window |
amazon( $alert = null, $consolidation_key = null, $expires_after = null, $title = null, $summary = null, $extra = null, $style = null, $sound = null) : array
Amazon specific platform override payload.
| $alert | string: Amazon format alert. |
|
| $consolidation_key | string: Similar to GCM’s collapse_key. |
|
| $expires_after | int: An integer value indicating the number of seconds that ADM will retain the message if the device is offline. The valid range is 60 - 2678400 (1 minute to 31 days), inclusive. Can also be an absolute ISO UTC timestamp, in which case the same validation rules apply, with the time period calculated relative to the time of the API call. |
|
| $title | string: Title of the notification. |
|
| $summary | string: Summary of the notification. |
|
| $extra | array: A set of key/value pairs to include in the push payload sent to the device. |
|
| $style | array: Android/Amazon advanced styles. |
|
| $sound | string: A sound file name included in the application’s resources. |
android( $alert = null, $collapseKey = null, $timeToLive = null, $deliveryPriority = null, $delayWhileIdle = null, $extra = null, $style = null, $title = null, $summary = null, $sound = null, $priority = null, $category = null, $visibility = null, $publicNotification = null, $localOnly = false, $wearable = null) : array
Android specific platform override payload.
| $alert | string: Android format alert. |
|
| $collapseKey | string |
|
| $timeToLive | int|string: Specifies the expiration time for the message. |
|
| $deliveryPriority | string: Defaults to normal if not provided. Sets the GCM priority. |
|
| $delayWhileIdle | boolen |
|
| $extra | array: A set of key/value pairs to include in the push payload sent to the device. |
|
| $style | array: Android/Amazon advanced styles. |
|
| $title | string: Title of the notification. |
|
| $summary | string: Summary of the notification. |
|
| $sound | string: A sound file name included in the application’s resources. |
|
| $priority | int: In the range from -2 to 2, inclusive. Used to help determine notification sort order. |
|
| $category | string: Optional string from the following list: "alarm", "call", "email", "err", "event", "msg", "promo", "recommendation", "service", "social", "status", "sys", and "transport". It is used to help determine notification sort order. |
|
| $visibility | int: Optional integer in the range from -1 to 1 inclusive. |
|
| $publicNotification | Object: A notification to show on the lock screen instead of the redacted one. |
|
| $localOnly | ||
| $wearable | Object |
ios( $alert = null, $badge = null, $sound = null, $contentAvailable = false, $extra = null, $expiry = null, $priority = null, $category = null, $interactive = null, $mutableContent = false, $mediaAttachment = null, $title = null, $subtitle = null, $collapseId = null) : array
iOS/APNS specific platform override payload.
| $alert | string|array: iOS format alert. |
|
| $badge | int|string: An integer badge value or an autobadge string. |
|
| $sound | string: A sound file to play. |
|
| $contentAvailable | bool: If true, pass on the content_available command for Newsstand iOS applications. |
|
| $extra | array: A set of key/value pairs to include in the push payload sent to the device. |
|
| $expiry | int|string: The expiry time for APNS to cease trying to deliver a push. |
|
| $priority | int: Sets the APNS priority of the delivery. |
|
| $category | string: Sets the APNs category for the push. |
|
| $interactive | Object: Conforms to the standard interactive object specifications. |
|
| $mutableContent | boolean: When set to true, content may be modified by an extension. |
|
| $mediaAttachment | JSON: Specifies a media attachment to be handled by the UA Media Attachment Extension. |
|
| $title | string: Sets the title of the notification. |
|
| $subtitle | string: Displays below the title of the notification. |
|
| $collapseId |
for invalid values.
location( $date, array $locationOpts) : array
Select a location expression.
Location expressions are made up of either an id or an alias and a time period specifier. Use one of the date specifier functions to return a properly formatted time specifier
| $date | A date range specifier, created by either |
|
| array | $locationOpts | An array containing either id and value, or an
alias and value, e.g. |
message( $title, $body, $content_type = null, $content_encoding = null, $expiry = null, $extra = null, $icons = null) : array
Message Center Object
| $title | string |
|
| $body | string |
|
| $content_type | string: A string denoting the MIME type of the data in body. |
|
| $content_encoding | string: A string denoting encoding type of the data in body. For example, utf-8 or base64. |
|
| $expiry | int|timestamp: The expiry time for a rich app page to delete a message from the user’s inbox. Can be an integer encoding number of seconds from now, or an absolute timestamp in ISO UTC format. An integer value of 0 is equivalent to no expiry set. |
|
| $extra | string: A JSON dictionary of string values. Values for each entry may only be strings. If an API user wishes to pass structured data in an extra key, it must be properly JSON-encoded as a string. |
|
| $icons | string: JSON dictionary of string key and value pairs.
At this time, only one key, |
notification( $alert, $overrides = array()) : array
Creates a notification payload.
| $alert | string Global alert for all device types. Use null for no alert. |
|
| $overrides | array Optional array of platform overrides. |
If result payload is empty.
recentDate( $resolution, $lengthOfTime) : array
Produces a time specifier that represents relative amount of time, such as "the past three days"
| $resolution | string Valid time resolution, e.g. |
|
| $lengthOfTime | string Amount of time |
If the resolution is not recognized