ExtlClntAppNotificationSettings

Represents an external client app’s notification subscriptions for mobile.

The ExtlClntAppNotificationSettings 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 ExtlClntAppNotificationSettings 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 

ExtlClntAppNotificationSettings components have the suffix .ecaNotifications and are stored in the extlClntAppNotifSettings folder.

Version 

Introduced in API version 64.0.

Special Access Rules 

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

Fields 

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 notification settings configuration.

notificationTypes 

• Type: ExtlClntAppNotificationType[]
• Required: No
• Description: A list of notification types the external client app is subscribed to. Only notifications of these types are returned to the associated external client app via API or sent as push notifications.

ExtlClntAppNotificationType Type 

Represents a notification type that an external client app is subscribed to. Only custom notification types enabled for the mobile delivery channel are supported.

You can use Notification Builder in Setup to configure a notification type for the mobile delivery channel. See Manage Notification Delivery Settings in Salesforce Help.

Note

You can use Notification Builder in Setup to configure a notification type for the mobile delivery channel. See Manage Notification Delivery Settings in Salesforce Help.

Note

Fields 

notificationType 

• Type: string
• Required: Yes
• Description: Required. The API name of the notification type.

pushByDefault 

• Type: boolean

• Required: No

• Description: Required. Indicates whether the notification type is sent as a push notification on mobile devices.

  To send a notification type as a push notification, you must also configure the ExtlClntAppPushSettings metadata type.