Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
AttachmentRetrievalOption Enum
Email Class (Base Email Methods)
EmailFileAttachment Class
InboundEmail Class
InboundEmail.BinaryAttachment Class
InboundEmail.TextAttachment Class
InboundEmailResult Class
InboundEnvelope Class
MassEmailMessage Class
InboundEmail.Header Class
PushNotification Class
PushNotificationPayload Class
PushNotificationPayload Methods
apple(alert, sound, badgeCount, userData)
apple(alertBody, actionLocKey, locKey, locArgs, launchImage, sound, badgeCount, userData)
RenderEmailTemplateBodyResult Class
RenderEmailTemplateError Class
SendEmailError Class
SendEmailResult Class
SingleEmailMessage Methods
Metadata Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

apple(alert, sound, badgeCount, userData)

Helper method that creates a valid Apple payload from the specified arguments.

Signature

public static Map<String,Object> apple(String alert, String sound, Integer badgeCount, Map<String,Object> userData)

Parameters

alert
Type: String
Notification message to be sent to the mobile client.
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

Number to display as the badge of the application icon.

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.

Usage

To generate a valid payload, you must provide a value for at least one of the following parameters: alert, sound, badgeCount.

Example

See the Push Notification Example.