MobileSettings

Represents an organization’s mobile settings.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See Settings for details.

This type extends Metadata and inherits its fields.

MobileSettings values are stored in a single file named Mobile.settings in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.

Mobile settings are available in API version 27.0 and later.

• Type: ChatterMobileSettings
• Required: No
• Version: Removed in API version 46.0.
• Description: The settings for devices running Chatter mobile.

• Type: DashboardMobileSettings
• Required: No
• Description: Deprecated. The settings for devices running the mobile dashboards app.

• Type: boolean
• Required: No
• Introduced: API version 47.0
• Description: Indicates whether users can import contacts from their mobile device (true) or not (false).

• Type: boolean
• Required: No
• Version: Removed in API version 48.0.
• Description: Indicates whether the org is enabled for the Salesforce mobile app. Available in API version 47.0 only.

• Type: boolean
• Required: No
• Version: Removed in API version 56.0.
• Description: Indicates whether the org is enabled for the Salesforce mobile app tablet experience.

• Type: boolean
• Required: No
• Version: Available in API version 52.0 through 55.0.

Removed in API version 56.0.

• Description: Indicates whether the org is enabled for the Salesforce mobile app widescreen tablet experience.

• Type: boolean
• Required: No
• Introduced: API version 47.0
• Description: Indicates whether users can create, edit, and delete records while offline in the Salesforce mobile app (true) or not (false). The default value is true. This option isn’t available if enableS1OfflinePref is set to false.

• Type: boolean
• Required: No
• Introduced: API version 47.0
• Description: Indicates whether the user’s name is shown on the Today page in the Salesforce mobile app (true) or not (false). The default value is false.

• Type: boolean
• Required: No
• Introduced: API version 47.0
• Description: Indicates whether the Salesforce mobile web uses secure and persistent browser caching to improve performance (true) or not (false). The default value is true.

• Type: boolean

• Required: No

• Introduced: API version 47.0

• Description: Indicates whether users can access records offline in the Salesforce mobile app (true) or not (false). This option is set to true the first time someone in your org installs one of the Salesforce downloadable apps.

  However, offline access isn’t supported in all versions of the downloadable mobile apps. Users must have version 10.0 or later of the Salesforce for Android app or the Salesforce for iOS app. Offline access isn’t available for the Salesforce mobile web.

• Type: TouchMobileSettings
• Required: No
• Version: Removed in API version 46.0.
• Description: The settings for devices running Salesforce Touch.

These fields are removed in API version 46.0. Represents your organization’s Chatter Mobile settings.

• Type: boolean
• Required: No
• Description: Indicates whether Android devices are enabled for Chatter Mobile (true) or not (false).

• Type: boolean
• Required: No
• Description: Indicates whether Blackberry devices are enabled for Chatter Mobile (true) or not (false).

• Type: boolean

• Required: No

• Description: Indicates whether Chatter Mobile has been enabled for your organization (true) or not (false).

  Setting this field to true enables you to set all the other ChatterMobile settings. If you change this setting from true to false, and also try to change any of the other ChatterMobile settings, your deployment fails with an error.

• Type: boolean
• Required: No
• Description: Indicates whether Chatter push notifications have been enabled for your organization (true) or not (false)

• Type: boolean
• Required: No
• Description: Indicates whether iPad devices are enabled for Chatter Mobile (true) or not (false).

• Type: boolean
• Required: No
• Description: Indicates whether iPhone devices are enabled for Chatter Mobile (true) or not (false).

• Type: MobileSessionTimeout (enumeration of type string)
• Required: No
• Description: The length of time after which users without activity are prompted to log out or continue working.
• Possible values:
  • Never
  • OneMinute
  • FiveMinutes
  • TenMinutes
  • ThirtyMinutes

These fields are deprecated. Represents your organization’s Mobile Dashboards iPad app settings.

• Type: boolean
• Required: No
• Description: Indicates whether Mobile Dashboards iPad app has been enabled for your organization (true) or not (false).

These fields are removed in API version 46.0. Salesforce Touch has been upgraded to the Salesforce mobile app.

• Type: boolean
• Required: No
• Description: Indicates whether your organization has the Salesforce Touch downloadable app enabled (true) or not (false)

• Type: boolean
• Required: No
• Description: Indicates whether your organization has the Salesforce Touch mobile browser app enabled (true) or not (false).

Here’s a sample mobile.settings metadata file.

1<?xml version="1.0" encoding="UTF-8"?>
2<MobileSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <enableImportContactFromDevice>true</enableImportContactFromDevice>
4    <enableOfflineDraftsEnabled>true</enableOfflineDraftsEnabled>
5    <enableS1EncryptedStoragePref2>true</enableS1EncryptedStoragePref2>
6    <enableS1OfflinePref>true</enableS1OfflinePref>
7</MobileSettings>

The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.