Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
ExtlClntAppPushSettings (Beta)
Parent Type
File Suffix and Directory Location
ExtlClntAppPushSettings components have the suffix .ecaPush and are stored in the extlClntAppPushSettings folder.
Version
ExtlClntAppPushSettings components are available in API version 64.0 and later.
Special Access Rules
There are no additional access requirements that are specific to this type.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| androidPushConfig | ExtlClntAppAndroidPushConfig | Represents the push notification configuration of an Android mobile app. |
| applePushConfig | ExtlClntAppApplePushConfig | Represents the push notification configuration of an iOS mobile app. |
| externalClientApplication | string | Required. The name of the associated external client app. |
| label | string | Label for the external client app’s push notifications configuration. |
| pushConfigLink | string | 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 | PushServiceType (enumeration of type string) | Required. Identifies the mobile operating system of the mobile app. Valid values are:
|
ExtlClntAppAndroidPushConfig
Represents the push notification configuration of an Android mobile app.
| Field Name | Field Type | Description |
|---|---|---|
| fcmProject | string | Required. The ID of the Google Firebase project associated with the mobile app. |
| serviceAccount | string | 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
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.
| Field Name | Field Type | Description |
|---|---|---|
| applicationBundle | string | The bundle ID of the iOS mobile app from Apple App Store Connect. |
| certificate | string | 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 | ApplePushEnvironmentType (enumeration of type string) | Required. The Apple Push Notification service environment. Valid
values are:
|
| keyIdentifier | string | The key identifier for the private key entered in the signingKey field. See Get a key identifier in Apple Developer documentation. |
| password | string | The password for the TLS certificate entered in the certificate field. |
| signingKey | string | 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 | string | The team ID listed in the membership details of the Apple Developer account associated with the iOS mobile app. |