php-apn
  • Function
  • Examples
  • Download

Functions

  • apn_add_token
  • apn_add_tokens
  • apn_close
  • apn_connect
  • apn_feedback
  • apn_feedback_connect
  • apn_free
  • apn_init
  • apn_payload_add_token
  • apn_payload_add_tokens
  • apn_payload_free
  • apn_payload_init
  • apn_payload_set_array
  • apn_payload_set_badge
  • apn_payload_set_body
  • apn_payload_set_expiry
  • apn_payload_set_launch_image
  • apn_payload_set_localized_action_key
  • apn_payload_set_localized_key
  • apn_payload_set_sound
  • apn_send
  • apn_set_array
  • apn_set_certificate
  • apn_set_mode
  • apn_set_private_key

Function apn_payload_set_array

Set multiple payload properties

Valid properties are:

  • badge - number to display as a badge on the application icon
  • sound - name of a sound file in the application bundle
  • body - text of an alert message
  • localized_key - key used to get a localized alert-message string
  • localized_key_args - array of strings to appear in place of the format specifiers in key
  • localized_action_key - key used to get a localized string for the right button’s caption instead of "View"
  • launch_image - filename of an image file in the application bundle
  • tokens - array of device tokens
  • expiry - expiration time of notification
Category: Apple Push Notification Payload
License: PHP 3.01
Located at documentation.php

Parameters summary

resource $payload Apple Push Notification Resource returned by apn_payload_init(). If a non-resource is used for the apn, an error of level E_WARNING will be emitted
array $properties An associative array specifying which payload properties to set and their values

Return value summary

boolean Returns TRUE on success or FALSE on failure
php-apn API documentation generated by ApiGen 3.0dev