apns-php
|
The Push Notification Custom Message. More...
Public Member Functions | |
string | getActionLocKey () |
Get the "View" button title. More... | |
string | getLaunchImage () |
Get the filename of an image file in the application bundle. More... | |
string | getLocArgs () |
Get the variable string values to appear in place of the format specifiers in loc-key. More... | |
string | getLocKey () |
Get the alert-message string in Localizable.strings file. More... | |
void | setActionLocKey (string $sActionLocKey= '') |
Set the "View" button title. More... | |
void | setLaunchImage (string $sLaunchImage) |
Set the filename of an image file in the application bundle; it may include the extension or omit it. More... | |
void | setLocArgs (array $aLocArgs) |
Set the variable string values to appear in place of the format specifiers in loc-key. More... | |
void | setLocKey (string $sLocKey) |
Set the alert-message string in Localizable.strings file for the current localization (which is set by the user’s language preference). More... | |
Protected Member Functions | |
array | _getPayload () |
Get the payload dictionary. More... | |
Protected Attributes | |
array | $_aLocArgs |
Variable string values to appear in place of the format specifiers in loc-key. More... | |
string | $_sActionLocKey |
The "View" button title. More... | |
string | $_sLaunchImage |
The filename of an image file in the application bundle. More... | |
string | $_sLocKey |
A key to an alert-message string in a Localizable.strings file. More... | |
Additional Inherited Members |
The Push Notification Custom Message.
The class represents a custom message to be delivered to an end user device. Please refer to Table 3-2 for more information.
Definition at line 29 of file Custom.php.
|
protected |
Get the payload dictionary.
Definition at line 141 of file Custom.php.
References $_aLocArgs.
string getActionLocKey | ( | ) |
Get the "View" button title.
Definition at line 58 of file Custom.php.
References $_sActionLocKey.
string getLaunchImage | ( | ) |
Get the filename of an image file in the application bundle.
Definition at line 131 of file Custom.php.
References $_sLaunchImage.
string getLocArgs | ( | ) |
Get the variable string values to appear in place of the format specifiers in loc-key.
Definition at line 104 of file Custom.php.
References $_aLocArgs.
string getLocKey | ( | ) |
Get the alert-message string in Localizable.strings file.
Definition at line 82 of file Custom.php.
References $_sLocKey.
void setActionLocKey | ( | string | $sActionLocKey = '' | ) |
Set the "View" button title.
If a string is specified, displays an alert with two buttons. iOS uses the string as a key to get a localized string in the current localization to use for the right button’s title instead of "View". If the value is an empty string, the system displays an alert with a single OK button that simply dismisses the alert when tapped.
$sActionLocKey | [optional] The "View" button title, default empty string. |
Definition at line 48 of file Custom.php.
void setLaunchImage | ( | string | $sLaunchImage | ) |
Set the filename of an image file in the application bundle; it may include the extension or omit it.
The image is used as the launch image when users tap the action button or move the action slider. If this property is not specified, the system either uses the previous snapshot, uses the image identified by the UILaunchImageFile key in the application’s Info.plist file, or falls back to Default.png. This property was added in iOS 4.0.
$sLaunchImage | The filename of an image file. |
Definition at line 121 of file Custom.php.
void setLocArgs | ( | array | $aLocArgs | ) |
Set the variable string values to appear in place of the format specifiers in loc-key.
$aLocArgs | The variable string values. |
Definition at line 93 of file Custom.php.
void setLocKey | ( | string | $sLocKey | ) |
Set the alert-message string in Localizable.strings file for the current localization (which is set by the user’s language preference).
The key string can be formatted with %@ and n$@ specifiers to take the variables specified in loc-args.
$sLocKey | The alert-message string. |
Definition at line 72 of file Custom.php.
|
protected |
Variable string values to appear in place of the format specifiers in loc-key.
Definition at line 33 of file Custom.php.
Referenced by _getPayload(), and getLocArgs().
|
protected |
|
protected |
The filename of an image file in the application bundle.
Definition at line 34 of file Custom.php.
Referenced by getLaunchImage().
|
protected |
A key to an alert-message string in a Localizable.strings file.
Definition at line 32 of file Custom.php.
Referenced by getLocKey().