ExtlClntAppPushSettings

Represents an external client app’s push notification settings.

The ExtlClntAppPushSettings metadata type is a pilot or beta service that is subject to the Beta Services Terms at Agreements - Salesforce.com or a written Unified Pilot Agreement if executed by Customer, and applicable terms in the Product Terms Directory. Use of this pilot or beta service is at the Customer’s sole discretion.

The ExtlClntAppPushSettings metadata type requires the OAuth plugin for External Client Apps. See OAuth Plugin Enablement with Metadata API in Salesforce Help.

Note

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

ExtlClntAppPushSettings components have the suffix .ecaPush and are stored in the extlClntAppPushSettings folder.

Version 

Introduced in API version 64.0.

Special Access Rules 

There are no additional access requirements that are specific to this type.

Fields 

androidPushConfig 

• Type: ExtlClntAppAndroidPushConfig
• Required: No
• Description: Represents the push notification configuration of an Android mobile app.

applePushConfig 

• Type: ExtlClntAppApplePushConfig
• Required: No
• Description: Represents the push notification configuration of an iOS mobile app.

externalClientApplication 

• Type: string
• Required: Yes
• Description: Required. The name of the associated external client app.

label 

• Type: string
• Required: No
• Description: Label for the external client app’s push notifications configuration.

pushConfigLink 

• Type: string

• Required: No

• Description: Identifies the push notification credentials used by the app. Valid format is the org ID (for example, 00D000000000001) and an ExtlClntAppApplePushConfig or ExtlClntAppAndroidPushConfig record ID (for example, 1Dh000000000001) separated by a colon. For example: 00D000000000001:1Dh000000000001

  If you configure pushConfigLink, you can’t also have androidPushConfig or applePushConfig in the same record.

pushServiceType 

• Type: PushServiceType (enumeration of type string)

• Required: Yes

• Description: Required. Identifies the mobile operating system of the mobile app. Valid values are:

  • Apple
  • Android

ExtlClntAppAndroidPushConfig Type 

Represents the push notification configuration of an Android mobile app.

Fields 

fcmProject 

• Type: string
• Required: Yes
• Description: Required. The ID of the Google Firebase project associated with the mobile app.

serviceAccount 

• Type: string

• Required: Yes

• Description: Required. The Base64-encoded Admin SDK private key for your Google Firebase service account. You can generate this key from the Service accounts tab in the Google Firebase console.

  The maximum length of the string is 8000 characters.

ExtlClntAppApplePushConfig Type 

Represents the push notification configuration of an iOS mobile app. To configure the required authentication for iOS push notifications, you submit either a private key (.p8 file) or a TLS certificate (.p12 file).

To configure push notifications with a private key (.p8 file), complete the signingKey, keyIdentifier, and teamIdentifier fields.

To configure push notifications with a TLS certificate (.p12 file), complete the certificate and password fields.

Fields 

applicationBundle 

• Type: string
• Required: No
• Description: The bundle ID of the iOS mobile app from Apple App Store Connect.

certificate 

• Type: string
• Required: No
• Description: The Base64-encoded TLS certificate with Apple Push Notification service (APNs) enabled. To generate and export this certificate, see Communicate with APNs using a TLS certificate in Apple Developer documentation.

environment 

• Type: ApplePushEnvironmentType (enumeration of type string)

• Required: Yes

• Description: Required. The Apple Push Notification service environment. Valid values are:

  • Production
  • Sandbox

keyIdentifier 

• Type: string
• Required: No
• Description: The key identifier for the private key entered in the signingKey field. See Get a key identifier in Apple Developer documentation.

password 

• Type: string
• Required: No
• Description: The password for the TLS certificate entered in the certificate field.

signingKey 

• Type: string
• Required: No
• Description: The Base64-encoded private key with Apple Push Notification service (APNs) enabled. To generate and download this key, see Create a private key to access a service in Apple Developer documentation.

teamIdentifier 

• Type: string
• Required: No
• Description: The team ID listed in the membership details of the Apple Developer account associated with the iOS mobile app.