Salesforce Mobile Notifications Implementation Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
apple(alertBody, actionLocKey, locKey, locArgs, launchImage, sound, badgeCount, userData)
Signature
public static Map<String,Object> apple(String alertBody, String actionLocKey, String locKey, String[] locArgs, String launchImage, String sound, Integer badgeCount, Map<String,Object> userData)
Parameters
-
alertBody:
Type: String
Text of the alert message.
-
actionLocKey:
Type: String
If a value is specified for the actionLocKey argument, an alert with two buttons is displayed. The value is a key to get a localized string in a Localizable.strings file to use for the right button’s title.
-
locKey:
Type: String
Key to an alert-message string in a Localizable.strings file for the current localization.
-
locArgs:
Type: List<String>
Variable string values to appear in place of the format specifiers in locKey.
-
launchImage:
Type: String
File name of an image file in the application bundle.
-
sound:
Type: String
Name of a sound file to be played as an alert. This sound file should be in the mobile application bundle.
-
badgeCount:
Type: Integer
-
userData:
Type: Map<String, Object>
Map of key-value pairs that contains any additional data used to provide context for the notification. For example, it can contain IDs of the records that caused the notification to be sent. The mobile client app can use these IDs to display these records.
Return Value
Type: Map<String, Object>
Returns a formatted payload that includes all of the specified arguments.