Metadata API Developer’s Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

MobileSettings

Represents an organization’s mobile settings, such as mobile Chatter settings, whether Mobile Lite is enabled for an organization, and so on. For more information, see “Managing Salesforce Classic Devices” and “Chatter Mobile for BlackBerry Overview” in the Salesforce online help.

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

Declarative Metadata File Suffix and Directory Location

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 is only one settings file for each settings component.

MobileSettings is no longer available in API versions 25.0 and 26.0.

Note

Version

Mobile settings are available in API version 27.0 and later.

Fields

Field Field Type Description
chatterMobile ChatterMobileSettings The settings for Chatter mobile devices.
dashboardMobile DashboardMobileSettings The settings for dashboards on mobile devices.
salesforceMobile SFDCMobileSettings The settings for general users on mobile devices.
touchMobile (Deprecated) TouchMobileSettings The settings for touch on mobile devices.

ChatterMobileSettings

Represents your organization’s Chatter Mobile settings.

Field Field Type Description
IPadAuthorized boolean Indicates whether iPad devices are enabled for Chatter Mobile (true) or not (false).
IPhoneAuthorized boolean Indicates whether iPhone devices are enabled for Chatter Mobile (true) or not (false).
androidAuthorized boolean Indicates whether Android devices are enabled for Chatter Mobile (true) or not (false).
blackBerryAuthorized boolean Indicates whether Blackberry devices are enabled for Chatter Mobile (true) or not (false).
enableChatterMobile boolean Indicates whether Chatter Mobile has been enabled for your organization (true) or not (false).

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

Note
enablePushNotifications boolean Indicates whether Chatter push notifications have been enabled for your organization (true) or not (false)
sessionTimeout MobileSessionTimeout (enumeration of type string)
The length of time after which users without activity are prompted to log out or continue working. Valid values are:
  • Never
  • OneMinute
  • FiveMinutes
  • TenMinutes
  • ThirtyMinutes

DashboardMobileSettings

Represents your organization’s Mobile Dashboards iPad app settings.

Field Field Type Description
enableDashboardIPadApp boolean Indicates whether Mobile Dashboards iPad app has been enabled for your organization (true) or not (false)

SFDCMobileSettings

Represents your organization’s general mobile settings.

Field Field Type Description
enableUserToDeviceLinking boolean Permanently link users to their mobile devices. Set this option to true only if you want to prevent your users from switching devices without administrative intervention..
enableMobileLite boolean Indicates whether your organization has Mobile Lite enabled (true) or not (false).

TouchMobileSettings

These fields are deprecated. Salesforce Touch has been upgraded to the Salesforce1 app.

Field Field Type Description
enableTouchBrowserIPad boolean Indicates whether your organization has the Salesforce Touch mobile browser app enabled (true) or not (false).
enableTouchAppIPad boolean Indicates whether your organization has the Salesforce Touch downloadable app enabled (true) or not (false)

Declarative Metadata Sample Definition

This is a sample mobile.settings metadata file.

1swfobject.registerObject("clippy.codeblock-0", "9");<?xml version="1.0" encoding="UTF-8"?>
2<MobileSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3    <chatterMobile>
4        <IPadAuthorized>true</IPadAuthorized>
5        <IPhoneAuthorized>true</IPhoneAuthorized>
6        <androidAuthorized>true</androidAuthorized>
7        <blackBerryAuthorized>true</blackBerryAuthorized>
8        <enableChatterMobile>true</enableChatterMobile>
9        <enablePushNotifications>true</enablePushNotifications>
10        <sessionTimeout>Never</sessionTimeout>
11    </chatterMobile>
12    <dashboardMobile>
13        <enableDashboardIPadApp>true</enableDashboardIPadApp>
14    </dashboardMobile>
15    <salesforceMobile>
16        <enableUserToDeviceLinking>false</enableUserToDeviceLinking>
17        <enableMobileLite>false</enableMobileLite>
18    </salesforceMobile>
19    <touchMobile>
20        <enableTouchBrowserIPad>false</enableTouchBrowserIPad>
21        <enableTouchAppIPad>true</enableTouchAppIPad>
22    </touchMobile>
23</MobileSettings>