afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/MobileSettings.json

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "sub_types",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "MobileSettings - Metadata API",
  "description": "Represents an organization’s mobile settings. This type extends the Metadata metadata type and inherits its fullName field.",
  "file_information": ".settings",
  "directory_location": "settings",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "chatterMobile": {
      "type": "ChatterMobileSettings",
      "description": "The settings for devices running Chatter mobile. Removed in API version 46.0."
    },
    "dashboardMobile": {
      "type": "DashboardMobileSettings",
      "description": "The settings for devices running the mobile dashboards app."
    },
    "enableImportContactFromDevice": {
      "type": "boolean",
      "description": "Indicates whether users can import contacts from their mobile device (true) or not (false). Available in API version 47.0 and later."
    },
    "enableLightningOnMobile": {
      "type": "boolean",
      "description": "Indicates whether the org is enabled for the Salesforce mobile app. Available in API version 47.0 only. Removed in API version 48.0."
    },
    "enableNewSalesforceMobileAppForTablet": {
      "type": "boolean",
      "description": "Indicates whether the org is enabled for the Salesforce mobile app tablet experience. Removed in API version 56.0."
    },
    "enableNewSalesforceMobileAppForTabletWideScreen": {
      "type": "boolean",
      "description": "Indicates whether the org is enabled for the Salesforce mobile app widescreen tablet experience. Available in API version 52.0 through 55.0. Removed in API version 56.0."
    },
    "enableOfflineDraftsEnabled": {
      "type": "boolean",
      "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. Available in API version 47.0 and later."
    },
    "enablePopulateNameManuallyInToday": {
      "type": "boolean",
      "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. Available in API version 47.0 and later."
    },
    "enableS1EncryptedStoragePref2": {
      "type": "boolean",
      "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. Available in API version 47.0 and later."
    },
    "enableS1OfflinePref": {
      "type": "boolean",
      "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. Available in API version 47.0 and later. 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."
    },
    "touchMobile": {
      "type": "TouchMobileSettings",
      "description": "The settings for devices running Salesforce Touch. Removed in API version 46.0."
    }
  },
  "sub_types": {
    "ChatterMobileSettings": {
      "IPadAuthorized": {
        "type": "boolean",
        "description": "Indicates whether iPad devices are enabled for Chatter Mobile (true) or not (false)."
      },
      "IPhoneAuthorized": {
        "type": "boolean",
        "description": "Indicates whether iPhone devices are enabled for Chatter Mobile (true) or not (false)."
      },
      "androidAuthorized": {
        "type": "boolean",
        "description": "Indicates whether Android devices are enabled for Chatter Mobile (true) or not (false)."
      },
      "blackBerryAuthorized": {
        "type": "boolean",
        "description": "Indicates whether Blackberry devices are enabled for Chatter Mobile (true) or not (false)."
      },
      "enableChatterMobile": {
        "type": "boolean",
        "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."
      },
      "enablePushNotifications": {
        "type": "boolean",
        "description": "Indicates whether Chatter push notifications have been enabled for your organization (true) or not (false)"
      },
      "sessionTimeout": {
        "type": "MobileSessionTimeout (enumeration of type string)",
        "description": "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": {
      "enableDashboardIPadApp": {
        "type": "boolean",
        "description": "Indicates whether Mobile Dashboards iPad app has been enabled for your organization (true) or not (false)."
      }
    },
    "TouchMobileSettings": {
      "enableTouchBrowserIPad": {
        "type": "boolean",
        "description": "Indicates whether your organization has the Salesforce Touch mobile browser app enabled (true) or not (false)."
      },
      "enableTouchAppIPad": {
        "type": "boolean",
        "description": "Indicates whether your organization has the Salesforce Touch downloadable app enabled (true) or not (false)"
      }
    }
  },
  "wsdl_segment": "```xml\n<xsd:complexType name=\"DashboardMobileSettings\">\n  <xsd:sequence>\n    <xsd:element name=\"enableDashboardIPadApp\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"MobileSettings\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"dashboardMobile\" minOccurs=\"0\" type=\"tns:DashboardMobileSettings\"/>\n        <xsd:element name=\"enableImportContactFromDevice\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableOfflineDraftsEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enablePopulateNameManuallyInToday\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableS1EncryptedStoragePref2\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n        <xsd:element name=\"enableS1OfflinePref\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "Here’s a sample mobile.settings metadata file.",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<MobileSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <enableImportContactFromDevice>true</enableImportContactFromDevice>\n    <enableOfflineDraftsEnabled>true</enableOfflineDraftsEnabled>\n    <enableS1EncryptedStoragePref2>true</enableS1EncryptedStoragePref2>\n    <enableS1OfflinePref>true</enableS1OfflinePref>\n</MobileSettings>"
    }
  ]
}