MobileCRM._Settings - Resconet/JSBridge GitHub Wiki
MobileCRM._Settings Object
Internal object representing the application settings.
Properties
| Property | Type | Description |
|---|---|---|
| absoluteUrl | String | Gets the absolute URL (including the CrmOrganization). |
| activityListInitialEntity | String | Gets or sets the last active entity in the ActivityList. |
| applicationLock | Number | Gets or sets the application lock state (0=None, 1=Soft, 2=Permanent). |
| appointmentViewMode | Number | Gets or sets the last active view mode in Calendar view. |
| authenticationType | Number | Gets or sets the CRM server authentication method (0=ActiveDirectory, 1=CRM Online, 2=Internet facing., 3=CRM Online EMEA, 4=CRM Online APAC). |
| autoSync | Number | Gets or sets when the application starts to sync on the background (0=Never, 1=OnStart, 2=OnChange, 3=OnStartAndChange). |
| autoSyncAfterChange | Number | Gets the number of seconds to wait before syncing after data change. Negative to disable. |
| autoSyncAfterChangeOnline | Number | Gets the number of seconds to wait before syncing after data change in online mode. 0 or negative to disable, default is 1. |
| autoSyncDelay | Number | Gets or sets the automatic sync delay in seconds. |
| autoSyncAfterStart | Number | Gets the number of seconds to wait before syncing after application start. Negative to disable. |
| canUsePassword | Boolean | Indicates whether there is a valid password and whether it can be used. |
| clientCertificateThumbprint | String | Gets or sets the thumbprint of client certificate which should be used for client authentication. |
| clientCustomize | Boolean | Gets or sets whether entities can be disabled on the client. |
| createCallEntity | Boolean | Gets or sets whether to create the call entity after a call has been made from MobileCRM. |
| crm2011AuthUrl | String | Gets or sets the discovered CRM service authentication server url. |
| crm2011AuthType | String | Gets or sets the discovered CRM service authentication type. |
| crmOrganization | String | Gets or sets the CRM organization (Absolute path in org url). |
| crmWebServiceVersion | Number | Gets or sets the discovered CRM service version (4 or 5). |
| crmWebServiceMinorVersion | Number | Gets or sets the the discovered CRM service minor version (13 - for CRM 2011 Rollup 13 and up). |
| currencyDecimalPrecision | Number | Gets or sets the organization Pricing Decimal Precision configuration option (0..4). |
| currencyDisplayOption | Number | Gets or sets the currency field display option 0- Symbol ($), 1 - Code (USD). |
| customizationDirectory | String | Gets or sets the customization directory. |
| databaseLocale | String | Gets or sets the database local language (for case-insensitive and language dependent compare). E.g. "en-US". |
| databaseSchemaHash | String | Gets or sets the database schema hash. |
| density (Android only) | Number | Gets or sets the application Density (120=Low, 160=Medium, 240=High, 320=ExtraHigh, 480=ExtraExtraHigh). |
| deviceFriendlyName | String | Gets or sets the device friendly name (Steve's iPhone). |
| deviceIdentifier | String | Gets or sets the hardware unique id. |
| deviceInfo | String | Gets or sets the device system an hw information (OS, etc.) |
| deviceName | String | Gets or sets the device name (Base64 encoded "InternalDeviceId"). |
| disabledEntities | Boolean | Gets the names of the disabled entities. Use for limited runtime customization. |
| domain | String | Gets or sets the user domain. |
| emailSignature | String | Gets or sets the email signature. |
| enableCallImport (Android, Windows Mobile) | Boolean | Enables the Call Import form (appears on the Home form) |
| enableDashboard | Boolean | Enables the Dashboard form (appears on the Home form). |
| enableMap | Boolean | Enables the Map form (appears on the Home form). |
| enableListButtons | Boolean | Enables list buttons. Default is true. |
| forcedFullSyncDate | Date | Gets or sets the date when the device must be full synced. If the last sync was before this date, the next sync must be full. |
| forgetPassword | Boolean | Prevents remembered password to be used for next login. |
| fullNameConventionCode | Number | Gets or sets the option for generating the entity full name (contact, lead) e.g. how to combine the first, middle and last name (0="L,F", 1="F L", 2="L,F m", 3="F m L", 4="L,F M", 5="F M L", 6="L F", 7="LF"). |
| hasSyncErrors | Boolean | Gets or sets whether there were any synchronization errors encountered. |
| hasTaskReminder (Android, iOS, Windows Phone) | Boolean | Gets or sets whether reminders should be scheduled for tasks. |
| homeRealm | String | Gets or sets the URL of the authentication server (ADFS) in case of multi domain deployment. |
| ignoreCertificateErrors | Boolean | Gets or sets whether to ignore HTTPS certificate errors. (Should be used for evaluation and DEBUG only!) |
| invalidLoginCount | Number | Gets or sets the invalid login count. |
| internalDeviceId | String | Gets or sets the device id (GUID). |
| isDarkTheme (WP7 only) | Boolean | Gets or sets the UI theme (Dark or Light). |
| isDemoDatabase | Boolean | Gets or sets whether the current database contains demo data and should not be synced. |
| isCrmOnline | Boolean | Gets whether the login is for a CRM Online instance. |
| isValid | Boolean | Gets whether the login information is valid and complete. Indicates whether the user name and password are non-empty. Whether they are correct is up to the we service. Also checks whether the web service url is non-empty. |
| language | String | Gets or sets the UI text language. |
| lastProcessedCallTime (Android, Windows Mobile) | Date | Gets or sets the time of the last processed call history entry. |
| lastServerContact | Date | Gets or sets the time of the last server contact (either sync or security policy). |
| lastSyncDate | Date | Gets or sets the last synchronization end date. |
| lastUserInteraction | Date | Gets or sets the last user interaction time. |
| legacyPassword | String | Gets or sets the synchronization service password. |
| lockReason | String | Gets or sets the reason of the application lock. |
| loginTimeout | Number | Gets or sets the time in seconds after which the password expires and application login is required. |
| maxAttachmentSize | Number | Gets or sets the maximum attachment size to sync (in KB). |
| maxSyncCount | Number | Gets or sets the maximum number of records (per entity) to download. |
| multiThreadSync | Boolean | Gets or sets whether to use multi-threaded synchronization. Default true. |
| onlineMode | Number | Gets or sets when and how the application is switched to online mode (0=Always, 1=WifiOnly, 2=Manual, 3=Never). |
| organization | String | Gets or sets the organization name. Obsolete, only for compatibility. |
| organizationId | String | Gets or sets the current user's organization GUID (given by the server). |
| password | String | [BLOCKED] Gets or sets the synchronization service password. |
| passwordHash | String | Gets or sets the password hash. |
| phoneApplication | String | Gets or sets the URL scheme of application used for making calls. |
| pushId (Android, iOS) | String | Gets or sets the push id used for push notification send to this device. |
| readonlySettings | Array | Gets the list of read-only settings. |
| requireSyncLogin | Boolean | Gets or sets whether the user must login at sync start. |
| savePassword | Boolean | Gets or sets whether to store the encrypted password in the config file. |
| saveSignatureAsImage | Boolean | Gets or sets whether to store signature attachments as SVG (vector) or PNG (image). |
| secRulesHash | Number | Gets or sets the hash code of the last downloaded security policy (zero for no policy). |
| serverHostName | String | Gets the CRM server host name. |
| serverSettingsVersion | String | Gets or sets the version of the settings file as send with the customization. |
| serverVersion | Number | Gets or sets the server version, either 4 for CRM 4.0 or 5 for CRM 2011. |
| syncCount | Number | Gets or sets the number of incremental synchronizations performed so far. |
| incSyncUsesVersionNumberSorting | Boolean | Gets or sets whether incremental sync fetches use "order by versionnumber" wherever possible. Since 10.2, default true. |
| syncEmailAsText | Boolean | Gets or sets whether to convert email to text during sync. Since 6.4, default false. |
| syncFilterHash | String | Gets or sets the sync filter file hash code. |
| systemUserId | String | Gets or sets the current user GUID (given by the server). |
| tourplanInitialEntity | String | Gets or sets the last active entity in the Tourplan (Calendar). |
| updateObjectTypeCodes | Boolean | Gets or sets whether to update entity objectypecodes on first sync. |
| useCrmEmail | Boolean | Gets or sets whether to create a CRM email entity or use the platform email service. |
| useDatabaseBlobStore | Boolean | Gets or sets whether to store attachment blobs in database or in files. If you change this setting you must perform a full sync! |
| useDatabaseEncryption | Boolean | Gets or sets whether the database is encrypted. Only used when the database is created (full sync). Default true. |
| userDefaultCurrencyId | String | Gets or sets the user's default currency GUID. If not set use the organization default. |
| userLogin | String | Gets or sets the full user name (domain slash name). |
| userName | String | Gets or sets the user name. |
| useRowVersionChangeTracking | Boolean | Gets or sets whether to use RowVersion or ModifiedOn based sync. Default is true. |
| url | String | Gets or sets the web service URL used for synchronization. |
| verifyServerCertificate | Boolean | Gets or sets whether to verify server SSL certificate. Since 6.3, default false (don't verify SSL). |