Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
AttachmentRetrievalOption Enum
ActionableNotification Class
ActionableNotification.Builder Class
ActionError Enum
ActionResult Class
ActionResult.Builder Class
CustomNotification Class
Email Class (Base Email Methods)
EmailFileAttachment Class
InboundEmail Class
InboundEmail.AuthenticationResult Class
InboundEmail.AuthenticationResultField 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)
NotificationActionHandler Interface
RenderEmailTemplateBodyResult Class
RenderEmailTemplateError Class
SendEmailError Class
SendEmailResult Class
SingleEmailMessage Class
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

apple(alertBody, actionLocKey, locKey, locArgs, launchImage, sound, badgeCount, userData)

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

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

    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.