Javascript Bridge Reference

MobileCRM Namespace

The MobileCRM namespace encapsulates all the functionality of the Resco MobileCRM Javascript Bridge (later JSBridge).

Namespaces

Namespace	Description
FetchXml	Contains a set of objects implementing the FetchXML request methods
UI	Contains a set of objects implementing the Javascript equivalent of the MobileCRM application UI components. These objects are not available under Essential license.
UI.DetailViewItems	Contains a set of objects representing particular detail view items.
Services	Contains non-UI classes for accessing documents...
Services.Workflow	Contains objects accessing the Dynamics 365 workflow.

Properties

Property	Description
bridge	Singleton instance of MobileCRM.Bridge providing the management of the Javascript / native code cross-calls.

Objects

Object	Description
AboutInfo	[v8.2] Represents the branding information.
ActivityParty	Person or group associated with an activity. An activity can have multiple activity parties.
Application	Encapsulates the application-related functionality.
Bridge	Provides the management of the Javascript/native code cross-calls. Its only instance MobileCRM.bridge is created immediately after the "JSBridge.js" script is loaded.
Configuration	Provides an access to the application configuration.
CultureInfo	[v10.2] Provides information about current device culture. The information includes the names for the culture, the writing system, the calendar used, and formatting for dates.
DateTimeFormat	[v10.2] Provides culture-specific information about the format of date and time values.
DynamicEntity	Represents a CRM entity, with only a subset of properties loaded.
GlobalConstants	Provides access to the global constants.
Localization	A static object with functions allowing to access the localized texts.
ManyToManyReference	A static object with functions managing many to many relations.
MetaEntity	Represents an entity metadata.
MetaProperty	Represents a property (CRM field) metadata.
Metadata	A static object with functions for accessing the entity metadata store.
MobileReport	Provides a functionality of mobile reporting.
NumberFormat	[v10.2] Provides culture-specific information for formatting and parsing numeric values.
OAuthSettings	[v12.4] Represents the settings what are used to authenticate using OAuth server account.
ObservableObject	Represents a generic object which is monitoring the changes of its properties.
Platform	Represents object for querying platform specific information and executing platform integrated actions.
Questionnaire	Provides a functionality for questionnaires.
Reference	Represents an entity reference which provides the minimum information about an entity.
Relationship	Represents a relationship between two entities.
_DeviceInfo	Represents the device information.
_Settings	Internal object representing the application settings.

MobileCRM.AboutInfo Object

[v8.2] Represents the branding information.

Properties

Property	Type	Description
manufacturer	String	Gets the manufacturer text.
productTitle	String	Gets the product title text.
productTitleAndVersion	String	[v9.0] Gets the string with product title and version.
productSubTitle	String	Gets the product subtitle text.
poweredBy	String	Gets the powered by text.
icon	String	Gets the icon name.
website	String	Gets the website url.
supportEmail	String	Gets the support email.

Functions

Function	Description
requestObject	[v8.2] Asynchronously gets the AboutInfo object with branding information.

MobileCRM.AboutInfo.requestObject Function

[v8.2] Asynchronously gets the AboutInfo object with branding information.

Arguments

Argument	Type	Description
callback	function(Object)	The callback function that is called asynchronously with the about info object.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.

MobileCRM.ActivityParty Object

Person or group associated with an activity. An activity can have multiple activity parties.

Properties

Property	Type	Description
entityName	String	The entity name of the party (account, contact, lead, systemuser, etc.)
id	String	GUID of the existing entity or null for new one or direct party.
primaryName	String	The human readable name of the reference, e.g. "Alexandro".
isDirectParty	Boolean	Gets or sets whether the party is direct (email) or a pointer to an CRM record.
addressUsed	String	Gets or sets the actual address used.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.ActivityParty object.

MobileCRM.ActivityParty.constructor Method

Constructs an instance of MobileCRM.ActivityParty object.

Arguments

Argument	Type	Description
entityName	String	The logical entity name of the party (account, contact, lead, systemuser, etc.)
id	String	GUID of the existing entity or null for new one or direct party.
primaryName	String	The human readable name of the reference, e.g "Alexandro".
isDirectParty	Boolean	Gets or sets whether the party is direct (email) or a pointer to an CRM record.
addressUsed	String	Gets or sets the actual address used.

MobileCRM.Application Object

Encapsulates the application-related functionality.

Functions

Function	Description
checkUserRoles	Checks whether the current user is member of the passed roles. Role can be either the Guid (aeb33d0f-89b4-e111-9c9a-00155d0b710a) or the role Name.
createDirectory	Asynchronously creates the directory in the application local data.
createDirectoryAsync	Asynchronously creates the directory in the application local data.
deleteDirectory	Asynchronously deletes the empty directory from the application local data.
deleteDirectoryAsync	Asynchronously deletes the empty directory from the application local data.
deleteFile	Asynchronously deletes the file from the application local data.
deleteFileAsync	Asynchronously deletes the file from the application local data.
directoryExists	Checks whether the directory with given path exists in the application local data.
directoryExistsAsync	Checks whether the directory with given path exists in the application local data.
fileExists	Checks whether the file with given path exists in application local data.
fileExistsAsync	Checks whether the file with given path exists in application local data.
getAccessToken	[v12.3]Asynchronously gets the access token for the specified resource URL (limited to Microsoft environment without MSAL).
getAppColor	Gets the customized color by its name.
getAppImage	Gets the colorized application image. It is taken either from customization package or from application bundle.
getDirectories	Asynchronously gets the list of directories from the application local data.
getDirectoriesAsync	Asynchronously gets the list of directories from the application local data.
getFiles	Asynchronously gets the list of files from the application local data.
getFilesAsync	Asynchronously gets the list of files from the application local data.
getLastSignificantTimeChange	[v13.3.1] Gets the last detected time change.
moveFile	Asynchronously moves the application local file to another location.
moveFileAsync	Asynchronously moves the application local file to another location.
onSyncFinished	[v8.1] Binds the new handler to the synchronization finish event.
readFile	Reads the file from the application local data and asynchronously gets its content.
readFileAsBase64	Reads the file from the application local data and asynchronously gets its base64-encoded content.
readFileAsync	[v15.3] Reads the file from the application local data and asynchronously gets its content.
setAppColors	[v11.2] Sets the application colors.
showAppLogin	Causes that the password is forgotten and user is required to type it again to make the app running.
showSetup	Closes all forms and shows the setup screen.
startSmartSync
synchronize	Starts background/foreground sync if not synchronized or the last sync was before desired limit.
synchronizeOnForeground	[v8.1] Starts the synchronization on foreground (closes all form if possible and showing the standard progress).
writeFile	Asynchronously writes the text into the file from the application local data.
writeFileAsync	[v15.3] Asynchronously writes data into the file from the application local data.
writeFileFromBase64	Asynchronously writes the base64-encoded data into the application local storage file.
writeFileWithEncoding	[v9.0.2] Asynchronously writes the text into the file from the application local data.

MobileCRM.Application.checkUserRoles Function

Checks whether the current user is member of the passed roles. Role can be either the Guid (aeb33d0f-89b4-e111-9c9a-00155d0b710a) or the role Name.

Arguments

Argument	Type	Description
roles	Array(String)	Defines the roles to check.
success	function(result)	A callback function for successful asynchronous result. The result will carry a number with the count of matching roles.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.createDirectory Function

Asynchronously creates the directory in the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the directory in the application local data.
success	function(result)	A callback function which is called in case of successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.createDirectoryAsync Function

Asynchronously creates the directory in the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the directory in the application local data.

MobileCRM.Application.deleteDirectory Function

Asynchronously deletes the empty directory from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the directory in the application local data.
success	function(result)	A callback function which is called in case of successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.deleteDirectoryAsync Function

Asynchronously deletes the empty directory from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the directory in the application local data.

MobileCRM.Application.deleteFile Function

Asynchronously deletes the file from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file in the application local data.
success	function(result)	A callback function which is called in case of successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.deleteFileAsync Function

Asynchronously deletes the file from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file in the application local data.

MobileCRM.Application.directoryExists Function

Checks whether the directory with given path exists in the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the directory located in the application local data.
success	function(result)	A callback function for successful asynchronous result. The result will carry a Boolean object determining whether the directory exists or not.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.directoryExistsAsync Function

Checks whether the directory with given path exists in the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the directory located in the application local data.

MobileCRM.Application.fileExists Function

Checks whether the file with given path exists in application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file located in the application local data.
success	function(result)	A callback function for successful asynchronous result. The result will carry a Boolean object determining whether the file exists or not.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.fileExistsAsync Function

Checks whether the file with given path exists in application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file located in the application local data.

MobileCRM.Application.getAccessToken Function

[v12.3]Asynchronously gets the access token for the specified resource URL (limited to Microsoft environment without MSAL).

Arguments

Argument	Type	Description
resourceUrl	String	The resource.
successCallback	function(textAccessToken)	A callback function what is called asynchronously with serialized access token as argument.
failureCallback	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.getAppColor Function

Gets the customized color by its name.

Arguments

Argument	Type	Description
colName	String	Defines the color name. Must be one of these: TitleBackground, TitleForeground, ListBackground, ListForeground, ListSelBackground, ListSelForeground, ListSeparator, SearchBackground, SearchForeground, SearchSelForeground, FormBackground, FormItemBackground, FormItemForeground, FormItemLabelForeground, FormItemDisabled, FormItemLink, TabBackground, TabForeground, TabSelForeground.
success	function(result)	A callback function for successful asynchronous result. The result will carry a String object with color in CSS format (e.g. "#FF0000" for red color).
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.getAppImage Function

Gets the colorized application image. It is taken either from customization package or from application bundle.

Arguments

Argument	Type	Description
imageName	String	Defines the image name (e.g. "Buttons.Call.png").
colorize	String	If the image supports colorization, this value defines the colorization color. It can be either integer with RGB value or the application color name as defined in MobileCRM.Application.getAppColor. Leave null if no colorization is desired.
success	function(result)	A callback function for successful asynchronous result. The result will carry a String object with "data:" URL containing base64-encoded colorized application image.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.getDirectories Function

Asynchronously gets the list of directories from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the Directory in the application local data.
success	function(result)	A callback function which carry the array of directories names.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.getDirectoriesAsync Function

Asynchronously gets the list of directories from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the Directory in the application local data.

MobileCRM.Application.getFiles Function

Asynchronously gets the list of files from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the Directory in the application local data.
success	function(result)	A callback function which carry the array of files names in the directory.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.getFilesAsync Function

Asynchronously gets the list of files from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the Directory in the application local data.

MobileCRM.Application.getLastSignificantTimeChange Function

[v13.3.1] Gets the last detected time change.

Arguments

Argument	Type	Description
success	function()	A callback function which is called in case of success. Callback will receive an object with "lastChange" date and "delta" time in sceonds.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.moveFile Function

Asynchronously moves the application local file to another location.

Arguments

Argument	Type	Description
src	String	Defines the relative path of the source file in the application local data.
dst	String	Defines the relative path of the destination file in the application local data.
success	function(result)	A callback function which is called in case of successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.moveFileAsync Function

Asynchronously moves the application local file to another location.

Arguments

Argument	Type	Description
src	String	Defines the relative path of the source file in the application local data.
dst	String	Defines the relative path of the destination file in the application local data.

MobileCRM.Application.onSyncFinished Function

[v8.1] Binds the new handler to the synchronization finish event.

Arguments

Argument	Type	Description
handler	function(homeForm)	A function which will be called when the synchronization finished event occurs with current instance of the MobileCRM.UI.HomeForm as parameter.
scope	Object	A scope in which the handler should be called.

MobileCRM.Application.readFile Function

Reads the file from the application local data and asynchronously gets its content.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file in the application local data.
success	function(result)	A callback function for successful asynchronous result. The result will carry a String object with the file content.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.readFileAsBase64 Function

Reads the file from the application local data and asynchronously gets its base64-encoded content.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file in the application local data.
success	function(result)	A callback function for successful asynchronous result. The result will carry a string with the base64-encoded file content.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.readFileAsync Function

[v15.3] Reads the file from the application local data and asynchronously gets its content.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file in the application local data.
encoding	String	Defines the text encoding for file content (default is UTF8). Use base64 for binary files. Supported values: UTF8, UTF16 ASCII, BASE64.

MobileCRM.Application.setAppColors Function

[v11.2] Sets the application colors.

Arguments

Argument	Type	Description
colors	object	Properties of the object define the colors to set. The values must be int in the AARRGGBB format.
success	function(result)	A callback function for successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.showAppLogin Function

Causes that the password is forgotten and user is required to type it again to make the app running.

MobileCRM.Application.showSetup Function

Closes all forms and shows the setup screen.

MobileCRM.Application.startSmartSync Function

Arguments

Argument	Type	Description
smartSyncName	String	The name of SmartSync configuration as defined in Woodford.

Return value

Type: Promise

A Promise resolved when the SmartSync was initiated.

MobileCRM.Application.synchronize Function

Starts background/foreground sync if not synchronized or the last sync was before desired limit.

Arguments

Argument	Type	Description
backgroundOnly	Boolean	if true, only the background sync is allowed; otherwise it can also run the foreground sync.
ifNotSyncedBefore	Date	Defines a time limit required for the last sync. Starts the sync only if wasn"t done yet or if it was before this limit. If it is null or undefined, sync is done always.

MobileCRM.Application.synchronizeOnForeground Function

[v8.1] Starts the synchronization on foreground (closes all form if possible and showing the standard progress).

Foreground sync must be done to download the new customization or to display the sync conflicts.

Arguments

Argument	Type	Description
forceLogin	Boolean	if true, the sync dialog with URL and credentials will be opened; otherwise it is opened only if the password is not saved.

MobileCRM.Application.writeFile Function

Asynchronously writes the text into the file from the application local data.

File content is encoded using UTF-8 encoding.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file in the application local data.
text	String	Defines the file content to be written.
append	Boolean	Determines whether to overwrite or append to an existing file..
success	function(result)	A callback function which is called in case of successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.writeFileAsync Function

[v15.3] Asynchronously writes data into the file from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file in the application local data.
text	String	Defines the file content (in corresponding text encoding) to be written.
encoding	String	Defines the text encoding for file content data. Use base64 for binary files. Supported values: UTF8, ASCII, BASE64.

MobileCRM.Application.writeFileFromBase64 Function

Asynchronously writes the base64-encoded data into the application local storage file.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file in the application local data.
base64	String	A string containing the base64-encoded file content.
success	function()	A callback function which is called in case of success.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Application.writeFileWithEncoding Function

[v9.0.2] Asynchronously writes the text into the file from the application local data.

Arguments

Argument	Type	Description
path	String	Defines the relative path of the file in the application local data.
text	String	Defines the file content to be written.
encoding	String	Defines the text encoding for file content (default is UTF-8). Use "ASCII" for ANSI text or "UTF-16" for multi-byte Unicode.
append	Boolean	Determines whether to overwrite or append to an existing file.
success	function(result)	A callback function which is called in case of successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Bridge Object

Provides the management of the Javascript/native code cross-calls. Its only instance MobileCRM.bridge is created immediately after the "JSBridge.js" script is loaded.

Properties

Property	Type	Description
platform	String	A string identifying the device platform (e.g. Android, iOS, Windows, WindowsRT, Windows10 or WindowsPhone).
version	Number	A number identifying the version of the JSBridge. This is the version of the script which might not match the version of the application part of the bridge implementation. Application version must be equal or higher than the script version.

Methods

Method	Description
alert	Shows a message asynchronously and calls the callback after it is closed by user.
closeForm	Closes a form containing this HTML document.
enableDebug	Enables platform-specific features for debugging the web page.
enableZoom	Enables platform-specific pinch zoom gesture.
getWindowSize	[v8.0] Returns the size of the window in logical pixels without any scaling and viewport calculations..
invokeMethodPromise	Invokes a method on exposed managed object asynchronously as a Promise.
invokeStaticMethodPromise	Invokes a static method on specified type asynchronously as a Promise.
log	[v8.0] Appends a message into the JSBridge log.
onGlobalEvent	[v9.0] Binds or unbinds the handler for global event.
raiseGlobalEvent	[v9.0] Raises the global event which can have listeners bound by other iFrames.

MobileCRM.Bridge.alert Method

Shows a message asynchronously and calls the callback after it is closed by user.

Arguments

Argument	Type	Description
callback	function(obj)	The callback function that is called asynchronously.
scope	Object	The scope for callbacks.

MobileCRM.Bridge.closeForm Method

Closes a form containing this HTML document.

MobileCRM.Bridge.enableDebug Method

Enables platform-specific features for debugging the web page.

After calling this method, it is possible to attach the Google Chrome debugger into the web page opened in MobileCRM application running on Android (KitKat or newer).

This method also activates the Javascript warnings in Windows 7 app.

It has dummy implementation on iOS and Android debug build.

Arguments

Argument	Type	Description
callback	function(obj)	The callback function that is called asynchronously.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Bridge.enableZoom Method

Enables platform-specific pinch zoom gesture.

After calling this method, it is possible to use the pinch gesture to control the content zoom. This functionality is implemented only on Android. Other platforms either do not support zoom or it is controlled by the HTML viewport meta tag.

Arguments

Argument	Type	Description
enable	Boolean	Indicates whether to enable or disable zooming support.

MobileCRM.Bridge.getWindowSize Method

[v8.0] Returns the size of the window in logical pixels without any scaling and viewport calculations..

Arguments

Argument	Type	Description
callback	function(obj)	The callback function that is called asynchronously. Gets an object with the window "width" and "height".
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Bridge.invokeCommandPromise Method

MobileCRM.Bridge.invokeMethodPromise Method

Invokes a method on exposed managed object asynchronously as a Promise.

Arguments

Argument	Type	Description
objectName	String	The name of exposed managed object as it was registered on C# side (IJavascriptBridge.ExposeObject).
method	String	The name of the method implemented by object class.
paramsList	Array	An array with parameters that should be passed to a method.

Return value

Type: Promise<any>

A Promise object which will be resolved with JSON-serialized return value. It is either generic type or MobileCRM.ObservableObject with JSON-serialized return value..

MobileCRM.Bridge.invokeStaticMethodPromise Method

Invokes a static method on specified type asynchronously as a Promise.

Arguments

Argument	Type	Description
assembly	String	The name of the assembly which defines the type.
typeName	String	The full name of the C# type which implements the method.
method	String	The name of static method to be invoked.
paramsList	Array	An array with parameters that should be passed to a method.

Return value

Type: Promise<any>

A Promise object which will be resolved with JSON-serialized return value. It is either generic type or MobileCRM.ObservableObject with JSON-serialized return value..

MobileCRM.Bridge.log Method

[v8.0] Appends a message into the JSBridge log.

Arguments

Argument	Type	Description
text	String	A text to be written into the log.

MobileCRM.Bridge.onGlobalEvent Method

[v9.0] Binds or unbinds the handler for global event.

This methods binds or unbinds a handler which is called when this or other iFrame raises the specified event by calling the MobileCRM.bridge.raiseGlobalEvent method.

It can also bind a handler for pre-defined events EntityFormClosed, IFrameFormClosed, SyncStarted and SyncFinished.

Arguments

Argument	Type	Description
eventName	String	Global event name.
handler	function(args)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.Bridge.raiseGlobalEvent Method

[v9.0] Raises the global event which can have listeners bound by other iFrames.

Arguments

Argument	Type	Description
eventName	String	Global event name.
args	Object	Any object that has to be passed to all event listeners. This object is stringified JSON and passed to another iFrame listening on the global event.

MobileCRM.Configuration Object

Provides an access to the application configuration.

This object cannot be created directly. To obtain/modify this object, use MobileCRM.Configuration.requestObject function.

Properties

Property	Type	Description
applicationEdition	String	Gets the application edition.
applicationPath	String	Gets the application folder.
applicationVersion	String	Gets the application version (major.minor.subversion.build).
customizationDirectory	String	Gets or sets the runtime customization config root.
externalConfiguration	String	Gets the external configuration directory (either customization or legacy configuration).
isBackgroundSync	Boolean	Gets or sets whether background synchronization is in progress.
isOnline	Boolean	Gets or sets whether the online mode is currently active.
legacyVersion	String	Gets or sets the legacy redirect folder.
licenseAlert	String	Gets the flag set during sync indicating that the user's license has expired.
projectVersion	String	Gets customer-defined project version.
settings	MobileCRM._Settings	Gets the application settings.
storageDirectory	String	Gets the root folder of the application storage.

Functions

Function	Description
requestObject	Requests the managed Configuration object.

MobileCRM.Configuration.requestObject Function

Requests the managed Configuration object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of Configuration object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(config)	The callback function that is called asynchronously with MobileCRM.Configuration object instance as argument. Callback should return true to apply changed properties.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.CultureInfo Object

[v10.2] Provides information about current device culture. The information includes the names for the culture, the writing system, the calendar used, and formatting for dates.

Properties

Property	Type	Description
name	String	Gets the culture name in the format languageCode/region (e.g. "en-US"). languageCode is a lowercase two-letter code derived from ISO 639-1. regioncode is derived from ISO 3166 and usually consists of two uppercase letters.
displayName	String	Gets the full localized culture name.
nativeName	String	Gets the culture name, consisting of the language, the country/region, and the optional script, that the culture is set to display.
localization	String	Gets selected localization language.
ISOName	String	Gets the ISO 639-1 two-letter code for the language of the current CultureInfo.
isRightToLeft	Boolean	Gets a value indicating whether the current CultureInfo object represents a writing system where text flows from right to left.
dateTimeFormat	MobileCRM.DateTimeFormat	Gets a DateTimeFormat that defines the culturally appropriate format of displaying dates and times.
numberFormat	MobileCRM.NumberFormat	Gets a NumberFormat that defines the culturally appropriate format of displaying numbers, currency, and percentage.

Functions

Function	Description
formatDate	[v10.2] Returns the formatted date/time string that matches current device culture.
fullDateTimeString	[v10.2] Returns the date and time string that matches current device culture.
initialize	[v10.2] Initializes the CultureInfo object.
initializeAsync	[v10.2] Initializes the CultureInfo object.
load	[v10.2] Asynchronously gets the CultureInfo object for specified language/country.
loadAsync	[v10.2] Asynchronously gets the CultureInfo object for specified language/country.
longDateString	[v10.2] Returns the long date string that matches current device culture.
longTimeString	[v10.2] Returns the long time string that matches current device culture.
monthDayString	[v10.2] Returns the month and day string that matches current device culture.
shortDateString	[v10.2] Returns the short date string that matches current device culture.
shortTimeString	[v10.2] Returns the short time string that matches current device culture.
yearMonthString	[v10.2] Returns the year and month string that matches current device culture.

MobileCRM.CultureInfo.formatDate Function

[v10.2] Returns the formatted date/time string that matches current device culture.

This method fails if CultureInfo.initialize method hasn't completed yet.

Arguments

Argument	Type	Description
date	Date	A date being formatted.
format	String	Custom format string that meets the MSDN Sepcification.

MobileCRM.CultureInfo.fullDateTimeString Function

[v10.2] Returns the date and time string that matches current device culture.

This method fails if CultureInfo.initialize method hasn't completed yet.

Arguments

Argument	Type	Description
date	Date	A date being formatted.

MobileCRM.CultureInfo.initialize Function

[v10.2] Initializes the CultureInfo object.

Method loads the current culture information asynchronously and calls either the errorCallback with error message or the callback with initialized CultureInfo object.

All other functions will return the default or empty string before the initialization finishes.

Arguments

Argument	Type	Description
callback	function(currentCulture)	The callback function that is called asynchronously with initialized CultureInfo object as argument.
errorCallback	function(errorMsg)	The errorCallback which is to be called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.CultureInfo.initializeAsync Function

[v10.2] Initializes the CultureInfo object.

Method loads the current culture information asynchronously.

All other functions will return the default or empty string before the initialization promise is resolved.

Return value

Type: Promise<MobileCRM.CultureInfo>

A Promise object which will be resolved with the loaded CultureInfo object.

MobileCRM.CultureInfo.load Function

[v10.2] Asynchronously gets the CultureInfo object for specified language/country.

Arguments

Argument	Type	Description
culture	String	The name of culture that has to be loaded. The culture name is in the format language code-country where language code is a lowercase two-letter code derived from ISO 639-1. country is derived from ISO 3166 and usually consists of two uppercase letters
callback	function(cultureInfo)	The callback function that is called asynchronously with initialized CultureInfo object as argument.
errorCallback	function(errorMsg)	The errorCallback which is to be called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.CultureInfo.loadAsync Function

[v10.2] Asynchronously gets the CultureInfo object for specified language/country.

Arguments

Argument	Type	Description
culture	String	The name of culture that has to be loaded. The culture name is in the format language code-country where language code is a lowercase two-letter code derived from ISO 639-1. country is derived from ISO 3166 and usually consists of two uppercase letters

Return value

Type: Promise<MobileCRM.CultureInfo>

A Promise object which will be resolved with the loaded CultureInfo object.

MobileCRM.CultureInfo.longDateString Function

[v10.2] Returns the long date string that matches current device culture.

This method fails if CultureInfo.initialize method hasn't completed yet.

Arguments

Argument	Type	Description
date	Date	A date being formatted.

MobileCRM.CultureInfo.longTimeString Function

[v10.2] Returns the long time string that matches current device culture.

This method fails if CultureInfo.initialize method hasn't completed yet.

Arguments

Argument	Type	Description
date	Date	A date being formatted.

MobileCRM.CultureInfo.monthDayString Function

[v10.2] Returns the month and day string that matches current device culture.

This method fails if CultureInfo.initialize method hasn't completed yet.

Arguments

Argument	Type	Description
date	Date	A date being formatted.

MobileCRM.CultureInfo.shortDateString Function

[v10.2] Returns the short date string that matches current device culture.

This method fails if CultureInfo.initialize method hasn't completed yet.

Arguments

Argument	Type	Description
date	Date	A date being formatted.

MobileCRM.CultureInfo.shortTimeString Function

[v10.2] Returns the short time string that matches current device culture.

This method fails if CultureInfo.initialize method hasn't completed yet.

Arguments

Argument	Type	Description
date	Date	A date being formatted.

MobileCRM.CultureInfo.yearMonthString Function

[v10.2] Returns the year and month string that matches current device culture.

This method fails if CultureInfo.initialize method hasn't completed yet.

Arguments

Argument	Type	Description
date	Date	A date being formatted.

MobileCRM.DateTimeFormat Object

[v10.2] Provides culture-specific information about the format of date and time values.

Properties

Property	Type	Description
abbreviatedDayNames	String[]	Gets a string array containing the culture-specific abbreviated names of the days of the week.
abbreviatedMonthGenitiveNames	String[]	Gets a string array of abbreviated month names associated with the current DateTimeFormat object.
abbreviatedMonthNames	String[]	Gets a string array that contains the culture-specific abbreviated names of the months.
aMDesignator	String	Gets the string designator for hours that are "ante meridiem" (before noon).
dayNames	String[]	Gets a string array that contains the culture-specific full names of the days of the week.
firstDayOfWeek	Number	Gets the first day of the week (0=Sunday, 1=Monday, ...)
fullDateTimePattern	String	Gets the custom format string for a long date and long time value.
longDatePattern	String	Gets the custom format string for a long date value.
longTimePattern	String	Gets the custom format string for a long time value.
monthDayPattern	String	Gets the custom format string for a month and day value.
monthGenitiveNames	String[]	Gets a string array of month names associated with the current DateTimeFormat object.
monthNames	String[]	Gets a string array containing the culture-specific full names of the months.
pMDesignator	String	Gets the string designator for hours that are "post meridiem" (after noon).
shortDatePattern	String	Gets the custom format string for a short date value.
shortestDayNames	String[]	Gets a string array of the shortest unique abbreviated day names associated with the current DateTimeFormat object.
shortTimePattern	String	Gets the custom format string for a short time value.
sortableDateTimePattern	String	Gets the custom format string for a sortable date and time value.
universalSortableDateTimePattern	String	Gets the custom format string for a universal, sortable date and time string.
yearMonthPattern	String	Gets the custom format string for a year and month value.

MobileCRM.DynamicEntity Object

Represents a CRM entity, with only a subset of properties loaded.

This class is derived from MobileCRM.Reference

There is a compatibility issue since the version 7.4 which gets the boolean and numeric properties as native Javascript objects (instead of strings). If you experienced problems with these types of fields, switch on the legacy serialization by setting the static property MobileCRM.DynamicEntity.legacyPropsSerialization to true.

Properties

Property	Type	Description
entityName	String	The logical name of the entity, e.g. "account".
id	String	GUID of the existing entity or null for new one.
isNew	Boolean	Indicates whether the entity is newly created.
isOnline	Boolean	Indicates whether the entity was created by online request or from local data.
forceDirty	Boolean	Indicates whether to force save the provided properties even if not modified. Default behavior is to save only properties that were modified.
primaryName	String	The human readable name of the entity, e.g. "Alexandro".
properties	Object	An object with entity properties, e.g. {firstname:"Alexandro", lastname:"Puccini"}.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.DynamicEntity object.
save	Performs the asynchronous CRM create/modify entity command.
saveAsync	Performs the asynchronous CRM create/modify entity command.

Functions

Function	Description
createNew	Creates the MobileCRM.DynamicEntity object representing new entity.
deleteAsync	Asynchronously deletes the CRM entity.
deleteById	Asynchronously deletes the CRM entity.
deleteMultiple	Saves an entity instance to storage.Where the entity is stored is determined by how it was loaded: online / offline.
downloadAttachment	[v9.1] Initiates the attachment download for specified entity.
downloadAttachmentAsync	[v9.1] Initiates the attachment download for specified entity.
loadAsync	Asynchronously loads the CRM entity properties.
loadById	Asynchronously loads the CRM entity properties.
loadDocumentBody	Asynchronously loads the document body for specified entity.
loadDocumentBodyAsync	Asynchronously loads the document body for specified entity.
loadFileFieldContent
saveDocumentBody	[v10.0]Asynchronously saves the document body for specified entity.
saveDocumentBodyAsync	[v10.0]Asynchronously saves the document body for specified entity.
saveMultiple	Saves an entities instances to storage.Where the entity is stored is determined by how it was loaded: online / offline.
unzipDocumentBody	[v9.1] Asynchronously unpacks the document body (assumes it's a zip file) for specified entity.

MobileCRM.DynamicEntity.constructor Method

Constructs an instance of MobileCRM.DynamicEntity object.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, e.g. "account".
id	String	GUID of the existing entity or null for new one.
primaryName	String	The human readable name of the entity, e.g "Alexandro".
properties	Object	An object with entity properties, e.g. {firstname:"Alexandro", lastname:"Puccini"}.
isOnline	Boolean	Indicates whether the entity was created by online request or from local data.
isNew	Boolean	Indicates whether the entity is newly created.

MobileCRM.DynamicEntity.save Method

Performs the asynchronous CRM create/modify entity command.

Arguments

Argument	Type	Description
callback	function(err)	A callback function for asynchronous result. The err argument will carry the error message or null in case of success. The callback is called in scope of DynamicEntity object which is being saved.
forceMode	Boolean	[v10.0.2] Optional parameter which forces online/offline mode for saving. Set "true" to save entity online; "false" to save it offline. Any other value (including "undefined") causes entity tobe saved in currently selected application offline/online mode.

MobileCRM.DynamicEntity.saveAsync Method

Performs the asynchronous CRM create/modify entity command.

Arguments

Argument	Type	Description
forceMode	Boolean	Optional parameter which forces online/offline mode for saving. Set "true" to save entity online; "false" to save it offline. Any other value (including "undefined") causes entity to be saved in currently selected application offline/online mode.

Return value

Type: Promise<DynamicEntity>

A Promise object which will be resolved with saved DynamicEntity object as result.

MobileCRM.DynamicEntity.createNew Function

Creates the MobileCRM.DynamicEntity object representing new entity.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, e.g. "account".
id	String	GUID of the existing entity or null for new one.
primaryName	String	The human readable name of the entity, e.g "Alexandro".
properties	Object	An object with entity properties, e.g. {firstname:"Alexandro", lastname:"Puccini"}.

MobileCRM.DynamicEntity.deleteAsync Function

Asynchronously deletes the CRM entity.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, e.g. "account".
id	String	GUID of the existing entity or null for new one.

Return value

Type: Promise<void>

A Promise object which will be resolved after the entity record is deleted.

MobileCRM.DynamicEntity.deleteById Function

Asynchronously deletes the CRM entity.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, e.g. "account".
id	String	GUID of the existing entity or null for new one.
success	function()	A callback function for successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.DynamicEntity.deleteMultiple Function

Saves an entity instance to storage.Where the entity is stored is determined by how it was loaded: online / offline.

Arguments

Argument	Type	Description
deletedEntities	MobileCRM.DynamicEntity[]	Array of MobileCRM.DynamicEntity or MobileCRM.Reference what will be deleted.
sucessCallbacak	function(result)	A callback function for successful asynchronous result.
failureCallback	function(error)	A callback function for command failure. The error argument will carry the error message.
online	Boolean	Whether to load and save online or offline. Null for default mode defined by current configuration.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.DynamicEntity.downloadAttachment Function

[v9.1] Initiates the attachment download for specified entity.

Function sends an asynchronous request to application, which downloads the document body (e.g. the annotation) from server and sends it back to the Javascript callback.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, in most cases "annotation".
id	String	GUID of the existing entity or null for new one.
success	function(result)	A callback function for successful asynchronous result. The result argument will carry the string with base64-encoded data.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.DynamicEntity.downloadAttachmentAsync Function

[v9.1] Initiates the attachment download for specified entity.

Function sends an asynchronous request to application, which downloads the document body (e.g. the annotation) from server and resolves pending Javascript promise.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, in most cases "annotation".
id	String	GUID of the existing entity or null for new one.

Return value

Type: Promise<string>

A Promise object which will be resolved with base64-encoded data string.

MobileCRM.DynamicEntity.loadAsync Function

Asynchronously loads the CRM entity properties.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, e.g. "account".
id	String	GUID of the existing entity or null for new one.

Return value

Type: Promise<MobileCRM.DynamicEntity>

A Promise object which will be resolved with an instance of DynamicEntity object representing entity record.

MobileCRM.DynamicEntity.loadById Function

Asynchronously loads the CRM entity properties.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, e.g. "account".
id	String	GUID of the existing entity or null for new one.
success	function(result)	A callback function for successful asynchronous result. The result argument will carry the MobileCRM.DynamicEntity object.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.DynamicEntity.loadDocumentBody Function

Asynchronously loads the document body for specified entity.

Function sends an asynchronous request to application, where the locally stored document body (e.g. the annotation.documentbody) is encoded to base64 and sent back to the Javascript callback. This function supports both online data and the data stored in local database/BLOB store.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, in most cases "annotation".
id	String	GUID of the existing entity or null for new one.
success	function(result)	A callback function for successful asynchronous result. The result argument will carry the string with base64-encoded data.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.DynamicEntity.loadDocumentBodyAsync Function

Asynchronously loads the document body for specified entity.

Function sends an asynchronous request to application, where the locally stored document body (e.g. the annotation.documentbody) is encoded to base64 and pending Javascript promise is resolved. This function supports both online data and the data stored in local database/BLOB store.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, in most cases "annotation".
id	String	GUID of the existing entity or null for new one.

Return value

Type: Promise<string>

A Promise object which will be resolved with base64-encoded data string.

MobileCRM.DynamicEntity.loadFileFieldContent Function

Arguments

Argument	Type	Description
entityName	String	Logical name of entity containing the file field.
id	String	An ID of record containing the file field.
fileFieldName	String	Logical name of the file field.

MobileCRM.DynamicEntity.saveDocumentBody Function

[v10.0]Asynchronously saves the document body for specified entity.

Function sends an asynchronous request to application, where the locally stored document body (e.g. the annotation.documentbody) is saved.

Arguments

Argument	Type	Description
entityId	String	GUID of the existing entity or "null" for new one.
entityName	String	The logical name of the entity; optional, default is "annotation".
relationship	MobileCRM.Relationship	The relationship with parent object.
filePath	String	Absolute or app data-relative path to the file holding the body.
mimeType	String	MimeType of the content, optional.
success	function(MobileCRM.Reference)	A callback function for successful asynchronous result. The result argument will carry the Reference to updated/created entity.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.DynamicEntity.saveDocumentBodyAsync Function

[v10.0]Asynchronously saves the document body for specified entity.

Function sends an asynchronous request to application, where the locally stored document body (e.g. the annotation.documentbody) is saved.

Arguments

Argument	Type	Description
entityId	String	GUID of the existing entity or "null" for new one.
entityName	String	The logical name of the entity; optional, default is "annotation".
relationship	MobileCRM.Relationship	The relationship with parent object.
filePath	String	Absolute or app data-relative path to the file holding the body.
mimeType	String	MimeType of the content, optional.

Return value

Type: Promise<MobileCRM.Reference>

A Promise object which will be resolved with the Reference object representing updated/created entity.

MobileCRM.DynamicEntity.saveMultiple Function

Saves an entities instances to storage.Where the entity is stored is determined by how it was loaded: online / offline.

Arguments

Argument	Type	Description
updatedEntities	MobileCRM.DynamicEntity[]	Array of MobileCRM.DynamicEntity.
online	Boolean	Whether to load and save online or offline. Null for default mode defined by current configuration.
sucessCallbacak	function(result)	A callback function for successful asynchronous result.
failureCallback	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.DynamicEntity.unzipDocumentBody Function

[v9.1] Asynchronously unpacks the document body (assumes it's a zip file) for specified entity.

Arguments

Argument	Type	Description
entityName	String	The logical name of the entity, in most cases the "annotation".
id	String	GUID of the existing entity or null for new one.
targetDir	String	The relative path of the target directory within the application storage.
success	function(result)	A callback function for successful asynchronous result. The result argument will carry the string with base64-encoded data.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.GlobalConstants Object

Provides access to the global constants.

Functions

Function	Description
getAllAsync	Asynchronously returns the JSON object representing the GlobalConstants variables.
getAsync	Asynchronously returns the constant associated with the specified key in the GlobalConstants variables.

MobileCRM.GlobalConstants.getAllAsync Function

Asynchronously returns the JSON object representing the GlobalConstants variables.

Return value

Type: Promise<Object>

A Promise object that will be resolved with the properties representing the constant variables.

MobileCRM.GlobalConstants.getAsync Function

Asynchronously returns the constant associated with the specified key in the GlobalConstants variables.

Arguments

Argument	Type	Description
key	String	The key of the constant to get.

Return value

Type: Promise<Object>

A Promise object that will be resolved with an object representing the constant variable.

MobileCRM.Localization Object

A static object with functions allowing to access the localized texts.

Functions

Function	Description
get	Gets the display string for the passed id.
getComponentLabel	Gets the display string for the passed entity and component (view, form) id.
getLoadedLangId	Asynchronously gets currently loaded localization language.
getPlural	Gets the plural version of the display string for the passed id.
getTextOrDefault	Gets the display string for the passed id, or the passed default string if a string with the passed id doesn't exists.
initialize	Initializes the Localization object.
initializeAsync	[v10.0] Initializes the Localization object.
initializeEx	[v10.0] Initializes the Localization object.
makeId	Creates an absolute id from section and id.

MobileCRM.Localization.get Function

Gets the display string for the passed id.

Arguments

Argument	Type	Description
id	String	Display string id.

Return value

Type: String

Human readable string label.

MobileCRM.Localization.getComponentLabel Function

Gets the display string for the passed entity and component (view, form) id.

Arguments

Argument	Type	Description
entityName	String	The entity logical name.
componentType	String	The component type. (View, DetailView).
viewName	String	The component id

Return value

Type: String

The component label.

MobileCRM.Localization.getLoadedLangId Function

Asynchronously gets currently loaded localization language.

The default language is "en-US".

Arguments

Argument	Type	Description
callback	function(langId)	The callback function that is called asynchronously with currently loaded localization language as argument.
errorCallback	function(errorMsg)	The errorCallback which is to be called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Localization.getPlural Function

Gets the plural version of the display string for the passed id.

Arguments

Argument	Type	Description
id	String	Display string id.

Return value

Type: String

Human readable plural string label.

MobileCRM.Localization.getTextOrDefault Function

Gets the display string for the passed id, or the passed default string if a string with the passed id doesn't exists.

Arguments

Argument	Type	Description
id	String	Display string id.
defaultString	String	Default display string.

Return value

Type: String

Human readable string label.

MobileCRM.Localization.initialize Function

Initializes the Localization object.

Method loads the string table asynchronously and calls either the errorCallback with error message or the callback with initialized Localization object.

All other functions will return the default or empty string before the initialization finishes.

Arguments

Argument	Type	Description
callback	function(config)	The callback function that is called asynchronously with initialized Localization object as argument.
errorCallback	function(errorMsg)	The errorCallback which is to be called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Localization.initializeAsync Function

[v10.0] Initializes the Localization object.

Method loads the string table asynchronously and resolves pending promise with initialized Localization object.

All other functions will return the default or empty string before the initialization finishes.

Arguments

Argument	Type	Description
regularExpression	string	Optional regular expression defining a subset of localization keys. Refer to Regular Expression Language - Quick Reference. Set to null to obtain whole localization.

Return value

Type: Promise<MobileCRM.Localization>

A Promise object which will be resolved with initialized Localization object as argument.

MobileCRM.Localization.initializeEx Function

[v10.0] Initializes the Localization object.

Method loads the string table asynchronously and calls either the errorCallback with error message or the callback with initialized Localization object.

All other functions will return the default or empty string before the initialization finishes.

Arguments

Argument	Type	Description
regularExpression	string	The regular expression defining a subset of localization keys. Refer to Regular Expression Language - Quick Reference. Set to null to obtain whole localization.
callback	function(config)	The callback function that is called asynchronously with initialized Localization object as argument.
errorCallback	function(errorMsg)	The errorCallback which is to be called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Localization.makeId Function

Creates an absolute id from section and id.

Arguments

Argument	Type	Description
section	String	The section id.
id	String	Display string id.

Return value

Type: String

Absolute id.

MobileCRM.ManyToManyReference Object

A static object with functions managing many to many relations.

Functions

Function	Description
addRecord	Adds or removes an N-N relationship record between the two passed entities.
create	Creates a new N-N relationship between the two passed entities.
remove	Removes an existing N-N relationship between the two passed entities.

MobileCRM.ManyToManyReference.addRecord Function

Adds or removes an N-N relationship record between the two passed entities.

Arguments

Argument	Type	Description
entityName	String	The relationship entity name.
ref1	MobileCRM.Reference	First entity instance.
ref2	MobileCRM.Reference	Second entity instance.
create	Boolean	Whether to create or delete the relationship record.
success	function(result)	A callback function for successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.ManyToManyReference.create Function

Creates a new N-N relationship between the two passed entities.

New relationship is created either in local database or using the online request. It depends on current application mode.

Arguments

Argument	Type	Description
entityName	String	The relationship entity name.
ref1	MobileCRM.Reference	First entity instance.
ref2	MobileCRM.Reference	Second entity instance.
success	function(result)	A callback function for successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.ManyToManyReference.remove Function

Removes an existing N-N relationship between the two passed entities.

Relationship is removed either from local database or using the online request. It depends on current application mode.

Arguments

Argument	Type	Description
entityName	String	The relationship entity name.
ref1	MobileCRM.Reference	First entity instance.
ref2	MobileCRM.Reference	Second entity instance.
success	function(result)	A callback function for successful asynchronous result.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.MetaEntity Object

Represents an entity metadata.

Properties

Property	Type	Description
isEnabled	Boolean	Indicates whether an entity is enabled. This field is used for limited runtime customization.
isExternal	Boolean	Indicates whether an entity stores data from external sources Exchange/Google.
name	String	Gets the entity (logical) name.
objectTypeCode	Number	Gets the unique entity type code.
primaryFieldName	String	The name of the entity primary field (name) property.
primaryKeyName	String	The name of the entity primary key property.
relationshipName	String	Gets the name of the many-to-many relationship name. Defined only for intersect entities.
statusFieldName	String	Gets the status property name. In general it is called "statuscode" but there are exceptions.
uploadOnly	Boolean	Indicates whether this entity can be downloaded during synchronization.
attributes	Number	Gets additional entity attributes.

Methods

Method	Description
canAppendTo	Checks whether the user has permission to append a child To a this parent entity.
canCreate	Checks whether the current user has create permission on the entity type.
canDelete	Checks whether the current user has create permission on the entity type.
canRead	Checks whether the current user has read permission on the entity type.
canWrite	Checks whether the current user has write permission on the entity type.
getDepth	Gets the permission depth.
getProperty	Gets the MetaProperty object describing the CRM attribute (field) properties.

Functions

Function	Description
loadByName	Gets the MetaEntity by its name.

MobileCRM.MetaEntity.canAppendTo Method

Checks whether the user has permission to append a child To a this parent entity.

Arguments

Argument	Type	Description
child	String	The entity to append (f.e. opportunity).

Return value

Type: Boolean

True if the user has append permissions, false otherwise.

MobileCRM.MetaEntity.canCreate Method

Checks whether the current user has create permission on the entity type.

Return value

Type: Boolean

True if the permission is granted, false otherwise.

MobileCRM.MetaEntity.canDelete Method

Checks whether the current user has create permission on the entity type.

Return value

Type: Boolean

True if the permission is granted, false otherwise.

MobileCRM.MetaEntity.canRead Method

Checks whether the current user has read permission on the entity type.

Return value

Type: Boolean

True if the permission is granted, false otherwise.

MobileCRM.MetaEntity.canWrite Method

Checks whether the current user has write permission on the entity type.

Return value

Type: Boolean

True if the permission is granted, false otherwise.

MobileCRM.MetaEntity.getDepth Method

Gets the permission depth.

Arguments

Argument	Type	Description
permission	Number	Permission to check.

Return value

Type: Number

The permission depth (none, user, business unit, organization).

MobileCRM.MetaEntity.getProperty Method

Gets the MetaProperty object describing the CRM attribute (field) properties.

Arguments

Argument	Type	Description
name	String	A logical name of the CRM field.

Return value

Type: MobileCRM.MetaProperty

An instance of the MobileCRM.MetaProperty object or "null".

MobileCRM.MetaEntity.loadByName Function

Gets the MetaEntity by its name.

If you only need to know the attributes of a single entity, use this method to prevent requesting all Metadata information.

Arguments

Argument	Type	Description
name	String	A logical name of requested entity.
callback	function	The callback function that is called asynchronously with MetaEntity object as argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.MetaProperty Object

Represents a property (CRM field) metadata.

Properties

Property	Type	Description
name	String	Gets the field (logical) name.
required	Number	Gets the attribute requirement level (0=None, 1=SystemRequired, 2=Required, 3=Recommended, 4=ReadOnly).
type	Number	Gets the attribute CRM type (see MS Dynamics SDK).
format	Number	Gets the attribute display format.
isVirtual	Boolean	Gets whether the property is virtual (has no underlying storage). State and PartyList properties are virtual.
isReference	Boolean	Gets whether the property is a reference (lookup) to another entity.
isNullable	Boolean	Gets whether the property may contain NULL.
defaultValue		Gets the property default value.
targets	Array	Gets the names of target entities, if the property is a lookup, or customer.
minimum	Number	Gets the attribute minimum value.
maximum	Number	Gets the attribute minimum value.
precision	Number	Gets the numeric attribute's precision (decimal places).
permission	Number	Gets the attribute's permission set (0=None, 1=User, 2=BusinessUnit, 4=ParentChild, 8=Organization).
activityPartyType	Number	Gets the activity party type (from, to, attendee, etc.)
isMultiParty	Boolean	Gets whether the activity party property can have multiple values (multiple to, cc, resources.)
isSingularParty	Boolean	Gets whether the property represents a singular activity party property. These properties exists as both a Lookup property on the entity and an ActivytParty record.

MobileCRM.Metadata Object

A static object with functions for accessing the entity metadata store.

Functions

Function	Description
entityHasChildren	Gets whether the passed entity has child entities.
getActivities	Gets the list of activities.
getEntity	Gets the MetaEntity object describing the entity attributes.
getEntityParent	Gets the entity's parent entity name.
getOptionSetValues	Asynchronously gets the list of values for given CRM OptionSet.
getStringListOptions	Gets the list of options for the string list property.
requestObject	Requests the Metadata object containing the list of MetaEntities which are enabled for current mobile project.

MobileCRM.Metadata.entityHasChildren Function

Gets whether the passed entity has child entities.

Arguments

Argument	Type	Description
entityName	String	The entity name.

Return value

Type: Boolean

True if the entity is a parent, false otherwise.

MobileCRM.Metadata.getActivities Function

Gets the list of activities.

It&s required to request the Metadata object prior to using this object. See MobileCRM.Metadata.requestObject.

Return value

Type: Array

An array of entity names.

MobileCRM.Metadata.getEntity Function

Gets the MetaEntity object describing the entity attributes.

It's required to request the Metadata object prior to using this object. See MobileCRM.Metadata.requestObject.

Arguments

Argument	Type	Description
name	String	A name of MetaEntity.

Return value

Type: MobileCRM.MetaEntity

A MobileCRM.MetaEntity object or "undefined".

MobileCRM.Metadata.getEntityParent Function

Gets the entity's parent entity name.

Arguments

Argument	Type	Description
childEntityName	String	The entity name.

Return value

Type: String

The parent entity name, or "undefined" if N/A.

MobileCRM.Metadata.getOptionSetValues Function

Asynchronously gets the list of values for given CRM OptionSet.

Arguments

Argument	Type	Description
entityName	String	The entity name.
optionSetName	String	The OptionSet name.
callback	function(optionSetValues)	The callback function that is called asynchronously with option set values object as argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Metadata.getStringListOptions Function

Gets the list of options for the string list property.

Arguments

Argument	Type	Description
entityName	String	The entity name.
propertyName	String	The string list property name.

MobileCRM.Metadata.requestObject Function

Requests the Metadata object containing the list of MetaEntities which are enabled for current mobile project.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of Metadata object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(metadata)	The callback function which is called asynchronously with serialized EntityForm object as argument. Callback should return true to apply changed properties.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.MobileReport Object

Provides a functionality of mobile reporting.

Functions

Function	Description
GenerateReportRequest	[v18.0] The request class specifying behavior of MobileCRM.MobileReport.generateReportAsync function.
GenerateReportResult	[v18.0] The result class for MobileCRM.MobileReport.generateReportAsync function.
generateReportAsync	[v18.0] Generates the mobile report based on provided request parameters. The generated report will be saved to file system or attached to a record.
runReport	[v9.1] Deprecated: please use MobileCRM.MobileReport.generateReportAsync instead. Executes the mobile reporting request which produces the mobile report document of given format.
runReportAsync	[v9.1] Deprecated: please use MobileCRM.MobileReport.generateReportAsync instead. Executes the mobile reporting request which produces the mobile report document of given format.
showForm	[v10.1] Shows new MobileReport form. Source for the report can be defined either as list of MobileCRM.Reference objects or as FetchXML query.
showFormWithConfiguration	[v16.0] Shows new MobileReport form. Source for the report can be defined either as list of MobileCRM.Reference objects or as FetchXML query.

MobileCRM.MobileReport.GenerateReportRequest Function

[v18.0] The request class specifying behavior of MobileCRM.MobileReport.generateReportAsync function.

Arguments

Argument	Type	Description
source	String \| MobileCRM.Reference	The identifier of report source record(s) as MobileCRM.Reference or fetch in its xml representation.
template	String \| MobileCRM.Reference	The identifier of report template as its string record ID, exact logical name, MobileCRM.Reference or actual xml definition of report.
format	String	Optional code of report format. Supported values are: Pdf (default), Html, Excel, Word.
customNameOrPath	String	Optional custom name of report file or its full path. If not provided, default report name and path are used. When using full path, it is recommended to place it in MobileCRM.Configuration.storageDirectory.
languageCode	String	Optional iso code (e.g. "en-US") of report language. Currently it only works for reports on localized Questionnaires.
waitMessage	String	Optional custom message displayed to user while report is being generated. When null or empty string is provided, default message is shown. When undefined, shows no wait message.
isOnline	Boolean	Optionally specifies if report should be created in Online, or Offline mode. If undefined, the mode in which app is currently running is used.
attachTo	MobileCRM.Reference	A MobileCRM.Reference to parent record. If provided, method will generate new attachment record and link it to the parent record.
attachmentEntity	String	When attachmentRecord is provided, optionally specifies the type of attachment entity. If not specified, the default attachment entity is created.

MobileCRM.MobileReport.GenerateReportResult Function

[v18.0] The result class for MobileCRM.MobileReport.generateReportAsync function.

Arguments

Argument	Type	Description
outputReportPath	String	The full file path to generated report. Not present if MobileCRM.MobileReport.GenerateReportRequest.attachTo is provided.
attachmentRecord	MobileCRM.Reference	The reference to attachment record containing the generated report. Only present if MobileCRM.MobileReport.GenerateReportRequest.attachTo is provided.

MobileCRM.MobileReport.generateReportAsync Function

[v18.0] Generates the mobile report based on provided request parameters. The generated report will be saved to file system or attached to a record.

Arguments

Argument	Type	Description
request	MobileCRM.MobileReport.GenerateReportRequest	The request specifying the details of how the report will be created.

Return value

Type: MobileCRM.MobileReport.GenerateReportResult

The promise with GenerateReportResult object.

MobileCRM.MobileReport.runReport Function

[v9.1] Deprecated: please use MobileCRM.MobileReport.generateReportAsync instead. Executes the mobile reporting request which produces the mobile report document of given format.

Arguments

Argument	Type	Description
fetch	String	The fetch XML defining the entity (entities) query used as report input.
reportXML	String	The mobile report XML definition which can be loaded from the resco_report entity or constructed dynamically. Ignored if IsExportOnly parameter is true.
reportFormat	String	Report format: Pdf (default), Html, Excel, Word.
isExportOnly	Boolean	If true then ReportXml is optional. The default is false.
isOnline	Boolean	Indicates whether the report should be run against the online data or local database. The default is current application mode.
outputFile	String	The full path to the output file. If omitted a temp file is created. The output path is always passed to the success callback.
success	function(obj)	A callback function that is called with the file path to successfully created report.
failed	function(errorMsg)	A callback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.MobileReport.runReportAsync Function

[v9.1] Deprecated: please use MobileCRM.MobileReport.generateReportAsync instead. Executes the mobile reporting request which produces the mobile report document of given format.

Arguments

Argument	Type	Description
fetch	String	The fetch XML defining the entity (entities) query used as report input.
reportXML	String	The mobile report XML definition which can be loaded from the resco_mobilereport entity or constructed dynamically. Ignored if IsExportOnly parameter is true.
reportFormat	String	Report format: Pdf (default), Html, Excel, Word.
isExportOnly	Boolean	If true then ReportXml is optional. The default is false.
isOnline	Boolean	Indicates whether the report should be run against the online data or local database. The default is current application mode.
outputFile	String	The full path to the output file. If omitted a temp file is created.

Return value

Type: Promise<string>

A Promise object which will be resolved with the file path to successfully created report.

MobileCRM.MobileReport.showForm Function

[v10.1] Shows new MobileReport form. Source for the report can be defined either as list of MobileCRM.Reference objects or as FetchXML query.

If both types of source are passed, user can select which one to use.

This method is not available under Essential license.

Arguments

Argument	Type	Description
report	MobileCRM.Reference	Optional reference to the resco_mobilereport entity that will be pre-selected.
source	MobileCRM.Reference[]	The list of entity references used as report input.
fetchXML	String	The fetch XML defining the entity (entities) query used as report input.
failed	function(errorMsg)	A callback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.MobileReport.showFormWithConfiguration Function

[v16.0] Shows new MobileReport form. Source for the report can be defined either as list of MobileCRM.Reference objects or as FetchXML query.

If both types of source are passed, user can select which one to use.

This method is not available under Essential license.

Arguments

Argument	Type	Description
report	MobileCRM.Reference	Optional reference to the resco_mobilereport entity that will be pre-selected.
source	MobileCRM.Reference[]	The list of entity references used as report input.
fetchXML	String	The fetch XML defining the entity (entities) query used as report input.
paramString	String	Run report form Configuration string in JSON format.
failed	function(errorMsg)	A callback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.NumberFormat Object

[v10.2] Provides culture-specific information for formatting and parsing numeric values.

Properties

Property	Type	Description
currencyDecimalDigits	Number	Gets the number of decimal places to use in currency values.
currencyDecimalSeparator	String	Gets the string to use as the decimal separator in currency values.
currencyGroupSeparator	String	Gets the string that separates groups of digits to the left of the decimal in currency values.
currencyGroupSizes	Number[]	Gets the number of digits in each group to the left of the decimal in currency values.
currencyNegativePattern	Number	Gets the format pattern for negative currency values.
currencyPositivePattern	Number	Gets the format pattern for positive currency values.
currencySymbol	String	Gets the string to use as the currency symbol.
naNSymbol	String	Gets the string that represents the IEEE NaN (not a number) value.
negativeInfinitySymbol	String	Gets the string that represents negative infinity.
negativeSign	String	Gets the string that denotes that the associated number is negative.
numberDecimalDigits	Number	Gets the number of decimal places to use in numeric values.
numberDecimalSeparator	String	Gets the string to use as the decimal separator in numeric values.
numberGroupSeparator	String	Gets the string that separates groups of digits to the left of the decimal in numeric values.
numberGroupSizes	Number[]	Gets the number of digits in each group to the left of the decimal in numeric values.
numberNegativePattern	Number	Gets the format pattern for negative numeric values.
percentDecimalDigits	Number	Gets the number of decimal places to use in percent values.
percentDecimalSeparator	String	Gets the string to use as the decimal separator in percent values.
percentGroupSeparator	String	Gets the string that separates groups of digits to the left of the decimal in percent values.
percentGroupSizes	Number[]	Gets the number of digits in each group to the left of the decimal in percent values.
percentNegativePattern	Number	Gets the format pattern for negative percent values.
percentPositivePattern	Number	Gets the format pattern for positive percent values.
percentSymbol	String	Gets the string to use as the percent symbol.
perMilleSymbol	String	Gets the string to use as the per mille symbol.
positiveInfinitySymbol	String	Gets the string that represents positive infinity.
positiveSign	String	Gets the string that denotes that the associated number is positive.

MobileCRM.OAuthSettings Object

[v12.4] Represents the settings what are used to authenticate using OAuth server account.

Properties

Property	Type	Description
authorityEndPoint	String	Gets or sets the OAuth token url.
authorizationUrl	String	Gets or sets the authorization url to get authorization code.
clientId	String	Gets or sets the authentication Client Id.
clientSecret	String	Gets or sets the Authentication Client Secret.
redirectUrl	String	Gets or sets the authorization redirect url for service.
resourceUrl	String	Gets or sets the App ID URI of the target web API (secured resource).
scopes	String	Gets or sets the scope to limit an application's access to a user's account.

MobileCRM.ObservableObject Object

Represents a generic object which is monitoring the changes of its properties.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.ObservableObject object.
addProp	Creates a new observable property for this object
getChanged	Creates a clone of this object containing all properties that were changed since object construction.
runCallback	Invokes callback passing this instance of ObservableObject as argument.
setTypedValue	[v8.0] Sets the explicitly typed value for specified property.

MobileCRM.ObservableObject.constructor Method

Constructs an instance of MobileCRM.ObservableObject object.

Arguments

Argument	Type	Description
props	Object	Optional list of properties.

MobileCRM.ObservableObject.addProp Method

Creates a new observable property for this object

Arguments

Argument	Type	Description
name	String	A name of the new property.
writable	Boolean	Indicates whether the property should have setter.
value		An initial value.

MobileCRM.ObservableObject.getChanged Method

Creates a clone of this object containing all properties that were changed since object construction.

This method enumerates object recursively and creates the object clone containing only the changed properties.

Return value

Type: Object

An object clone containing all changed properties.

MobileCRM.ObservableObject.runCallback Method

Invokes callback passing this instance of ObservableObject as argument.

Arguments

Argument	Type	Description
callback	function	The callback function.
scope	Object	The scope for callback.

Return value

Type: Object

An object clone containing all properties changed during the callback call.

MobileCRM.ObservableObject.setTypedValue Method

[v8.0] Sets the explicitly typed value for specified property.

Arguments

Argument	Type	Description
propName	String	The name of the property which is being set.
type	String	The fully qualified .Net type (e.g. "System.String" or "MobileCrm.Data.IReference,MobileCrm.Data").
value		The value which has to be set.

MobileCRM.Platform Object

Represents object for querying platform specific information and executing platform integrated actions.

This object cannot be created directly. To obtain/modify this object, use MobileCRM.Platform.requestObject function.

Properties

Property	Type	Description
capabilities	Number	Gets the mask of capability flags supported by this device (MakePhoneCalls=1; HasMapView=2).
deviceIdentifier	String	Gets the unique identifier of this device.
screenWidth	Number	Gets the current screen width in pixels.
screenHeight	Number	Gets the current screen width in pixels.
screenDensity	Number	Gets the screen density (DPI).
isMultiPanel	Boolean	Gets whether the device has tablet or phone UI.
customImagePath	String	Gets or sets the custom image path that comes from customization.

Functions

Function	Description
email	[v8.1] Opens the platform-specific e-mail message form with pre-filled data.
emailWithAttachments	[v9.1] Sends a list of files (full paths or IReferences to blobs) as email attachments.
getDeviceInfo	Gets the device information.
getLocation	Gets current geo-location from platform-specific location service.
getLocationAsync	Gets current geo-location from platform-specific location service.
getNetworkInfo	[v11.2] Gets network information.
getURL	Gets the full URL of currently loaded HTML document.
makeCall	[v8.0] Opens the platform-specific call application with specified phone number.
navigateTo	Execute the navigateTo function based on the latitude and longitude.
openDocument	[v8.1] Opens specified document in associated program.
openUrl	Open url in external browser.
preventBackButton	Prevents application to close when HW back button is pressed and installs handler which is called instead.
requestObject	Requests the managed Platform object.
scanBarCode	Activates the bar-code scanning.
scanBarCodeRequiredLength	Activates the bar-code scanning.
sendEmail	[v15.0] Opens the platform-specific e-mail message form with pre-filled data.
sendSMS	[v11.2.3] Opens the platform-specific sms application with specified phone number and pre-fill text.
showAlert	Shows a platform-specific alert window with specified text and buttons. Resolves to the pressed button name.
showToast	Shows a platform-specific toast window over the app window which is dismissed after a few seconds.
watchLocationUpdates	[v18.2] Registers or unregisters a handler for location updates.

MobileCRM.Platform.email Function

[v8.1] Opens the platform-specific e-mail message form with pre-filled data.

Arguments

Argument	Type	Description
address	String	Recipient's email address.
subject	String	An e-mail subject.
body	String	A string with email body.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for errorCallback.

MobileCRM.Platform.emailWithAttachments Function

[v9.1] Sends a list of files (full paths or IReferences to blobs) as email attachments.

This method either open the CRM Email form or the native mail client (depending on application settings).

Arguments

Argument	Type	Description
address	String	Recipient"s email address.
subject	String	An e-mail subject.
body	String	A string with email body.
attachments	Array	Array of files to send. Element must be a full path or a IReference to a note, etc.
entity	MobileCRM.Reference	The related entity reference.
relationship	MobileCRM.Relationship	The relationship to the created email entity. (optional).
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for errorCallback.

MobileCRM.Platform.getDeviceInfo Function

Gets the device information.

Arguments

Argument	Type	Description
success	function(result)	A callback function for successful asynchronous result. The result will carry a MobileCRM._DeviceInfo object.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Platform.getLocation Function

Gets current geo-location from platform-specific location service.

If the current platform does not support the location service, the failed handler is called with error "Unsupported".

Arguments

Argument	Type	Description
success	function(result)	A callback function for successful asynchronous result. The result will carry an object with properties latitude, longitude and timestamp .
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.
age	Number	Max age in seconds to accept GPS.
precision	Number	Desired accuracy in meters.
timeout	Number	Timeout in milliseconds (since v10.1).

MobileCRM.Platform.getLocationAsync Function

Gets current geo-location from platform-specific location service.

If the current platform does not support the location service, returned Promise is rejected with error "Unsupported".

Arguments

Argument	Type	Description
age	Number	Max age in seconds to accept GPS.
precision	Number	Desired accuracy in meters.
timeout	Number	Timeout in milliseconds (since v10.1).

Return value

Type: Promise<object>

A Promise object which will be resolved with an object having latitude and longitude properties.

MobileCRM.Platform.getNetworkInfo Function

[v11.2] Gets network information.

Arguments

Argument	Type	Description
success	function(result)	A callback function for successful asynchronous result. The result will carry an object with properties connected and fastConnection.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Platform.getURL Function

Gets the full URL of currently loaded HTML document.

Arguments

Argument	Type	Description
success	function(result)	A callback function for successful asynchronous result. The result will carry a string with URL.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Platform.makeCall Function

[v8.0] Opens the platform-specific call application with specified phone number.

Arguments

Argument	Type	Description
telephone	String	Telephone number
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for errorCallback.

MobileCRM.Platform.navigateTo Function

Execute the navigateTo function based on the latitude and longitude.

Arguments

Argument	Type	Description
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Platform.openDocument Function

[v8.1] Opens specified document in associated program.

Apple security policy doesn&t allow this functionality on iOS.

Arguments

Argument	Type	Description
path	String	A path to the document file.
mimeType	String	Document MIME type (required on Android).
args	String	Optional arguments for Windows 7 command line.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for errorCallback.

MobileCRM.Platform.openUrl Function

Open url in external browser.

Arguments

Argument	Type	Description
url	String	web page url

MobileCRM.Platform.preventBackButton Function

Prevents application to close when HW back button is pressed and installs handler which is called instead.

Pass "null" handler to allow the HW back button.

Works only under OS having HW back button (Android).

Arguments

Argument	Type	Description
handler	function()	Handler function which will be called each time when user presses the Android HW back button.

MobileCRM.Platform.requestObject Function

Requests the managed Platform object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of Platform object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(platform)	The callback function that is called asynchronously with serialized Platform object as argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Platform.scanBarCode Function

Activates the bar-code scanning.

If the current platform does not support the bar-code scanning, the failed handler is called with error "Unsupported".

Arguments

Argument	Type	Description
success	function(result)	A callback function for successful asynchronous result. The result will carry an array of strings with scanned codes.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Platform.scanBarCodeRequiredLength Function

Activates the bar-code scanning.

If the current platform does not support the bar-code scanning, the failed handler is called with error "Unsupported".

Arguments

Argument	Type	Description
requiredLength	Number	Set required length of scanned barcode.
success	function(result)	A callback function for successful asynchronous result. The result will carry an array of strings with scanned codes.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Platform.sendEmail Function

[v15.0] Opens the platform-specific e-mail message form with pre-filled data.

Arguments

Argument	Type	Description
address	String	Recipient's email address.
subject	String	An e-mail subject.
body	String	A string with email body.
mimeType	String	Body content MIME type.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for errorCallback.

MobileCRM.Platform.sendSMS Function

[v11.2.3] Opens the platform-specific sms application with specified phone number and pre-fill text.

Arguments

Argument	Type	Description
phoneNumber	String	Phone number
text	String	SMS text
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for errorCallback.

MobileCRM.Platform.showAlert Function

Shows a platform-specific alert window with specified text and buttons. Resolves to the pressed button name.

Arguments

Argument	Type	Description
text	String	A message to show.
multiLine	Boolean	If true, the message text will be displayed with larger height and the text will be wrapped.
defaultButton	String	The default button caption. If not specified, there is no default button.
buttons	Array	An array of button captions to display. If not specified, only default button or OK button is shown.

MobileCRM.Platform.showToast Function

Shows a platform-specific toast window over the app window which is dismissed after a few seconds.

Arguments

Argument	Type	Description
message	String	A toast content message.
icon	String	Valid app image name (e.g. Home.Now.png).

MobileCRM.Platform.watchLocationUpdates Function

[v18.2] Registers or unregisters a handler for location updates.

When the location is updated, the handler is called with a MobileCRM.Location object having latitude, longitude and timestamp properties.

Arguments

Argument	Type	Description
handler	function(location)	Handler function which will be called each time when the location is updated. The location argument will carry an object with latitude, longitude and timestamp properties.
bind	Boolean	Indicates whether to bind or unbind handler.
scope		Optional scope for calling the handler; set "null" to call the handler in global scope.

Return value

Type: Promise<void>

A Promise object which will be resolved when the handler is successfully bound/unbound.

MobileCRM.Questionnaire Object

Provides a functionality for questionnaires.

Functions

Function	Description
getGroupName	Generates the real name of repeatable question group.
getQuestionName	Generates the real name of question from repeatable group.
showForm	[v10.2] Shows the questionnaire form.

MobileCRM.Questionnaire.getGroupName Function

Generates the real name of repeatable question group.

Arguments

Argument	Type	Description
name	String	Base question group name from questionnaire template.
repeatIndex	Number	Repeat index of the group.

MobileCRM.Questionnaire.getQuestionName Function

Generates the real name of question from repeatable group.

Arguments

Argument	Type	Description
name	String	Base question name from questionnaire template.
repeatIndex	Number	Repeat index of the group containing the question.

MobileCRM.Questionnaire.showForm Function

[v10.2] Shows the questionnaire form.

This method is not available under Essential license.

Arguments

Argument	Type	Description
id	String	Id (guid) of the questionnaire.
failed	function(errorMsg)	A callback which is called in case of error.
scope	Object	The scope for callbacks.
relationship	MobileCRM.Relationship	Optional relationship with the parent record.
modal	Boolean	Optional parameter determines if the form will be opened in modal dialog. Defaults to false.
version	Integer	Optional parameter for setting the Questionnaire player version to execute the questionnaire. Default is 1

MobileCRM.Reference Object

Represents an entity reference which provides the minimum information about an entity.

Properties

Property	Type	Description
entityName	String	The logical name of the reference, e.g. "account".
id	String	GUID of the existing entity or null for new one.
isNew	Boolean	Indicates whether the entity is newly created.
primaryName	String	The human readable name of the reference, e.g. "Alexandro".

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.Reference object.
toString	Prints the reference primary name into string.

Functions

Function	Description
loadAsync	Asynchronously loads the CRM reference.
loadById	Asynchronously loads the CRM reference.

MobileCRM.Reference.constructor Method

Constructs an instance of MobileCRM.Reference object.

Arguments

Argument	Type	Description
entityName	String	The logical name of the reference, e.g. "account".
id	String	GUID of the existing entity or null for new one.
primaryName	String	The human readable name of the reference, e.g "Alexandro".

MobileCRM.Reference.toString Method

Prints the reference primary name into string.

Return value

Type: String

A string with primary name of this entity reference.

MobileCRM.Reference.loadAsync Function

Asynchronously loads the CRM reference.

Arguments

Argument	Type	Description
entityName	String	An entity name
id	String	The reference ID.

Return value

Type: Promise<MobileCRM.Reference>

A Promise object which will be resolved with an instance of Reference object representing entity record reference.

MobileCRM.Reference.loadById Function

Asynchronously loads the CRM reference.

Arguments

Argument	Type	Description
entityName	String	An entity name
id	String	The reference ID.
success	function(result)	A callback function for successful asynchronous result. The result will carry an instance of MobileCRM.Reference object.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.Relationship Object

Represents a relationship between two entities.

Properties

Property	Type	Description
sourceProperty	String	Gets the name of the source of the relationship.
target	MobileCRM.Reference	Gets the target of the relationship.
intersectEntity	String	Gets the intersect entity if any. Used when displaying entities that are associated through a Many to Many relationship.
intersectProperty	String	Gets the intersect entity property if any. Used when displaying entities that are associated through a Many to Many relationship.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.Relationship object.

MobileCRM.Relationship.constructor Method

Constructs an instance of MobileCRM.Relationship object.

Arguments

Argument	Type	Description
sourceProperty	String	Gets the name of the source of the relationship.
target	MobileCRM.Reference	Gets the target of the relationship.
intersectEntity	String	Gets the intersect entity if any. Used when displaying entities that are associated through a Many to Many relationship.
intersectProperty	String	Gets the intersect entity property if any. Used when displaying entities that are associated through a Many to Many relationship.

MobileCRM._DeviceInfo Object

Represents the device information.

To obtain this object, use MobileCRM.Platform.getDeviceInfo function.

Properties

Property	Type	Description
name	String	Gets the name identifying the device.
oSVersion	String	Gets name and version of operating system.
model	String	Gets device model identifying the real device hardware.
buildInfo	String	Gets the build info (bundle ID on iOS)

MobileCRM._Settings Object

Internal object representing the application settings.

This object cannot be created directly. To obtain/modify this object, use MobileCRM.Configuration.requestObject function. See MobileCRM.Configuration

Properties

Property	Type	Description
activeAppID	String	Gets currently selected Application ID. & means default app. Null or empty string means that user hasn't chosen app yet.
afterSaveReload	Number	Gets options for default after save behavior "None = 0, New = 1,Always = 2"
appIDs	String[]	Gets the list of Application IDs available for current user.
authenticationType	Number	Gets possible CRM server authentication methods. "AD = 0, PassPort = 1,SPLA = 2,PassportEMEA = 3,PassportAPAC = 4 "
businessUnitId	String	Gets the current user's business unit id.
canUsePassword	Boolean	Gets whether there is a valid password and whether it can be used.
crm2011AuthId	String	Gets the discovered CRM service authentication server identifier.
crm2011AuthType	String	Gets the discovered CRM service authentication server type.
crm2011AuthUrl	String	Gets the discovered CRM service authentication server url.
crmOnlineDeviceToken	String	Gets the token (cookie) issued by LiveId services identifying this device.
crmOnlineDeviceTokenExpires	Date	Gets when CrmOnlineDeviceToken expires (UTC).
crmWebServiceMinorVersion	Number	Gets the discovered CRM service minor version (13 - for CRM 2011 Rollup 13 and up).
crmWebServiceVersion	Number	Gets the discovered CRM service version (4,5).
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).
currencyFormatCode	Number	Gets or sets the currency field display option 0- $123, 1-123$, 2-$ 123, 3-123 $.
customerId	MobileCRM.Reference	Gets the customer when application is running in customer mode. MobileCRM.Reference object instance as argument
customerUserId	MobileCRM.Reference	Gets the CustomerUserId when application is running in customer mode. MobileCRM.Reference object instance as argument
dataverseCanUseTDS	Boolean	Gets or sets whether Dataverse can use TDS (Tabular Data Stream) queries for downloads.
defaultFetchPageSize	Number	Gets or sets the default fetch page size (#records downloaded in 1 request). Range 100-5000, default = 1000.
deviceFriendlyName	String	Gets or sets the device friendly name e.g. "Steve's iPhone".
deviceIdentifier	String	Gets or sets the hardware unique id.
deviceInfo	String	Gets the device system and hardware information e.g. "Hewlett-Packard HP ProBook 6450b Microsoft Windows NT 6.1.7600.0"
disableSyncAnalyzer	Boolean	Gets or sets whether the synchronization should use the SyncAnalyzer step.
discountCalculationMethod	Number	Gets or sets the option for calculating the discount 0 - apply after (PriceQuantity)-Discount , 1- apply before (Price-Discount)Quantity.
distanceUnits	Number	Indicates whether to use metric system, imperial system or default device system (0=System default, 1=Metric, 2=Imperial).
downloadMultipleAttachments	Boolean	Gets or sets whether to download multiple attachments in one batch request. Default false.
duplicateDetection	Number	Gets whether duplicate detection is enabled and whether to detect against the local database, online, or always online. "Disabled = 0, Enabled = 1,AlwaysOnline = 2"
emailSignature	String	Gets or sets the email signature.
enableAdvancedFind	Boolean	Gets or sets whether to enable advanced find functionality. Default true.
enableListMultiSelect	Boolean	Allows user to multi-select in lists and calculate aggregates or execute custom commands.
enableListSearchButtons	Boolean	Gets or sets whether to allow list search buttons.
forceCustomizationDownload	Boolean	Gets or sets a value indicating whether the customization download is forced.
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	Gets or sets whether password can be used for next login.
formCachePolicy	Number	Determines form caching policy (whether to cache no forms, default forms-only or also FormSelectRule forms (0=NoCaching, 1=DefaultFormCaching, 2=AllFormsCaching).
fullScreenForms	Boolean	Gets or sets whether to show forms maximized by default. Can be overridden per form in Woodford.
gPSAccuracy	Number	Gets or sets the default accuracy (in meters) when resolving the current position.
gPSMaxAge	Number	Gets or sets the default maximum age (in seconds) of the last result when resolving the current position.
hasSyncErrors	Boolean	Indicates whether there were any synchronization errors encountered.
homeLocation	String	Defines the GPS location of the user's home. Must be in the form [latitude,longitude], e.g. 48.3,17.2
isOnlineCrm	Boolean	Gets whether the last login was for a CRM Online instance.
language	String	Gets the language of the application (e.g. en-US).
lastSyncDate	Date	Gets the last synchronization end date.
logSyncDetails	Boolean	Gets or sets whether the synchronization log should include low level messages.
maxAttachmentSize	Number	Gets or sets the maximum attachment size to sync (in bytes).
maxExecuteMultiple	Number	Gets or sets the maximum number of records to process in a single ExecuteMultiple request.
maxExecuteMultipleDataSize	Number	Gets or sets the maximum size (in bytes) of records to upload in one request.
maxImageSize	Number	Gets or sets the maximum size of the captured image. Bigger images are resized to this size (0=Default, 1=640x480, 2=1024x768, 3=1600x1200, 4=2048x1536, 5=2592x1936).
maxSyncCount	Number	Gets or sets the maximum number of records (per entity) to download.
maxUploadAttachmentSize	Number	Gets or sets the maximum size (in bytes) of attachments created by app.
maxUploadImageSize	Number	Gets or sets the maximum size of the uploaded image. Bigger images are resized to this size just after being captured/selected. (0=Default, 1=640x480, 2=1024x768, 3=1600x1200, 4=2048x1536, 5=2592x1936).
notifySyncFinish	Boolean	Gets or sets whether to show a notification after sync finishes and app is not on foreground.
onlineNoLock	Boolean	Gets or sets whether to use "no-lock" in fetchXml during online mode.
optimizeHiddenIframes	Boolean	Indicates whether to speed up hidden iFrames in Windows Store app by placing them into pre-loaded WebView container.
organizationId	String	Gets the current user's organization id (given by the server).
organizationName	String	Gets the current user's organization name (given by the server).
organizationUrl	String	Gets the current user's organization server URL.
pushId	String	Gets platform-specific identifier for push notifications.
saveBehavior	Number	Gets options for default after save behavior "Default = 0, SaveOnly = 1,SaveAndClose = 2"
saveSignatureAsImage	Boolean	Gets or sets whether to store signature attachments as SVG (vector) or PNG (image).
serverHostName	String	Gets the server host name.
serverSettingsVersion	String	Gets the version of the settings file as sent with the customization.
serverVersion	Number	Gets or sets the server version, either 4 for CRM 4.0 or 5 for CRM 2011.
showPersonalContacts	Boolean	Gets or sets whether to show contacts from the user's personal address book.
showSystemCalendars	Boolean	Gets or sets whether to show private calendars in calendars.
systemUserEmail	String	Gets the current user email (given by the server).
systemUserId	String	Gets the current user id (given by the server).
systemUserName	String	Gets the current user name (given by the server).
teams	String[]	Gets the array of ids of teams the current user is member of.
themeType	Number	Gets or sets app theme - system, light or dark. 0=Light, 1=Dark, 2=System
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!
useFlexiForms	Boolean	Gets or sets whether flexi forms (New UI) are enabled.
userDefaultCurrencyId	String	Gets the user's default currency id. If not set use the organization default.
userName	String	Gets the current user's name.
workLocation	String	Defines the GPS location of the user's work. Must be in the form [latitude,longitude], e.g. 48.3,17.2

MobileCRM.FetchXml Namespace

Contains a set of objects implementing the FetchXML request methods

Objects

Object	Description
Attribute	Represents a FetchXml select statement (CRM field).
Condition	Represents a FetchXml attribute condition statement.
Entity	Represents a FetchXml query root entity.
Fetch	Represents a FetchXml query object.
Filter	Represents a FetchXml filter statement. A logical combination of Conditions and child-filters.
LinkEntity	Represents a FetchXml query linked entity.
Order	Represents a FetchXml order statement.

MobileCRM.FetchXml.Attribute Object

Represents a FetchXml select statement (CRM field).

Properties

Property	Type	Description
aggregate	String	An aggregation function.
alias	String	Defines an attribute alias.
dategrouping	String	A date group by modifier (year, quarter, month, week, day).
groupby	Boolean	Indicates whether to group by this attribute.
name	String	A lower-case entity attribute name (CRM logical field name).

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.FetchXml.Attribute object.

MobileCRM.FetchXml.Attribute.constructor Method

Constructs an instance of MobileCRM.FetchXml.Attribute object.

Arguments

Argument	Type	Description
name	String	A lower-case entity attribute name (CRM logical field name).

MobileCRM.FetchXml.Condition Object

Represents a FetchXml attribute condition statement.

Properties

Property	Type	Description
attribute	String	The attribute name (CRM logical field name).
operator	String	The condition operator. "eq", "ne", "in", "not-in", "between", "not-between", "lt", "le", "gt", "ge", "like", "not-like", "null", "not-null", "eq-userid", "eq-userteams", "today", "yesterday", "tomorrow", "this-year", "last-week", "last-x-hours", "next-x-years", "olderthan-x-months", ...
uiname	String	The lookup target entity display name.
uitype	String	The lookup target entity logical name.
value		The value to compare to.
values	Array	The list of values to compare to.

MobileCRM.FetchXml.Entity Object

Represents a FetchXml query root entity.

Properties

Property	Type	Description
allattributes	Boolean	Indicates whether to fetch all attributes instead of explicitly chosen set.
attributes	Array	An array of MobileCRM.FetchXml.Attribute objects.
filter	MobileCRM.FetchXml.Filter	A query filter.
linkentities	Array	An array of MobileCRM.FetchXml.LinkEntity objects.
name	String	An entity logical name.
order	Array	An array of MobileCRM.FetchXml.Order objects.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.FetchXml.Entity object.
addAttribute	Adds an entity attribute to the fetch query.
addAttributes	Adds all entity attributes to the fetch query.
addFilter	Adds a filter for this fetch entity.
addLink	Adds an entity link (join) to the fetch query.
orderBy	Adds an order by statement to the fetch query.
removeLink	Removes an entity link from the fetch query.

MobileCRM.FetchXml.Entity.constructor Method

Constructs an instance of MobileCRM.FetchXml.Entity object.

Arguments

Argument	Type	Description
name	String	An entity logical name.

MobileCRM.FetchXml.Entity.addAttribute Method

Adds an entity attribute to the fetch query.

Arguments

Argument	Type	Description
name	String	The attribute (CRM logical field name) to order by.
alias	String	Optional parameter defining an attribute alias.
aggregate	String	Optional parameter defining an aggregation function.

Return value

Type: MobileCRM.FetchXml.Attribute

The newly created MobileCRM.FetchXml.Attribute object

MobileCRM.FetchXml.Entity.addAttributes Method

Adds all entity attributes to the fetch query.

MobileCRM.FetchXml.Entity.addFilter Method

Adds a filter for this fetch entity.

Return value

Type: MobileCRM.FetchXml.Filter

Existing or newly created entity filter.

MobileCRM.FetchXml.Entity.addLink Method

Adds an entity link (join) to the fetch query.

Arguments

Argument	Type	Description
target	String	The target entity.
from	String	The "from" field (if parent then target entity primary key).
to	String	The "to" field.
linktype	String	The link (join) type ("inner" or "outer").

Return value

Type: MobileCRM.FetchXml.LinkEntity

The newly created MobileCRM.FetchXml.LinkEntity object.

MobileCRM.FetchXml.Entity.orderBy Method

Adds an order by statement to the fetch query.

Arguments

Argument	Type	Description
attribute	String	The attribute (CRM logical field name) to order by.
descending	Boolean	false, for ascending order; true, for descending order.

Return value

Type: MobileCRM.FetchXml.Order

The newly created MobileCRM.FetchXml.Order object.

MobileCRM.FetchXml.Entity.removeLink Method

Removes an entity link from the fetch query.

Arguments

Argument	Type	Description
link	MobileCRM.FetchXml.LinkEntity	The MobileCRM.FetchXml.LinkEntity object to remove.

Return value

Type: Array

The list of remaining LinkEntity objects or null if the link does not exists.

MobileCRM.FetchXml.Fetch Object

Represents a FetchXml query object.

Properties

Property	Type	Description
aggregate	Boolean	Indicates whether the fetch is aggregated.
count	int	the maximum number of records to retrieve.
entity	MobileCRM.FetchXml.Entity	An entity object.
page	int	1-based index of the data page to retrieve.
distinct	Boolean	Whether to return only distinct (different) values.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.FetchXml.Fetch object.
execute	Performs the asynchronous CRM Fetch request.
executeAsync	Performs the asynchronous CRM Fetch request.
executeOffline	[v8.0] Performs the offline CRM Fetch request regardless of the app online/offline mode.
executeOnline	[v8.0] Performs the online CRM Fetch request regardless of the app online/offline mode.
serializeToXml	[v10.0] Serializes the Fetch object to XML.
serializeToXmlAsync	[v10.0] Serializes the Fetch object to XML.

Functions

Function	Description
deserializeFromXml	Deserializes the Fetch object from XML.
deserializeFromXmlAsync	Deserializes the Fetch object from XML.
executeFromXML	Performs the asynchronous CRM Fetch command.
executeFromXmlAsync	Executes fetch XML asynchronously.

MobileCRM.FetchXml.Fetch.constructor Method

Constructs an instance of MobileCRM.FetchXml.Fetch object.

Arguments

Argument	Type	Description
entity	MobileCRM.FetchXml.Entity	An entity object.
count	int	the maximum number of records to retrieve.
page	int	1-based index of the data page to retrieve.
distinct	bool	Whether to return only distinct (different) values.
aggregate	bool	Indicates whether the fetch is aggregated.

MobileCRM.FetchXml.Fetch.execute Method

Performs the asynchronous CRM Fetch request.

Arguments

Argument	Type	Description
output	String	A string defining the output format: Array, JSON, XML or DynamicEntities.
success	function(result)	A callback function for successful asynchronous result. The result argument will carry the objects array of type specified by output argument.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.FetchXml.Fetch.executeAsync Method

Performs the asynchronous CRM Fetch request.

Arguments

Argument	Type	Description
output	String	A string defining the output format: Array, JSON, XML or DynamicEntities.
online	Boolean	Optional parameter determining whether the fetch should be executed online or offline. If omitted, function respects current online/offline mode of the app.

Return value

Type: Promise<any[]>

A Promise object which will be resolved with array of objects having type specified by output argument.

MobileCRM.FetchXml.Fetch.executeOffline Method

[v8.0] Performs the offline CRM Fetch request regardless of the app online/offline mode.

Arguments

Argument	Type	Description
output	String	A string defining the output format: Array, JSON, XML or DynamicEntities.
success	function(result)	A callback function for successful asynchronous result. The result argument will carry the objects array of type specified by output argument.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.FetchXml.Fetch.executeOnline Method

[v8.0] Performs the online CRM Fetch request regardless of the app online/offline mode.

Arguments

Argument	Type	Description
output	String	A string defining the output format: Array, JSON, XML or DynamicEntities.
success	function(result)	A callback function for successful asynchronous result. The result argument will carry the objects array of type specified by output argument.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.FetchXml.Fetch.serializeToXml Method

[v10.0] Serializes the Fetch object to XML.

Arguments

Argument	Type	Description
success	function(String)	A callback function for successful asynchronous result. The result argument will carry the XML representation of the Fetch object.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.FetchXml.Fetch.serializeToXmlAsync Method

[v10.0] Serializes the Fetch object to XML.

Return value

Type: Promise<string>

A Promise object which will be resolved with the XML representation of this Fetch object.

MobileCRM.FetchXml.Fetch.deserializeFromXml Function

Deserializes the Fetch object from XML.

Arguments

Argument	Type	Description
xml	String	A string defining the fetch XML request.
success	function(result: MobileCRM.FetchXml.Fetch)	A callback function for successful asynchronous result. The result argument will carry the Fetch object.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.FetchXml.Fetch.deserializeFromXmlAsync Function

Deserializes the Fetch object from XML.

Arguments

Argument	Type	Description
xml	String	A string defining the fetch XML request.

Return value

Type: Promise<MobileCRM.FetchXml.Fetch>

A Promise object which will be resolved with the Fetch object.

MobileCRM.FetchXml.Fetch.executeFromXML Function

Performs the asynchronous CRM Fetch command.

Arguments

Argument	Type	Description
fetchXmlData	String	CRM fetch in XML representation.
success	function(result)	A callback function for successful asynchronous result. The result argument will carry the objects array of type specified by resultformat XML attribute (Array, JSON, XML or DynamicEntities).
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

MobileCRM.FetchXml.Fetch.executeFromXmlAsync Function

Executes fetch XML asynchronously.

The format of result output is controlled by internal XML attribute "resultformat" on root fetch XML element.

Arguments

Argument	Type	Description
fetchXmlData	String	CRM fetch in XML representation.

Return value

Type: Promise

A promise object fulfilled with the array of objects having type specified by resultformat XML attribute (Array, JSON, XML or DynamicEntities).

MobileCRM.FetchXml.Filter Object

Represents a FetchXml filter statement. A logical combination of Conditions and child-filters.

Properties

Property	Type	Description
conditions	Array	An array of Condition objects.
filters	Array	An array of Filter objects representing child-filters.
type	String	Defines the filter operator ("or" / "and").

Methods

Method	Description
between	Adds a condition that the passed attribute is between the passed bounds.
contains	Adds a condition that the passed column starts with the passed string.
isIn	Adds a attribute inclusion condition to the filter.
notIn	Adds a attribute inclusion condition to the filter.
startsWith	Adds a condition that the passed column value contains the passed string.
where	Adds a attribute condition to the filter.

MobileCRM.FetchXml.Filter.between Method

Adds a condition that the passed attribute is between the passed bounds.

Arguments

Argument	Type	Description
attribute	String	The attribute name (CRM logical field name).
low	Depends on attribute type	The lower bound.
high	Depends on attribute type	The higher bound.

Return value

Type: MobileCRM.FetchXml.Condition

The condition instance.

MobileCRM.FetchXml.Filter.contains Method

Adds a condition that the passed column starts with the passed string.

Arguments

Argument	Type	Description
attribute	String	The attribute name (CRM logical field name).
value	String	The value to compare to.

Return value

Type: MobileCRM.FetchXml.Condition

The condition instance.

MobileCRM.FetchXml.Filter.isIn Method

Adds a attribute inclusion condition to the filter.

Arguments

Argument	Type	Description
attribute	String	The attribute name (CRM logical field name).
values	Array	An array of values.

Return value

Type: MobileCRM.FetchXml.Condition

The condition instance.

MobileCRM.FetchXml.Filter.notIn Method

Adds a attribute inclusion condition to the filter.

Arguments

Argument	Type	Description
attribute	String	The attribute name (CRM logical field name).
values	Array	An array of values.

Return value

Type: MobileCRM.FetchXml.Condition

The condition instance.

MobileCRM.FetchXml.Filter.startsWith Method

Adds a condition that the passed column value contains the passed string.

Arguments

Argument	Type	Description
attribute	String	The attribute name (CRM logical field name).
value	String	The value to compare to.

Return value

Type: MobileCRM.FetchXml.Condition

The condition instance.

MobileCRM.FetchXml.Filter.where Method

Adds a attribute condition to the filter.

Arguments

Argument	Type	Description
attribute	String	The attribute name (CRM logical field name).
op	String	The condition operator. "eq", "ne", "lt", "le", "gt", "ge", "like"
value	Depends on attribute type	The values to compare to.

Return value

Type: MobileCRM.FetchXml.Condition

The condition instance.

MobileCRM.FetchXml.LinkEntity Object

Represents a FetchXml query linked entity.

This object is derived from MobileCRM.FetchXml.Entity

Properties

Property	Type	Description
alias	String	A link alias.
from	String	The "from" field (if parent then target entity primary key).
linktype	String	The link (join) type ("inner" or "outer").
to	String	The "to" field.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.FetchXml.LinkEntity object.

MobileCRM.FetchXml.LinkEntity.constructor Method

Constructs an instance of MobileCRM.FetchXml.LinkEntity object.

Arguments

Argument	Type	Description
name	String	An entity name

MobileCRM.FetchXml.Order Object

Represents a FetchXml order statement.

Properties

Property	Type	Description
alias	String	Defines an order alias.
attribute	String	An attribute name (CRM logical field name).
descending	Boolean	true, for descending order; false, for ascending order.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.FetchXml.Order object.

MobileCRM.FetchXml.Order.constructor Method

Constructs an instance of MobileCRM.FetchXml.Order object.

Arguments

Argument	Type	Description
attribute	String	An attribute name (CRM logical field name).
descending	Boolean	true, for descending order; false, for ascending order

MobileCRM.UI Namespace

Contains a set of objects implementing the Javascript equivalent of the MobileCRM application UI components.

These objects are not available under Essential license.

Objects

Object	Description
ChartDataSource	The data source loading routine implementation.
EntityChart	[13.0] Represents the Javascript equivalent of native entity chart object.
EntityForm	Represents the Javascript equivalent of native entity form object.
EntityList	[v9.2] Represents the Javascript equivalent of native entity list object.
EntityListCellAction	Enumeration class holding constants for MobileCRM.UI.EntityListClickEvent.
EntityListClickContext	Represents a context for the MobileCRM.UI.EntityList.onClick handler.
EntityListClickEvent	Represents an event object for MobileCRM.UI.EntityListClickContext.
Form	[v8.0] Represents the Javascript equivalent of the form object.
FormManager	A static object with functions allowing to open the entity forms.
HomeForm	[v8.0] Represents the Javascript equivalent of the home form object which contains the Home/UI replacement iFrame.
IFrameForm	[v9.0] Represents the iFrame form object.
ListDataSource	The data source loading routine implementation.
LookupForm	This object allows user to select an entity from a configurable list of entity types.
MediaTab	Represents the MediaTab controller.
MessageBox	This object allows the user to show a popup window and choose one of the actions.
MultiLookupForm	[v9.3] This object allows user to select a list of entities from a configurable list of entity types. Derived from LookupForm so you can use the addView() and addEntityFilter() methods.
ProcessController	[v8.2] Represents the Javascript equivalent of view process controller.
QuestionnaireForm	[v10.3] Represents the Javascript equivalent of native questionnaire form object.
ReportForm	[v8.1] Represents the Dynamics CRM report form object.
RoutePlan	[v14.2] Represents the Javascript equivalent view of RoutePlan form object.
TourplanForm	Represents the Javascript equivalent tourplan form object.
TourplanViewMode	Enumeration class holding constants for MobileCRM.UI.TourplanForm.
ViewController	Represents the Javascript equivalent of view controller (map/web content).
ViewDefinition	Represents the entity view definition.
_AppointmentView	Represents the Javascript equivalent view of tourplan form object.
_Controller	Represents the Javascript equivalent of the view controller object.
_DetailItem	Represents the Javascript equivalent of detail item which is controlling the field editing.
_DetailView	Represents the Javascript equivalent of detail view with set of items responsible for fields editing.
_DocumentController	Represents Media tab controller containing specific kind of document.
_DocumentInfo	Represents information about attached document.
_DocumentView	Represents the document view object containing the attachment document (binary field content).
_EntityList	Represents the Javascript equivalent of the entity list controller object.
_ListView	Represents the Javascript equivalent of the list view (control) object.
_View	Represents the Javascript equivalent of the view (control) object.

MobileCRM.UI.ChartDataSource Object

The data source loading routine implementation.

An instance of this object can be used to supply the data source for MobileCRM.UI.EntityChart.setDataSource function.

Properties

Property	Type	Description
type	string	Chart type in string
data	object	Object of chart dataset

MobileCRM.UI.EntityChart Object

[13.0] Represents the Javascript equivalent of native entity chart object.

This object is not available under Essential license.

Functions

Function	Description
setDataSource	Sets the chart data source replacement.

MobileCRM.UI.EntityChart.setDataSource Function

Sets the chart data source replacement.

Data source must be set during the document load stage and must not be delayed.

It is used only if the entity view iFrame is marked as data source provider in Woodford.

Arguments

Argument	Type	Description
dataSource	MobileCRM.UI.ChartDataSource	A data source object implementing the EntityChart loading routine.

MobileCRM.UI.EntityForm Object

Represents the Javascript equivalent of native entity form object.

This object cannot be created directly. To obtain/modify this object, use MobileCRM.UI.EntityForm.requestObject function.
This object is not available under Essential license.

Properties

Property	Type	Description
associatedViews	Array	Gets the associated views as an array of MobileCRM.UI._EntityList objects.
bulkUpdateItems	Array	A list of entity records editted on this bulk update form.
canEdit	Boolean	Gets whether the form can be edited.
canClose	Boolean	Determines if form can be closed, i.e. there are no unsaved data being edited.
context	Object	Gets the specific context object for onChange and onSave handlers. The onChange context contains single property "changedItem" with the name of the changed detail item and the onSave context contains property "errorMessage" which can be used to break the save process with certain error message.
controllers	Array	Gets the form controllers (map, web) as an array of MobileCRM.UI._Controller objects.
detailViews	Array	Gets the detailView controls as an array of MobileCRM.UI._DetailView objects.
isBulkUpdateForm	Boolean	Indicates whether the form is bulk update form.
entity	MobileCRM.DynamicEntity	Gets or sets the entity instance the form is showing.
form	MobileCRM.UI.Form	Gets the top level form.
iFrameOptions	Object	Carries the custom parameters that can be specified when opening the form using MobileCRM.UI.FormManager.
isDirty	Boolean	Indicates whether the form has unsaved data.
relationship	MobileCRM.Relationship	Defines relationship with parent entity.
visible	Boolean	Gets whether the underlying form is visible.
documentView	MobileCRM.UI._DocumentView	NoteForm only. Gets the view containing the note attachment.

Methods

Method	Description
cancelValidation	Stops the onSave validation and optionally causes an error message to be displayed.
getController	Returns the tab controller by its view name.
getDetailView	Returns the DetailView by its name.
getEntityList	Returns the entity list by its view name.
getMediaTab	Gets the MediaTab object representing the media tab with given name.
reactivateEntity	Reactivates inactive entity and reloads the form.
selectTab	[v8.0] Selects the form tab by its name.
selectView	Selects the associated entity list view by its name.
setTabVisibility	Sets the visibility of the form tab defined by its name.
suspendPostSave	[v8.2] Suspends current "onPostSave" operations and allows performing another asynchronous tasks before the form is closed.
suspendSave	Suspends current "onSave" validation and allows performing another asynchronous tasks to determine the validation result
updateAddressFields	Sets the address fields according to the current geo-location from platform-specific location service.

Functions

Function	Description
closeWithoutSaving	Closes the form ignoring all changes that have been made on it.
enableCommand	Enables or disables the form command.
executeCommandByName	[v8.1] Execute the command with the passed name. The command must exist and must be enabled.
isViewMaximized	[v8.1] Inspects whether the passed view is maximized or restored.
leaveUiTransaction	[v18.0] Provides means to control concurrent access to data by form logic and background sync. This method releases the last clearance obtained by successful call to tryEnterUiTransaction. Can be called even if all clearances are already released or were not obtained at all. See tryEnterUiTransaction for more info.
loadTab	[v10.1] (Re)loads the tab of the passed name.
maximizeView	[v8.1] Makes the passed view maximized/restored.
onCanExecuteCommand	Binds or unbinds the handler called when the EntityForm needs to find out whether the command can be executed (is enabled).
onChange	Binds or unbinds the handler for onChange event on EntityForm.
onCommand	Binds or unbinds the handler for EntityForm command.
onItemChange	[v11.2] Binds or unbinds the handler for specific item change event on EntityForm.
onPostSave	[v8.2] Binds or unbinds the handler for onPostSave event on EntityForm.
onProcessLoaded	Binds or unbinds the handler for onProcessLoaded event on EntityForm.
onSave	Binds or unbinds the handler for onSave event on EntityForm.
onSelectedViewChanged	[v9.3] Binds or unbinds the handler for onSelectedViewChanged event on EntityForm.
openSalesEntityDetail	[v8.2] Shows an entity edit dialog.
refreshForm	Reloads the form's edit state.
requestObject	Requests the managed EntityForm object.
save	[v9.0]Saves the form entity and its children and refreshes the form.
saveAndClose	Saves edited entity and closes the form.
selectTabEx	[v8.0] Selects the form tab by its name.
setFieldValue	[v18.0] Sets the field value on entity record shown on this EntityForm.
setFieldValues	[v18.0] Sets several field values on entity record loaded on this EntityForm.
setFileFieldContent	[v18.2] Sets the file field content and file name on entity record shown on this EntityForm.
showPleaseWait	Shows a please wait message, disabling the form except for the close command.
tryEnterUiTransaction	[v18.0] Provides means to control concurrent access to data by form logic and background sync. This method obtains a clearance to perform data manipulation. The clearance will be obtained when background sync is not running, or form sync behavior is configured as 'No action'. If background sync is running and form sync behavior is configured to 'Block save during sync' or 'Block save during sync and prevent sync while form is open'", the clearance is not obtained. Each obtained clearance must be dutifully released using leaveUiTransaction(). It is possible to call this method multiple times, but each call reserves its own internal clearance, so there must be the same number of calls to leaveUiTransaction to properly release clearance and allow background sync.

Objects

Object	Description
DetailCollection	Provides functions accessing the collection of the sales entity details (e.g. Order details)

MobileCRM.UI.EntityForm.cancelValidation Method

Stops the onSave validation and optionally causes an error message to be displayed.

Arguments

Argument	Type	Description
errorMsg	String	An error message to be displayed or "null" to cancel the validation without message.

MobileCRM.UI.EntityForm.getController Method

Returns the tab controller by its view name.

Arguments

Argument	Type	Description
name	String	A name of controller's view.

Return value

Type: MobileCRM.UI._Controller

A MobileCRM.UI._Controller object with requested view name.

MobileCRM.UI.EntityForm.getDetailView Method

Returns the DetailView by its name.

Arguments

Argument	Type	Description
name	String	A name of DetailView.

Return value

Type: MobileCRM.UI._DetailView

A MobileCRM.UI._DetailView object with requested name.

MobileCRM.UI.EntityForm.getEntityList Method

Returns the entity list by its view name.

Arguments

Argument	Type	Description
name	String	A name of entity list view.

Return value

Type: MobileCRM.UI._EntityList

A MobileCRM.UI._EntityList object with requested view name.

MobileCRM.UI.EntityForm.getMediaTab Method

Gets the MediaTab object representing the media tab with given name.

Return value

Type: MobileCRM.UI.MediaTab

A MobileCRM.UI.MediaTab object representing the media tab, or "null", if the tab was not found.

MobileCRM.UI.EntityForm.reactivateEntity Method

Reactivates inactive entity and reloads the form.

Arguments

Argument	Type	Description
statuscode	Number	Activation status code.

MobileCRM.UI.EntityForm.selectTab Method

[v8.0] Selects the form tab by its name.

Arguments

Argument	Type	Description
tabName	String	The name of the tab.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.EntityForm.selectView Method

Selects the associated entity list view by its name.

Arguments

Argument	Type	Description
tabName	String	The name of the associated entity list tab.
viewName	String	The view name.

Return value

Type: Boolean

true, if the view selection was initiated; false, if tab was not found.

MobileCRM.UI.EntityForm.setTabVisibility Method

Sets the visibility of the form tab defined by its name.

Arguments

Argument	Type	Description
tabName	String	The name of the tab
visible	Boolean	Defines desired visibility state.

Return value

Type: Boolean

true, if the visibility change was initiated; false, if tab was not found.

MobileCRM.UI.EntityForm.suspendPostSave Method

[v8.2] Suspends current "onPostSave" operations and allows performing another asynchronous tasks before the form is closed.

Return value

Type: Object

A request object with single method "resumePostSave" which has to be called to resume the post-save operations.

MobileCRM.UI.EntityForm.suspendSave Method

Suspends current "onSave" validation and allows performing another asynchronous tasks to determine the validation result

Return value

Type: Object

A request object with single method "resumeSave" which has to be called with the validation result (either error message string or "null" in case of success). To cancel the validation without any message, pass "#NoMessage#" text to this method.

MobileCRM.UI.EntityForm.updateAddressFields Method

Sets the address fields according to the current geo-location from platform-specific location service.

Arguments

Argument	Type	Description
latitude	Number	The latitude from geo-location from platform-specific location service
longitude	Number	longitude from geo-location from platform-specific location service

MobileCRM.UI.EntityForm.closeWithoutSaving Function

Closes the form ignoring all changes that have been made on it.

MobileCRM.UI.EntityForm.enableCommand Function

Enables or disables the form command.

Arguments

Argument	Type	Description
command	String	The name of the command.
enable	Boolean	Determines whether to enable or disable the command.
iParam	Number	[v9.1] Optional parameter defining the additional command parameter (like status code value for "ChangeStatus" command).

MobileCRM.UI.EntityForm.executeCommandByName Function

[v8.1] Execute the command with the passed name. The command must exist and must be enabled.

Arguments

Argument	Type	Description
command	String	The name of the EntityForm command.
callback	function(entityForm)	The callback function that is called asynchronously in case of success.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityForm.isViewMaximized Function

[v8.1] Inspects whether the passed view is maximized or restored.

Arguments

Argument	Type	Description
viewName	String	The name of the view which has to be maximized/restored.
callback	function(Boolean)	Asynchronous callback which is called with Boolean result: true, if the view is maximized; false, if it is restored.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityForm.leaveUiTransaction Function

[v18.0] Provides means to control concurrent access to data by form logic and background sync. This method releases the last clearance obtained by successful call to tryEnterUiTransaction. Can be called even if all clearances are already released or were not obtained at all. See tryEnterUiTransaction for more info.

Return value

Type: Promise<void>

Returns an awaitable promise.

MobileCRM.UI.EntityForm.loadTab Function

[v10.1] (Re)loads the tab of the passed name.

Arguments

Argument	Type	Description
tabName	String	The name of the tab.
load	Boolean	Whether to (re)load or unload a view.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.EntityForm.maximizeView Function

[v8.1] Makes the passed view maximized/restored.

Arguments

Argument	Type	Description
viewName	String	The name of the view which has to be maximized/restored.
maximize	Boolean	true, to maximize the view; false, to restore it.

MobileCRM.UI.EntityForm.onCanExecuteCommand Function

Binds or unbinds the handler called when the EntityForm needs to find out whether the command can be executed (is enabled).

Arguments

Argument	Type	Description
command	String	The name of the EntityForm command. Optionally can contain the param value separated by slash (e.g. ChangeStatus/5).
handler	function(entityForm)	The handler function that has to be bound or unbound. Handler's return value indicates whether the command is enabled (true/false).
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityForm.onChange Function

Binds or unbinds the handler for onChange event on EntityForm.

Arguments

Argument	Type	Description
handler	function(entityForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityForm.onCommand Function

Binds or unbinds the handler for EntityForm command.

Arguments

Argument	Type	Description
command	String	The name of the EntityForm command.
handler	function(entityForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityForm.onItemChange Function

[v11.2] Binds or unbinds the handler for specific item change event on EntityForm.

Arguments

Argument	Type	Description
itemName	String	The name of desired detail item (mostly logical name of the field).
handler	function(entityForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityForm.onPostSave Function

[v8.2] Binds or unbinds the handler for onPostSave event on EntityForm.

Arguments

Argument	Type	Description
handler	function(entityForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityForm.onProcessLoaded Function

Binds or unbinds the handler for onProcessLoaded event on EntityForm.

Arguments

Argument	Type	Description
handler	function(entityForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityForm.onSave Function

Binds or unbinds the handler for onSave event on EntityForm.

Arguments

Argument	Type	Description
handler	function(entityForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityForm.onSelectedViewChanged Function

[v9.3] Binds or unbinds the handler for onSelectedViewChanged event on EntityForm.

Bound handler is called with the EntityForm object as an argument. The EntityForm context object contains "selectedView" property with the name of currently selected view.

Arguments

Argument	Type	Description
handler	function(entityForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityForm.openSalesEntityDetail Function

[v8.2] Shows an entity edit dialog.

Arguments

Argument	Type	Description
detail	MobileCRM.DynamicEntity	detail entity.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.

MobileCRM.UI.EntityForm.refreshForm Function

Reloads the form's edit state.

MobileCRM.UI.EntityForm.requestObject Function

Requests the managed EntityForm object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of EntityForm object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(entityForm)	The callback function that is called asynchronously with serialized EntityForm object as argument. Callback should return true to apply changed properties.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityForm.save Function

[v9.0]Saves the form entity and its children and refreshes the form.

MobileCRM.UI.EntityForm.saveAndClose Function

Saves edited entity and closes the form.

MobileCRM.UI.EntityForm.selectTabEx Function

[v8.0] Selects the form tab by its name.

Arguments

Argument	Type	Description
tabName	String	The name of the tab.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.EntityForm.setFieldValue Function

[v18.0] Sets the field value on entity record shown on this EntityForm.

Arguments

Argument	Type	Description
fieldName	String	Logical name of the field that has to be changed.
value	any	New value of entity field with given name.

Return value

Type: Promise<boolean>

A promise resolved with boolean result of native field setter.

MobileCRM.UI.EntityForm.setFieldValues Function

[v18.0] Sets several field values on entity record loaded on this EntityForm.

Arguments

Argument	Type	Description
changes	{ [fieldName: string]: any }	An object defining field changes that has to be done on form entity record.

Return value

Type: Promise<boolean>

A promise resolved with boolean result of native field setter.

MobileCRM.UI.EntityForm.setFileFieldContent Function

[v18.2] Sets the file field content and file name on entity record shown on this EntityForm.

Setting file field content is possible only in offline mode. This method fails in online mode.

Arguments

Argument	Type	Description
fieldName	String	Logical name of the file field that has to be changed.
documentFileName	String	A file name that should be used when presenting the binary content.
documentContent	String	Base64-encoded binary file content.

Return value

Type: Promise<boolean>

A promise resolved with boolean result of native field setter.

MobileCRM.UI.EntityForm.showPleaseWait Function

Shows a please wait message, disabling the form except for the close command.

Arguments

Argument	Type	Description
caption	String	Wait message.

Return value

Type: Object

An object representing the UI component with single method "close".

MobileCRM.UI.EntityForm.tryEnterUiTransaction Function

[v18.0] Provides means to control concurrent access to data by form logic and background sync. This method obtains a clearance to perform data manipulation. The clearance will be obtained when background sync is not running, or form sync behavior is configured as 'No action'. If background sync is running and form sync behavior is configured to 'Block save during sync' or 'Block save during sync and prevent sync while form is open'", the clearance is not obtained. Each obtained clearance must be dutifully released using leaveUiTransaction(). It is possible to call this method multiple times, but each call reserves its own internal clearance, so there must be the same number of calls to leaveUiTransaction to properly release clearance and allow background sync.

Return value

Type: Promise<boolean>

Returns true if clearance is obtained, false if it is not possible at this time.

MobileCRM.UI.EntityForm.DetailCollection Object

Provides functions accessing the collection of the sales entity details (e.g. Order details)

Functions

Function	Description
add	Appends the product into sales order collection.
addAsync	[v10.0] Appends the product into sales order collection.
addProductWithQuantity	[v10.0] Appends the product into sales order collection.
deleteById	Deletes the sales entity detail (e.g. Order detail) by id.
deleteByIndex	Deletes the sales entity detail (e.g. Order detail) by index.
get	Asynchronously returns requested sales entity detail (e.g. Order detail)
getAll	Asynchronously returns the collection of the sales entity details (e.g. Order details)
getAllAsync	Asynchronously returns the collection of the sales entity details (e.g. Order details)
getAsync	Asynchronously returns requested sales entity detail (e.g. Order detail)
onChange	[v8.2] Binds or unbinds the handler which is called when the list of sales details changes.

MobileCRM.UI.EntityForm.DetailCollection.add Function

Appends the product into sales order collection.

Resulting MobileCRM.DynamicEntity object implements method "update" which can be used to update the entity properties in the sales detail collection.

Arguments

Argument	Type	Description
product	MobileCRM.Reference	A reference of the product to be appended.
callback	function(MobileCRM.DynamicEntity)	The callback function which is called asynchronously with MobileCRM.DynamicEntity object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityForm.DetailCollection.addAsync Function

[v10.0] Appends the product into sales order collection.

Resulting MobileCRM.DynamicEntity object implements method "update" which can be used to update the entity properties in the sales detail collection.

Arguments

Argument	Type	Description
product	MobileCRM.Reference	A reference of the product to be appended.
quantity	Number	Product quantity.

Return value

Type: Promise<MobileCRM.DynamicEntity>

A Promise object which will be resolved with the DynamicEntity object representing new sales entity detail record.

MobileCRM.UI.EntityForm.DetailCollection.addProductWithQuantity Function

[v10.0] Appends the product into sales order collection.

Resulting MobileCRM.DynamicEntity object implements method "update" which can be used to update the entity properties in the sales detail collection.

Arguments

Argument	Type	Description
product	MobileCRM.Reference	A reference of the product to be appended.
quantity	Number	Product quantity.
callback	function(MobileCRM.DynamicEntity)	The callback function which is called asynchronously with MobileCRM.DynamicEntity object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityForm.DetailCollection.deleteById Function

Deletes the sales entity detail (e.g. Order detail) by id.

Arguments

Argument	Type	Description
id	String	An id of the item to be deleted.
callback	Function	The callback function which is called asynchronously in case of success.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityForm.DetailCollection.deleteByIndex Function

Deletes the sales entity detail (e.g. Order detail) by index.

Arguments

Argument	Type	Description
index	Number	An index of the item to be deleted.
callback	Function	The callback function which is called asynchronously in case of success.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityForm.DetailCollection.get Function

Asynchronously returns requested sales entity detail (e.g. Order detail)

Arguments

Argument	Type	Description
index	Number	An index of requested item.
callback	function(MobileCRM.DynamicEntity)	The callback function that is called asynchronously with the MobileCRM.DynamicEntity object as argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityForm.DetailCollection.getAll Function

Asynchronously returns the collection of the sales entity details (e.g. Order details)

Arguments

Argument	Type	Description
callback	function(Array)	The callback function that is called asynchronously with an array of MobileCRM.DynamicEntity objects as argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityForm.DetailCollection.getAllAsync Function

Asynchronously returns the collection of the sales entity details (e.g. Order details)

Return value

Type: Promise<MobileCRM.DynamicEntity[]>

A Promise object which will be resolved with an array of DynamicEntity objects representing the sales entity detail records.

MobileCRM.UI.EntityForm.DetailCollection.getAsync Function

Asynchronously returns requested sales entity detail (e.g. Order detail)

Arguments

Argument	Type	Description
index	Number	An index of requested item.

Return value

Type: Promise<MobileCRM.DynamicEntity>

A Promise object which will be resolved with the DynamicEntity object representing the sales entity detail record.

MobileCRM.UI.EntityForm.DetailCollection.onChange Function

[v8.2] Binds or unbinds the handler which is called when the list of sales details changes.

Arguments

Argument	Type	Description
handler	function(entityForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityList Object

[v9.2] Represents the Javascript equivalent of native entity list object.

This object is not available under Essential license.

Properties

Property	Type	Description
allowAddExisting	Boolean	Gets or sets whether adding an existing entity is allowed.
allowCreateNew	Boolean	Gets or sets whether create a new entity (or managing the N:N entities in the case of N:N list) is allowed.
allowedDocActions	Number	Gets or sets a mask of document actions (for Note and Sharepoint document lists).
allowSearch	Boolean	Gets or sets whether to show the search bar.
autoWideWidth	String	Gets the view auto width pixel size.
context	Object	[v10.0] Gets the specific context object for onChange, onSave and onCommand handlers. The onSave context contains property "entities" with the list of all changed entities and property "errorMessage" which can be used to cancel the save process with certain error message. The onChange handler context contains "entities" property with the list of currently changed entities (typically just one entity) and property "propertyName" with the field name that was changed. Command handler context contains the "cmdParam" property and "entities" property with the list of currently selected entities.
entityName	String	Gets the name of the entities in this list.
flipMode	Number	Gets or sets the flip configuration (which views to show and which one is the initial).
hasMapViews	Boolean	Gets whether the list has a view that can be displayed on map.
hasCalendarViews	Boolean	Gets or sets whether there is a view with "CalendarFields".
hasMoreButton	Boolean	Gets whether the list needs a more button.
internalName	String	Gets the internal list name. Used for localization and image lookup.
isDirty	Boolean	Gets or sets whether the list is dirty.
isLoaded	Boolean	Gets or sets whether the list is loaded.
isMultiSelect	Boolean	Gets whether multi selection is active.
listButtons	Array	Gets the read-only array of strings defining the list buttons.
listMode	Number	Gets the current list mode.
listView	MobileCRM.UI._ListView	Gets the controlled listView control.
lookupSource	MobileCRM.Relationship	Gets the lookup source. If the list is used for lookup this is the entity whose property is being "looked-up".
options	Number	Gets the kinds of views available on the list.
relationship	MobileCRM.Relationship	Gets the relation source and related entity. "null", if there is no relationship (if it is not an associated list).
selectedEntity	MobileCRM.DynamicEntity	Gets currently selected entity. "null", if there's no selection.
uniqueName	Number	Gets or sets the unique name of the list. Used to save/load list specific settings.

Methods

Method	Description
suspendSave	[v10.0] Suspends current "onSave" validation and allows performing another asynchronous tasks to determine the validation result

Functions

Function	Description
clickCell
onCellClick	[v18.1] Binds or unbinds the handler for onCellClick event on EntityList.
onChange	[v10.0] Binds or unbinds the handler for onChange event on EntityList.
onClick	[v10.1] Binds or unbinds the handler for onClick event on EntityList.
onCommand	Binds or unbinds the handler for EntityList command.
onSave	[v10.0] Binds or unbinds the handler for onSave event on EntityList.
reload	Initiates asynchronous entity list reload.
requestEditedEntities	[v10.0] Asynchronously gets the list of entities that were changed on the list.
requestObject	Requests the EntityList object.
runCommand	Executes the list/button command attached to this entity list.
selectView	Selects specified EntityList view.
setDataSource	Deprecated: Please use setDataSourceFactory instead. Sets the entity list data source replacement.
setDataSourceFactory	[v11.0.2] Sets the entity list data source replacement factory.
setEntityProperty	[v10.1] Sets the value of the entity property.
setPrimaryCommand	Overrides the entity list's primary command button.
startEditCell

MobileCRM.UI.EntityList.suspendSave Method

[v10.0] Suspends current "onSave" validation and allows performing another asynchronous tasks to determine the validation result

Return value

Type: Object

MobileCRM.UI.EntityList.clickCell Function

Opens an entity form for lookup content record. Performs appropriate action for cells bound to the phone/email/web formatted fields.

Arguments

Argument	Type	Description
rowIndex	Number	The index of the row to click on.
cellIndex	Number	The index of the cell.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.EntityList.onCellClick Function

[v18.1] Binds or unbinds the handler for onCellClick event on EntityList.

Bound handler is called with the EntityList object as an argument. The EntityList context property contains EntityListClickContext object.

Arguments

Argument	Type	Description
propertyName	String	The name of desired cell within the list item.
handler	function(entityList)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityList.onChange Function

[v10.0] Binds or unbinds the handler for onChange event on EntityList.

Bound handler is called with the EntityList object as an argument. The EntityList context object contains "entities" property with the list of currently changed entities (typically just one entity) and property "propertyName" with the field name that was changed.

Arguments

Argument	Type	Description
handler	function(entityList)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityList.onClick Function

[v10.1] Binds or unbinds the handler for onClick event on EntityList.

Bound handler is called with the EntityList object as an argument. The EntityList context property contains EntityListClickContext object.

Arguments

Argument	Type	Description
handler	function(entityList)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityList.onCommand Function

Binds or unbinds the handler for EntityList command.

Bound handler is called with the EntityList object as an argument. The EntityList context object contains the "cmdParam" property and "entities" property with the list of currently selected entities.

Arguments

Argument	Type	Description
command	String	The name of the EntityList command.
handler	function(entityList)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityList.onSave Function

[v10.0] Binds or unbinds the handler for onSave event on EntityList.

Bound handler is called with the EntityList object as an argument. The EntityList context object contains "entities" property with the list of all changed entities and property "errorMessage" that can be used to cancel save with an error.

Arguments

Argument	Type	Description
handler	function(entityList)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.EntityList.reload Function

Initiates asynchronous entity list reload.

MobileCRM.UI.EntityList.requestEditedEntities Function

[v10.0] Asynchronously gets the list of entities that were changed on the list.

Arguments

Argument	Type	Description
callback	function(DynamicEntity[])	Callback obtaining an array of dynamic entities that were changed on the list.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityList.requestObject Function

Requests the EntityList object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of EntityList object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(entityList)	The callback function that is called asynchronously with serialized EntityList object as argument See MobileCRM.UI.EntityList for further details.. Callback should return true to apply changed properties.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.EntityList.runCommand Function

Executes the list/button command attached to this entity list.

Arguments

Argument	Type	Description
commandName	String	A name of the command. It can be either custom command or one of following predefined commands:
parameter	Number	A command parameter (e.g. the status code value for ChangeStatus command).
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.EntityList.selectView Function

Selects specified EntityList view.

Arguments

Argument	Type	Description
viewName	String	The name of the entity view which has to be selected.

MobileCRM.UI.EntityList.setDataSource Function

Deprecated: Please use setDataSourceFactory instead. Sets the entity list data source replacement.

Data source must be set during the document load stage and must not be delayed.

It is used only if the entity view iFrame is marked as data source provider in Woodford.

Arguments

Argument	Type	Description
dataSource	MobileCRM.UI.ListDataSource	A data source object implementing the DynamicEntity list loading routine.

MobileCRM.UI.EntityList.setDataSourceFactory Function

[v11.0.2] Sets the entity list data source replacement factory.

Data source must be set during the document load stage and must not be delayed.

It is used only if the entity view iFrame is marked as data source provider in Woodford.

Arguments

Argument	Type	Description
dataSourceFactory	Function	A function that returns an object implementing the DynamicEntity list loading routine.

MobileCRM.UI.EntityList.setEntityProperty Function

[v10.1] Sets the value of the entity property.

Arguments

Argument	Type	Description
rowIndex	Number	The index of the entity in the list.
propertyName	String	The name of the property.
editValue	any	the new property value.
saveImmediately	Boolean	Indicates whether to save entity immediately or whether to just make it dirty.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.EntityList.setPrimaryCommand Function

Overrides the entity list's primary command button.

Arguments

Argument	Type	Description
labels	Array/String	An array of labels or single label (e.g. "New").
callback	Function	A callback which is called when command is launched.
scope	Object	A scope, in which the callback has to be called.

MobileCRM.UI.EntityList.startEditCell Function

Arguments

Argument	Type	Description
rowIndex	Number	The index of the row to edit.
cellIndex	Number	The index of the cell.
saveImmediately	Boolean	Indicates whether to save entity immediately after change or whether to just make it dirty.
binding	Number	Optional, if null the binding from the cell index will be used.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.EntityListCellAction Object

Enumeration class holding constants for MobileCRM.UI.EntityListClickEvent.

Properties

Property	Type	Description
Text	Number	Cell displaying data bound or constant text.
Image	Number	Cell displaying data bound or constant image.
Button	Number	Clickable button cell.
InlineButton	Number	The inline button. iOS only.
Editable	Number	The cell is editable. Or together with Text kind.
Clickable	Number	The cell is clickable. Or together with Text kind.
DirectEdit	Number	The cell is editable and will be saved right after change. Or together with Text kind.
ActionMask	Number	The cell is editable or clickable.

MobileCRM.UI.EntityListClickContext Object

Represents a context for the MobileCRM.UI.EntityList.onClick handler.

Properties

Property	Type	Description
entities	Array	Single item array containing the DynamicEntity object representing clicked entity.
propertyName	String	The field name that was clicked within the list item.
event	MobileCRM.UI.EntityListClickEvent	Event details.

MobileCRM.UI.EntityListClickEvent Object

Represents an event object for MobileCRM.UI.EntityListClickContext.

Properties

Property	Type	Description
cell	Number	An index of the cell in row template.
row	Number	The row index.
binding	Number	A binding value.
action	Number	Click action flags. Use constant from MobileCRM.UI.EntityListCellAction enumeration.

MobileCRM.UI.Form Object

[v8.0] Represents the Javascript equivalent of the form object.

This object is not available under Essential license.

Properties

Property	Type	Description
canMaximize	Boolean	Gets or sets whether form can be maximized to fullscreen (full application frame).
isMaximized	Boolean	Gets or sets whether form is currently maximized to fullscreen (full application frame).
isModal	Boolean	Indicates whether this form is presented as modal window.
caption	String	Gets or sets the form caption.
selectedViewIndex	Number	Gets or sets the selected view (tab) index.
showTitle	Boolean	[v8.1] Determines whether the form caption bar should be visible.
viewCount	Number	Gets the count of views in the form.
visible	Boolean	Gets whether the form is visible.

Functions

Function	Description
requestObject	[v8.0] Requests the currently opened Form object.
showPleaseWait	Shows a please wait message, disabling the form except for the close command.
showToast	Shows a toast window over the app window which is dismissed after a few seconds.

MobileCRM.UI.Form.requestObject Function

[v8.0] Requests the currently opened Form object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of Form object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(form)	The callback function that is called asynchronously with serialized Form object as argument. Callback should return true to apply changed properties.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.Form.showPleaseWait Function

Shows a please wait message, disabling the form except for the close command.

Arguments

Argument	Type	Description
caption	String	Wait message.

Return value

Type: Object

An object representing the UI component with single method "close".

MobileCRM.UI.Form.showToast Function

Shows a toast window over the app window which is dismissed after a few seconds.

Arguments

Argument	Type	Description
message	String	A toast content message.
icon	String	Valid app image name (e.g. Home.Now.png).

MobileCRM.UI.FormManager Object

A static object with functions allowing to open the entity forms.

Functions

Function	Description
showDetailDialog	Shows an entity detail dialog.
showEditDialog	Shows an entity edit dialog.
showNewDialog	Shows a new entity dialog.

MobileCRM.UI.FormManager.showDetailDialog Function

Shows an entity detail dialog.

Arguments

Argument	Type	Description
entityName	String	The entity name.
id	String	GUID of the existing entity.
relationship	MobileCRM.RelationShip	The optional relationship with a parent entity.

MobileCRM.UI.FormManager.showEditDialog Function

Shows an entity edit dialog.

Arguments

Argument	Type	Description
entityName	String	The entity name.
id	String	GUID of the existing entity or null for new one.
relationship	MobileCRM.RelationShip	The optional relationship with a parent entity.
options	Object	A JSON object containing a form-specific properties like pre-defined field values, peer iFrame options or document options.

MobileCRM.UI.FormManager.showNewDialog Function

Shows a new entity dialog.

Arguments

Argument	Type	Description
entityName	String	The entity name.
relationship	MobileCRM.RelationShip	The optional relationship with a parent entity.
options	Object	A JSON object containing a form-specific properties like pre-defined field values, peer iFrame options or document options.

MobileCRM.UI.HomeForm Object

[v8.0] Represents the Javascript equivalent of the home form object which contains the Home/UI replacement iFrame.

This class works only from Home/UI replacement iFrame.

This object cannot be created directly. To obtain/modify this object, use MobileCRM.UI.HomeForm.requestObject function.

This object is not available under Essential license.

Properties

Property	Type	Description
form	MobileCRM.UI.Form	Gets the top level form.
items	Array	Gets the list of the home items.
listView	MobileCRM.UI._ListController	Gets the list view with home items.
lastSyncResult	MobileCRM.Services.SynchronizationResult	[v8.1] An object with last sync results. Contains following boolean properties: newCustomizationReady, customizationDownloaded, dataErrorsEncountered, appWasLocked, syncAborted, adminFullSync, wasBackgroundSync
syncResultText	String	[v8.1] The last synchronization error text.
syncProgress	Object	[v8.1] An object with current sync progress. Contains following properties: labels, percent. It is undefined if no sync is running.

Functions

Function	Description
closeForms	[v8.0] Close all opened forms.
closeHomeItemAsync	[v8.0] Close the specified HomeItem.
hideUIReplacement	[v8.0] Hides the UI replacement iframe and shows the classic home form.
onSyncFinished	[v8.1] Binds the new handler to the synchronization finish event.
openHomeGroupItemAsync	[v10.1.1] Opens the specified HomeItem in specific group.
openHomeItemAsync	[v8.0] Opens the specified HomeItem.
requestObject	[v8.0] Requests the managed HomeForm object.
restoreUIReplacement	[v11.0] Restores previously hidden UI replacement iframe and hides the classic home form.
updateHomeItemAsync	[v10.2] Updates specified HomeItem in specific group.
updateHomeItems	[v10.3] Updates specified home items.

MobileCRM.UI.HomeForm.closeForms Function

[v8.0] Close all opened forms.

Arguments

Argument	Type	Description
callback	function()	The callback function that is called asynchronously after forms were closed successfully.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.HomeForm.closeHomeItemAsync Function

[v8.0] Close the specified HomeItem.

Arguments

Argument	Type	Description
name	String	The name of the HomeItem to be opened. It can be either the entity logical name (e.g. "contact"), custom name as defined in Woodford or one of following special names: "@Dashboard", "@Map", "@activity", "@Tourplan","@CallImport","@Setup","@About".
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.HomeForm.hideUIReplacement Function

[v8.0] Hides the UI replacement iframe and shows the classic home form.

MobileCRM.UI.HomeForm.onSyncFinished Function

[v8.1] Binds the new handler to the synchronization finish event.

Arguments

Argument	Type	Description
handler	function(homeForm)	A function which will be called when the synchronization finished event occurs with current instance of the MobileCRM.UI.HomeForm as parameter.
scope	Object	A scope in which the handler should be called.

MobileCRM.UI.HomeForm.openHomeGroupItemAsync Function

[v10.1.1] Opens the specified HomeItem in specific group.

Arguments

Argument	Type	Description
items	Array	A list of group and subgroups representing the path to the home item.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.HomeForm.openHomeItemAsync Function

[v8.0] Opens the specified HomeItem.

Arguments

Argument	Type	Description
name	String	The name of the HomeItem to be opened. It can be either the entity logical name (e.g. "contact") or one of following special forms names: "@Dashboard", "@Map", "activity", "@Tourplan","@CallImport","@Setup","@About".
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.HomeForm.requestObject Function

[v8.0] Requests the managed HomeForm object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of HomeForm object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(homeForm)	The callback function that is called asynchronously with serialized HomeForm object as argument. Callback should return true to apply changed properties.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.HomeForm.restoreUIReplacement Function

[v11.0] Restores previously hidden UI replacement iframe and hides the classic home form.

MobileCRM.UI.HomeForm.updateHomeItemAsync Function

[v10.2] Updates specified HomeItem in specific group.

Arguments

Argument	Type	Description
items	Array	A list of group and subgroups representing the path to the home item.
title	String	The title for the home item.
subTitle	String	The title for the home item.
badge	String	The title for the home item.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.HomeForm.updateHomeItems Function

[v10.3] Updates specified home items.

Arguments

Argument	Type	Description
items	Array	A list of home item that has to be changed. Each home item is an object with following properties: path, title, subTitle, badge, isVisible.

MobileCRM.UI.IFrameForm Object

[v9.0] Represents the iFrame form object.

This object is not available under Essential license.

Properties

Property	Type	Description
form	MobileCRM.UI.Form	Gets the form hosting the iFrame.
isDirty	Boolean	[v10.0] Controls whether the form is dirty and requires save, or whether it can be closed.
options	Object	Carries the custom parameters that can be specified when opening the form using MobileCRM.UI.IFrameForm.show function.
preventCloseMessage	String	[v9.3] Prevents closing the form if non-empty string is set. No other home-item can be opened and synchronization is not allowed to be started. Provided message is shown when user tries to perform those actions.
saveBehavior	Number	[v10.0] Controls the behavior of the Save command on this form (0=Default, 1=SaveOnly, 2=SaveAndClose).

Methods

Method	Description
suspendSave	[v10.0] Suspends current "onSave" process and allows performing asynchronous tasks to save the data.

Functions

Function	Description
onSave	[v10.0] Binds or unbinds the handler for saving content of this iFrame.
preventClose	[v10.0] Sets the warning message that should be shown when user tries to close the form.
requestObject	[v9.0] Asynchronously requests the IFrameForm object.
setDirty	[v10.0] Sets the dirty flag which prevents the form being closed. App asks to save the form before saving and if user chooses to save it, it calls the save routine defined in IFrameForm.saveCommand.
show	Shows a new iFrame form.
showModal	Shows a new iFrame form in modal window.

MobileCRM.UI.IFrameForm.suspendSave Method

[v10.0] Suspends current "onSave" process and allows performing asynchronous tasks to save the data.

Return value

Type: Object

A request object with single method "resumeSave" which has to be called with the result (either error message string or "null" in case of success). To cancel the validation without any message, pass "#NoMessage#" text to this method.

MobileCRM.UI.IFrameForm.onSave Function

[v10.0] Binds or unbinds the handler for saving content of this iFrame.

Bound handler is called with the IFrameForm object as an argument.

The IFrameForm context object contains property "errorMessage" that can be used to cancel save with an error.

Use suspendSave method to suspend the save process if an asynchronous operation is required.

Arguments

Argument	Type	Description
handler	function(IFrameForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.IFrameForm.preventClose Function

[v10.0] Sets the warning message that should be shown when user tries to close the form.

Set to "null" to allow the form close.

MobileCRM.UI.IFrameForm.requestObject Function

[v9.0] Asynchronously requests the IFrameForm object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of IFrameForm object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(iFrameForm)	The callback function that is called asynchronously with serialized MobileCRM.UI.IFrameForm object as argument. Callback should return true to apply changed properties.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.IFrameForm.setDirty Function

[v10.0] Sets the dirty flag which prevents the form being closed. App asks to save the form before saving and if user chooses to save it, it calls the save routine defined in IFrameForm.saveCommand.

MobileCRM.UI.IFrameForm.show Function

Shows a new iFrame form.

Arguments

Argument	Type	Description
caption	String	Defines the form caption.
url	String	Defines the URL of the HTML document.
maximized	Boolean	Indicates whether the new form should be maximized.
options	Object	Generic object passed to the new iFrame (see MobileCRM.UI.IFrameForm.requestObject).

MobileCRM.UI.IFrameForm.showModal Function

Shows a new iFrame form in modal window.

Arguments

Argument	Type	Description
caption	String	Defines the form caption.
url	String	Defines the URL of the HTML document.
options	Object	Generic object passed to the new iFrame.

MobileCRM.UI.ListDataSource Object

The data source loading routine implementation.

An instance of this object can be used to supply the data source for MobileCRM.UI.EntityList.setDataSourceFactory function.

The instance of this object is valid only if the method loadNextChunk is implemented. See example here.

Properties

Property	Type	Description
chunkSize	Number	Controls the number of entities loaded in once.
fetch	MobileCRM.FetchXml.Fetch	Gets the original fetch request for this list view.
loadNextChunk	function(page, count)	Controls the number of entities loaded in once. It is called from native code to get chunk (array) of DynamicEntities. The chunk is defined by 1-based page number and the desired count which corresponds to the value of chunkSize property.

Methods

Method	Description
chunkReady	This method has to be called from within the "loadNextChunk" routine when it loads chunk (array) of DynamicEntities.

MobileCRM.UI.ListDataSource.chunkReady Method

This method has to be called from within the "loadNextChunk" routine when it loads chunk (array) of DynamicEntities.

Data source enumeration ends when the chunkReady method is called with empty array (no more records are available).

Arguments

Argument	Type	Description
entities	Array[MobileCRM.DynamicEntity]	A chunk (array) of DynamicEntities that has to be passed back to the native code to fill in to the list view.

MobileCRM.UI.LookupForm Object

This object allows user to select an entity from a configurable list of entity types.

This object is not available under Essential license.

Properties

Property	Type	Description
entities	Array	An array of allowed entity kinds (schema names).
allowedViews	String	OBSOLETE: Allowed views, or null if all are allowed.
source	MobileCRM.Relationship	The entity whose property will be set to the chosen value.
prevSelection	MobileCRM.Reference	The entity whose property will be set to the chosen value.
allowNull	Boolean	Whether to allow selecting no entity.
preventClose	Boolean	Whether to prevent closing form without choosing a value.

Methods

Method	Description
addEntityFilter	Defines a fetch XML filter for entity records.
addView	Appends an entity view to the list of allowed views.
show	Shows a dialog which allows the user to select an entity from a configurable list of entity types.
showAsync	Shows a dialog which allows the user to select an entity from a configurable list of entity types.

MobileCRM.UI.LookupForm.addEntityFilter Method

Defines a fetch XML filter for entity records.

Arguments

Argument	Type	Description
entityName	string	Entity logical name.
filterXml	string	A string defining the fetch XML which has to be applied as filter for entity records.

MobileCRM.UI.LookupForm.addView Method

Appends an entity view to the list of allowed views.

Arguments

Argument	Type	Description
entityName	string	Entity logical name.
viewName	string	A name of the view.
isDefault	Boolean	true, if the view should be set as default.

MobileCRM.UI.LookupForm.show Method

Shows a dialog which allows the user to select an entity from a configurable list of entity types.

Arguments

Argument	Type	Description
success	function(obj)	The callback function that is called with chosen MobileCRM.Reference object.
failed	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.LookupForm.showAsync Method

Shows a dialog which allows the user to select an entity from a configurable list of entity types.

Return value

Type: Promise<MobileCRM.Reference>

A Promise object which will be resolved with a Reference object representing chosen entity record.

MobileCRM.UI.MediaTab Object

Represents the MediaTab controller.

An instance of this class can only be obtained by calling the MobileCRM.UI.EntityForm.getMediaTab method.

Methods

Method	Description
capturePhoto	Captures photo on this media tab.
clear	Clears the content of this media tab.
export	Saves to file to disk.
getData	[v8.0] Gets the media tab document in form of base64 string.
getDataAsync	[v8.0] Gets the media tab document in form of base64 string.
getDocumentInfo	[v8.0.1] Asynchronously gets the media tab view object.
getNoteSubject	[v10.1] Asynchronously gets the subject text of the note loaded on the media tab.
isEmpty	[v9.0.2] Asynchronously gets the boolean value indicating whether the media tab content is empty or not.
open	Opens the loaded document in a external application. Which application is platform specific.
print	Prints the document.
recordAudio	Executes the record audio command on this media tab.
recordVideo	Executes the record video command on this media tab.
selectFile	Executes the select file command on this media tab.
selectPhoto	Executes the select photo command on this media tab.
setCommandsMask	[v11.1] Sets the mask of allowed document actions.
setEditable	[v11.1] Marks the MediaTab as editable.
setNoteSubject	[v10.1] Asynchronously sets the name of the note to load (and save).

Functions

Function	Description
getData	[v8.0] Gets the media tab document in form of base64 string.
getDataAsync	[v8.0] Gets the media tab document in form of base64 string.

MobileCRM.UI.MediaTab.capturePhoto Method

Captures photo on this media tab.

MobileCRM.UI.MediaTab.clear Method

Clears the content of this media tab.

MobileCRM.UI.MediaTab.export Method

Saves to file to disk.

MobileCRM.UI.MediaTab.getData Method

[v8.0] Gets the media tab document in form of base64 string.

Arguments

Argument	Type	Description
callback	function(String)	The callback function that is called asynchronously with the base64-encoded document data.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.MediaTab.getDataAsync Method

[v8.0] Gets the media tab document in form of base64 string.

Return value

Type: Promise<string>

A Promise object which will be resolved with the base64-encoded document data.

MobileCRM.UI.MediaTab.getDocumentInfo Method

[v8.0.1] Asynchronously gets the media tab view object.

Arguments

Argument	Type	Description
callback	function(Object)	The callback function that is called asynchronously with the document info object.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.MediaTab.getNoteSubject Method

[v10.1] Asynchronously gets the subject text of the note loaded on the media tab.

Arguments

Argument	Type	Description
callback	function(String)	The callback function that is called asynchronously with the media tab note subject.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.MediaTab.isEmpty Method

[v9.0.2] Asynchronously gets the boolean value indicating whether the media tab content is empty or not.

Arguments

Argument	Type	Description
callback	function(Boolean)	The callback function that is called asynchronously with the boolean value indicating whether the content is empty or not.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.MediaTab.open Method

Opens the loaded document in a external application. Which application is platform specific.

MobileCRM.UI.MediaTab.print Method

Prints the document.

MobileCRM.UI.MediaTab.recordAudio Method

Executes the record audio command on this media tab.

MobileCRM.UI.MediaTab.recordVideo Method

Executes the record video command on this media tab.

MobileCRM.UI.MediaTab.selectFile Method

Executes the select file command on this media tab.

MobileCRM.UI.MediaTab.selectPhoto Method

Executes the select photo command on this media tab.

MobileCRM.UI.MediaTab.setCommandsMask Method

[v11.1] Sets the mask of allowed document actions.

Arguments

Argument	Type	Description
commandMask	Number	Specifies the mask of allowed commands.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.

MobileCRM.UI.MediaTab.setEditable Method

[v11.1] Marks the MediaTab as editable.

Arguments

Argument	Type	Description
editable	Boolean	Indicates whether to mark MediaTab as editable.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.

MobileCRM.UI.MediaTab.setNoteSubject Method

[v10.1] Asynchronously sets the name of the note to load (and save).

Arguments

Argument	Type	Description
subject	String	The name of the note to load (and save).
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.MediaTab.getData Function

[v8.0] Gets the media tab document in form of base64 string.

Arguments

Argument	Type	Description
viewName	String	The name of the media tab.
callback	function(String)	The callback function that is called asynchronously with the base64-encoded document data.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.MediaTab.getDataAsync Function

[v8.0] Gets the media tab document in form of base64 string.

Arguments

Argument	Type	Description
viewName	String	The name of the media tab.

Return value

Type: Promise<string>

A Promise object which will be resolved with the base64-encoded document data.

MobileCRM.UI.MessageBox Object

This object allows the user to show a popup window and choose one of the actions.

Properties

Property	Type	Description
items	Array	An array of button names.
title	string	The message box title.
defaultText	string	The cancel button title text.
multiLine	Boolean	Indicates whether the message is multi line.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.MessageBox object.
show	Shows a popup window which allows the user to choose one of the actions.
showAsync	Shows a popup window allowing user to choose one of actions.

Functions

Function	Description
sayText	Shows a simple popup window with a multi-line text.
sayTextAsync	Shows a simple popup window with a multi-line text.

MobileCRM.UI.MessageBox.constructor Method

Constructs an instance of MobileCRM.UI.MessageBox object.

Arguments

Argument	Type	Description
title	string	The message box title.
defaultText	string	The cancel button title text.

MobileCRM.UI.MessageBox.show Method

Shows a popup window which allows the user to choose one of the actions.

Arguments

Argument	Type	Description
success	function(obj)	The callback function that is called with chosen item string.
failed	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.MessageBox.showAsync Method

Shows a popup window allowing user to choose one of actions.

Return value

Type: Promise<string>

A Promise object which will be resolved with chosen item string.

MobileCRM.UI.MessageBox.sayText Function

Shows a simple popup window with a multi-line text.

Arguments

Argument	Type	Description
text	String	A text to be shown.
success	function	The callback function that is called after user closes the message box.
failed	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.MessageBox.sayTextAsync Function

Shows a simple popup window with a multi-line text.

Arguments

Argument	Type	Description
text	String	A text to be shown.

Return value

Type: Promise<void>

A Promise object which will be resolved when user closes the message box.

MobileCRM.UI.MultiLookupForm Object

[v9.3] This object allows user to select a list of entities from a configurable list of entity types. Derived from LookupForm so you can use the addView() and addEntityFilter() methods.

This object is not available under Essential license.

Properties

Property	Type	Description
entities	Array	An array of allowed entity kinds (schema names).
source	MobileCRM.Relationship	The entity whose property will be set to the chosen value.
dataSource	MobileCRM.Reference[]	The list of entities that should be displayed as selected.
allowNull	Boolean	Whether to allow selecting no entity.
initialTab	Number	Optional index of the tab which has to be pre-selected - 0=All Items, 1=Selected Items (default).

Methods

Method	Description
addEntityFilter	Defines a fetch XML filter for entity records.
addView	Appends an entity view to the list of allowed views.
show	Shows a dialog which allows the user to select a list of entities from a configurable list of entity types.
showAsync	Shows a dialog which allows the user to select a list of entities from a configurable list of entity types.

MobileCRM.UI.MultiLookupForm.addEntityFilter Method

Defines a fetch XML filter for entity records.

Arguments

Argument	Type	Description
entityName	string	Entity logical name.
filterXml	string	A string defining the fetch XML which has to be applied as filter for entity records.

MobileCRM.UI.MultiLookupForm.addView Method

Appends an entity view to the list of allowed views.

Arguments

Argument	Type	Description
entityName	string	Entity logical name.
viewName	string	A name of the view.
isDefault	Boolean	true, if the view should be set as default.

MobileCRM.UI.MultiLookupForm.show Method

Shows a dialog which allows the user to select a list of entities from a configurable list of entity types.

Arguments

Argument	Type	Description
success	function(obj)	The callback function that is called with chosen array of MobileCRM.Reference objects.
failed	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.MultiLookupForm.showAsync Method

Shows a dialog which allows the user to select a list of entities from a configurable list of entity types.

Return value

Type: Promise<MobileCRM.Reference[]>

A Promise object which will be resolved with an array of Reference objects representing chosen entity records.

MobileCRM.UI.ProcessController Object

[v8.2] Represents the Javascript equivalent of view process controller.

It is not intended to create an instance of this class. To obtain this object, use EntityForm.requestObject function and locate the controller in form's "controllers" list.

This object is not available under Essential license.

Properties

Property	Type	Description
currentStateInfo	Object	Gets the information about the current process flow state (active stage, visible stage and process).

Methods

Method	Description
changeProcess	[v8.2] Changes (or clears) the business process flow for the current entity.
moveToNextStage	[15.0] Progresses to the next stage of the active process.
moveToPreviousStage	[15.0] Moves to the previous stage of the active process.

MobileCRM.UI.ProcessController.changeProcess Method

[v8.2] Changes (or clears) the business process flow for the current entity.

Arguments

Argument	Type	Description
processRef	MobileCRM.Reference	A reference to the workflow entity defining the process to use, or null to disable BusinessProcessFlow.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.ProcessController.moveToNextStage Method

[15.0] Progresses to the next stage of the active process.

Arguments

Argument	Type	Description
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.ProcessController.moveToPreviousStage Method

[15.0] Moves to the previous stage of the active process.

Arguments

Argument	Type	Description
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callback.

MobileCRM.UI.QuestionnaireForm Object

[v10.3] Represents the Javascript equivalent of native questionnaire form object.

This object is not available under Essential license.

Properties

Property	Type	Description
form	MobileCRM.UI.Form	Gets the form which hosts the questionnaire.
groups	MobileCRM.UI.QuestionnaireForm.Group[]	A list of QuestionnaireForm.Group objects.
questions	MobileCRM.UI.QuestionnaireForm.Question[]	A list of QuestionnaireForm.Question objects.
relationship	MobileCRM.Relationship	Gets the relation source and related entity. "null", if there is no relationship.

Methods

Method	Description
cancelValidation	Stops the onSave validation and optionally causes an error message to be displayed.
findGroupById	Returns the question group with given id.
findGroupByName	Returns the question group with given name.
findQuestionById	Returns the question item with given id.
findQuestionByName	Returns the question item with given name.
suspendPostSave	Suspends current "onPostSave" operations and allows performing another asynchronous tasks before the form is closed.
suspendSave	Suspends current "onSave" validation and allows performing another asynchronous tasks to determine the validation result

Functions

Function	Description
changeLookupQuestionSetup	Sets the views and filters for specified lookup question.
deleteGroup	Deletes an instance of repeatable group with all its questions and adjusts the repeatIndex for all instances of the same template group with higher index.
executeQuestionAction	[v19.1] Asynchronously focuses the question and executes its operations, e.g. Scan Barcode, Run OCR, etc...
focusQuestion	Asynchronously sets the focus on given question.
getQuestionnaireEntity	Requests the Questionnaire entity.
onAnswerChanged	[v11.2] Binds or unbinds the handler for specific question change event on QuestionnaireForm.
onChange	Binds or unbinds the handler for onChange event on QuestionnaireForm.
onCommand	Binds or unbinds the handler for QuestionnaireForm command.
onDeleteGroup	Binds or unbinds the handler for onDeleteGroup event on QuestionnaireForm.
onPostSave	Binds or unbinds the handler for onPostSave event on QuestionnaireForm.
onRepeatGroup	Binds or unbinds the handler for onRepeatGroup event on QuestionnaireForm.
onSave	Binds or unbinds the handler for onSave event on QuestionnaireForm.
overridePicklistOptions	Overrides the list of options for given picklist question.
repeatGroup	Duplicates repeatable group with all its questions. The name of the group will contain the lowest available repeatIndex and suffix in form #00X.
repeatGroupAsync	Duplicates repeatable group with all its questions. The name of the group will contain the lowest available repeatIndex and suffix in form #00X.
requestObject	Requests the managed QuestionnaireForm object.
trySetAnswer	Asynchronously sets the answer value for given question.
trySetImageAnswer	Asynchronously sets the answer value for given image question.

Objects

Object	Description
Group
Question

MobileCRM.UI.QuestionnaireForm.cancelValidation Method

Stops the onSave validation and optionally causes an error message to be displayed.

Arguments

Argument	Type	Description
errorMsg	String	An error message to be displayed or "null" to cancel the validation without message.

MobileCRM.UI.QuestionnaireForm.findGroupById Method

Returns the question group with given id.

Arguments

Argument	Type	Description
name	String	An id of the question group.

Return value

Type: MobileCRM.UI.QuestionnaireForm.Group

MobileCRM.UI.QuestionnaireForm.findGroupByName Method

Returns the question group with given name.

Arguments

Argument	Type	Description
name	String	A name of the question group.

Return value

Type: MobileCRM.UI.QuestionnaireForm.Group

MobileCRM.UI.QuestionnaireForm.findQuestionById Method

Returns the question item with given id.

Arguments

Argument	Type	Description
id	String	An id of the question item.

Return value

Type: MobileCRM.UI.QuestionnaireForm.Question

MobileCRM.UI.QuestionnaireForm.findQuestionByName Method

Returns the question item with given name.

Arguments

Argument	Type	Description
name	String	A name of the question item.

Return value

Type: MobileCRM.UI.QuestionnaireForm.Question

MobileCRM.UI.QuestionnaireForm.suspendPostSave Method

Suspends current "onPostSave" operations and allows performing another asynchronous tasks before the form is closed.

Return value

Type: Object

A request object with single method "resumePostSave" which has to be called to resume the post-save operations.

MobileCRM.UI.QuestionnaireForm.suspendSave Method

Suspends current "onSave" validation and allows performing another asynchronous tasks to determine the validation result

Return value

Type: Object

MobileCRM.UI.QuestionnaireForm.changeLookupQuestionSetup Function

Sets the views and filters for specified lookup question.

Arguments

Argument	Type	Description
questionName	String	A name of the question.
dialogSetup	MobileCRM.UI.DetailViewItems.LookupSetup	Lookup setup for modal lookup dialog.
inlinePickSetup	MobileCRM.UI.DetailViewItems.LookupSetup	Optional setup for inline lookup picker. Leave empty to use the same setup as modal dialog.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.deleteGroup Function

Deletes an instance of repeatable group with all its questions and adjusts the repeatIndex for all instances of the same template group with higher index.

Arguments

Argument	Type	Description
id	String	Id of the source group.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.executeQuestionAction Function

[v19.1] Asynchronously focuses the question and executes its operations, e.g. Scan Barcode, Run OCR, etc...

Arguments

Argument	Type	Description
questionName	String	A name of the question.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.focusQuestion Function

Asynchronously sets the focus on given question.

Arguments

Argument	Type	Description
questionName	String	A name of the question.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.getQuestionnaireEntity Function

Requests the Questionnaire entity.

Arguments

Argument	Type	Description
callback	function(entity)	The callback function that is called asynchronously with a DynamicEntity object representing currently opened questionnaire. Callback should return true to apply changed properties.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.onAnswerChanged Function

[v11.2] Binds or unbinds the handler for specific question change event on QuestionnaireForm.

Arguments

Argument	Type	Description
questionName	String	The name of desired question.
handler	function(questionnaireForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.QuestionnaireForm.onChange Function

Binds or unbinds the handler for onChange event on QuestionnaireForm.

Arguments

Argument	Type	Description
handler	function(questionnaireForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.QuestionnaireForm.onCommand Function

Binds or unbinds the handler for QuestionnaireForm command.

Arguments

Argument	Type	Description
command	String	The name of the QuestionnaireForm command.
handler	function(questionnaireForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.QuestionnaireForm.onDeleteGroup Function

Binds or unbinds the handler for onDeleteGroup event on QuestionnaireForm.

Arguments

Argument	Type	Description
handler	function(questionnaireForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.QuestionnaireForm.onPostSave Function

Binds or unbinds the handler for onPostSave event on QuestionnaireForm.

Arguments

Argument	Type	Description
handler	function(questionnaireForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.QuestionnaireForm.onRepeatGroup Function

Binds or unbinds the handler for onRepeatGroup event on QuestionnaireForm.

Arguments

Argument	Type	Description
handler	function(questionnaireForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.QuestionnaireForm.onSave Function

Binds or unbinds the handler for onSave event on QuestionnaireForm.

Arguments

Argument	Type	Description
handler	function(questionnaireForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.QuestionnaireForm.overridePicklistOptions Function

Overrides the list of options for given picklist question.

Arguments

Argument	Type	Description
questionName	String	A name of the picklist question.
allowNull	Boolean	Indicates whether the empty answer is allowed.
options	Object	An object with label-to-value mappings, e.g. {"Option 1":1,"Option 2":2}.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.repeatGroup Function

Duplicates repeatable group with all its questions. The name of the group will contain the lowest available repeatIndex and suffix in form #00X.

Arguments

Argument	Type	Description
id	String	Id of the source group.
copyValues	Boolean	Optional paramater determining whether the group values should be copied to the new instance of this group.

Return value

Type: Promise

A promise that resolves when the group is duplicated.

MobileCRM.UI.QuestionnaireForm.repeatGroupAsync Function

Duplicates repeatable group with all its questions. The name of the group will contain the lowest available repeatIndex and suffix in form #00X.

Arguments

Argument	Type	Description
id	String	Id of the source group.
copyValues	Boolean	Optional paramater determining whether the group values should be copied to the new instance of this group.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.requestObject Function

Requests the managed QuestionnaireForm object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of QuestionnaireForm object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(questionnaireForm)	The callback function that is called asynchronously with serialized QuestionnaireForm object as argument. Callback should return true to apply changed properties.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.trySetAnswer Function

Asynchronously sets the answer value for given question.

Arguments

Argument	Type	Description
questionName	String	A name of the question.
answer	any	A value that has to be set as answer. It must correspond to the type of question.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.trySetImageAnswer Function

Asynchronously sets the answer value for given image question.

Arguments

Argument	Type	Description
imageQuestionName	String	A name of the image question.
base64Data	string	A value that us used to create image answer. If null or empty image will be deleted.
mimeType	string	The valid mime type of corresponding base64Data.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.Group Object

Properties

Property	Type	Description
id	String	Gets the id of this question group.
name	String	Gets the name of the question group.
index	Number	Gets the index of the question group.
label	String	Gets the question group label.
description	String	Get the question group description.
templateGroup	String	Gets the id of parent group from questionnaire template.
repeatIndex	Number	Index of this instance of repeatable group. Zero for non-repeatable groups.
repeatEnabled	Boolean	Indicates whether the group is repeatable.
isVisible	Boolean	Gets or sets whether the group is visible.
isEnabled	Boolean	Gets or sets whether the group is enabled.
isExpanded	Boolean	Gets or sets whether the group is expanded (true) or collapsed (false).

Methods

Method	Description
deleteGroup	Deletes this instance of repeatable group with all its questions and adjusts the repeatIndex for all instances of the same template group with higher index.
repeatGroup	Duplicates repeatable group with all its questions. The name of the group will contain the lowest available repeatIndex and suffix in form #00X.
repeatGroupAsync	Duplicates repeatable group with all its questions. The name of the group will contain the lowest available repeatIndex and suffix in form #00X.

MobileCRM.UI.QuestionnaireForm.Group.deleteGroup Method

Deletes this instance of repeatable group with all its questions and adjusts the repeatIndex for all instances of the same template group with higher index.

Arguments

Argument	Type	Description
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.Group.repeatGroup Method

Duplicates repeatable group with all its questions. The name of the group will contain the lowest available repeatIndex and suffix in form #00X.

Arguments

Argument	Type	Description
copyValues	Boolean	Optional parameter determining whether the group values should be copied to the new instance of this group.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.Group.repeatGroupAsync Method

Duplicates repeatable group with all its questions. The name of the group will contain the lowest available repeatIndex and suffix in form #00X.

Arguments

Argument	Type	Description
copyValues	Boolean	Optional parameter determining whether the group values should be copied to the new instance of this group.

Return value

Type: Promise

A promise that resolves when the group is duplicated.

MobileCRM.UI.QuestionnaireForm.Question Object

Properties

Property	Type	Description
id	String	Gets the id of this question record.
name	String	Gets the name of the question item.
label	String	Gets or sets the question item label.
index	Number	Gets the index of the question item.
groupId	String	Gets the id of parent question group (may be empty).
description	String	Get or sets the question item description.
type	Number	Gets the value type of the question item.
value	Any	Gets current answer value. To change it, use trySetAnswer method.
style	String	Gets or sets the question item style name.
isAnswered	Boolean	Indicates whether the item is answered.
isVisible	Boolean	Indicates whether the item is visible.
isEnabled	Boolean	Indicates whether the item is enabled.
focus	Boolean	Set to true to focus the question item.
validate	Boolean	Indicates whether the item should be validated.
errorMessage	String	Holds the error message text related to current value of the question item.

Methods

Method	Description
focus	Asynchronously sets the focus on this question.
trySetAnswer	Asynchronously sets the answer value for this question.

MobileCRM.UI.QuestionnaireForm.Question.focus Method

Asynchronously sets the focus on this question.

Arguments

Argument	Type	Description
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.QuestionnaireForm.Question.trySetAnswer Method

Asynchronously sets the answer value for this question.

Arguments

Argument	Type	Description
answer	any	A value that has to be set as answer. It must correspond to the type of question (String/Number/Reference/Guid).
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.ReportForm Object

[v8.1] Represents the Dynamics CRM report form object.

This object is not available under Essential license.

Properties

Property	Type	Description
allowedReportIds	Array	The list of report entity ids that has to be included in the report form selector.
allowedLanguages	Array	The list of LCID codes of the languages that has to be included into the report form selector. The number -1 stands for "Any language".
defaultReport	String	The primary name of the report entity that should be pre-selected on the report form.

Methods

Method	Description
show	Shows the Dynamics CRM report form.

MobileCRM.UI.ReportForm.show Method

Shows the Dynamics CRM report form.

Arguments

Argument	Type	Description
success	function(obj)	The callback function that is called if the report form was successfully opened.
failed	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.RoutePlan Object

[v14.2] Represents the Javascript equivalent view of RoutePlan form object.

This object is not available under Essential license.

Properties

Property	Type	Description
myRoute	DynamicEntity[]	A list of route entities.
completedEntities	DynamicEntity[]	A list of completed entities that are about to be removed from route plan.
routeEntityName	String	Logical name of the route visit entity.
routeDay	Date	Currently selected route day.
isDirty	Boolean	Controls whether the form is dirty and requires save, or whether it can be closed.

Methods

Method	Description
suspendPostSave	Suspends current "onPostSave" operations and allows performing another asynchronous tasks before the form is closed.
suspendSave	Suspends current "onSave" process and allows performing asynchronous tasks to save the data.

Functions

Function	Description
onItemAdded	Binds or unbinds the handler for "Item Added" event.
onItemCompleted	Binds or unbinds the handler for "Item Completed" event.
onItemPostSave	Binds or unbinds the handler for further actions on saved visit entity.
onItemRemoved	Binds or unbinds the handler for "Item Removed" event.
onItemSave	Binds or unbinds the handler for validating single visit entity save.
onPostSave	Binds or unbinds the handler for further actions on saved route.
onRouteReloaded	Binds or unbinds the handler called after route is reloaded.
onSave	Binds or unbinds the handler for route save validation.
requestObject	Requests the managed RoutePlan object.

MobileCRM.UI.RoutePlan.suspendPostSave Method

Suspends current "onPostSave" operations and allows performing another asynchronous tasks before the form is closed.

Return value

Type: Object

A request object with single method "resumePostSave" which has to be called to resume the post-save operations.

MobileCRM.UI.RoutePlan.suspendSave Method

Suspends current "onSave" process and allows performing asynchronous tasks to save the data.

Return value

Type: Object

MobileCRM.UI.RoutePlan.onItemAdded Function

Binds or unbinds the handler for "Item Added" event.

Bound handler is called with the RoutePlan object as an argument.

The RoutePlan context object contains property "entity" carrying DynamicEntity object of the new visit record.

Arguments

Argument	Type	Description
handler	function(RoutePlan)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.RoutePlan.onItemCompleted Function

Binds or unbinds the handler for "Item Completed" event.

Bound handler is called with the RoutePlan object as an argument.

The RoutePlan context object contains property "entity" carrying DynamicEntity object af completed visit record being removed from route plan.

Arguments

Argument	Type	Description
handler	function(RoutePlan)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.RoutePlan.onItemPostSave Function

Binds or unbinds the handler for further actions on saved visit entity.

Bound handler is called with the RoutePlan object as an argument.

The RoutePlan context object contains property "errorMessage" that can be used to cancel save with an error.

Use suspendSave method to suspend the save process if an asynchronous operation is required and property "savedEntity" carrying saved DynamicEntity object.

Arguments

Argument	Type	Description
handler	function(RoutePlan)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.RoutePlan.onItemRemoved Function

Binds or unbinds the handler for "Item Removed" event.

Bound handler is called with the RoutePlan object as an argument.

The RoutePlan context object contains property "entity" carrying DynamicEntity object of unsaved visit record being removed from route plan.

Arguments

Argument	Type	Description
handler	function(RoutePlan)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.RoutePlan.onItemSave Function

Binds or unbinds the handler for validating single visit entity save.

Bound handler is called with the RoutePlan object as an argument.

The RoutePlan context object contains property "errorMessage" that can be used to cancel save with an error and property "entityToSave" carrying visit DynamicEntity record.

Use suspendSave method to suspend the save process if an asynchronous operation is required.

Arguments

Argument	Type	Description
handler	function(RoutePlan)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.RoutePlan.onPostSave Function

Binds or unbinds the handler for further actions on saved route.

Bound handler is called with the RoutePlan object as an argument.

Use suspendPostSave method to suspend the post-save process if an asynchronous operation is required.

Arguments

Argument	Type	Description
handler	function(RoutePlan)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.RoutePlan.onRouteReloaded Function

Binds or unbinds the handler called after route is reloaded.

Bound handler is called with the RoutePlan object as an argument on start or when day or filter field is changed.

Arguments

Argument	Type	Description
handler	function(RoutePlan)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.RoutePlan.onSave Function

Binds or unbinds the handler for route save validation.

Bound handler is called with the RoutePlan object as an argument.

The RoutePlan context object contains property "errorMessage" that can be used to cancel save with an error.

Use suspendSave method to suspend the save process if an asynchronous operation is required.

Arguments

Argument	Type	Description
handler	function(RoutePlan)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.RoutePlan.requestObject Function

Requests the managed RoutePlan object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of RoutePlan object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(platform)	The callback function that is called asynchronously with serialized RoutePlan object as argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.TourplanForm Object

Represents the Javascript equivalent tourplan form object.

This object cannot be created directly. To obtain/modify this object, use MobileCRM.UI.TourplanForm.requestObject function.

This object is not available under Essential license.

Properties

Property	Type	Description
isDirty	Boolean	Indicates whether the form has been modified.
isLoaded	Boolean	Gets or sets whether the form is loaded.
view	MobileCRM.UI._AppointmentView	Gets tourplan form view MobileCRM.UI.AppointmentView.

Functions

Function	Description
onCreateNew	[v11.3] Binds or unbinds the handler for creating new appointment after long-pressing on calendar.
requestObject	Requests the managed TourplanForm object.
setDate	Sets the current date in calendar view (Tourplan).
setMode	Sets the calendar view (Tourplan) mode.

MobileCRM.UI.TourplanForm.onCreateNew Function

[v11.3] Binds or unbinds the handler for creating new appointment after long-pressing on calendar.

Bound handler is called with the TourplanForm object as an argument. The context object contains "start", "end", "entityName" properties and optionally "subject" property.

Arguments

Argument	Type	Description
handler	function(tourplanForm)	The handler function that has to be bound or unbound.
bind	Boolean	Determines whether to bind or unbind the handler.
scope	Object	The scope for handler calls.

MobileCRM.UI.TourplanForm.requestObject Function

Requests the managed TourplanForm object.

Method initiates an asynchronous request which either ends with calling the errorCallback or with calling the callback with Javascript version of TourplanForm object. See MobileCRM.Bridge.requestObject for further details.

Arguments

Argument	Type	Description
callback	function(platform)	The callback function that is called asynchronously with serialized TourplanForm object as argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI.TourplanForm.setDate Function

Sets the current date in calendar view (Tourplan).

Arguments

Argument	Type	Description
date	Date	A date to set.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.

MobileCRM.UI.TourplanForm.setMode Function

Sets the calendar view (Tourplan) mode.

Arguments

Argument	Type	Description
mode	MobileCRM.UI.TourplanViewMode	A mode to set.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.

MobileCRM.UI.TourplanViewMode Object

Enumeration class holding constants for MobileCRM.UI.TourplanForm.

Properties

Property	Type	Description
Agenda	Number	Agenda view.
Day	Number	Day view.
Week	Number	Week view.
Month	Number	Month view.

MobileCRM.UI.ViewController Object

Represents the Javascript equivalent of view controller (map/web content).

This object is not available under Essential license.

Functions

Function	Description
createCommand	Overrides the form's primary/secondary command button.

MobileCRM.UI.ViewController.createCommand Function

Overrides the form's primary/secondary command button.

Arguments

Argument	Type	Description
primary	Boolean	true, for primary button; false, for secondary button.
labels	Array/String	An array of labels or single label.
callback	Function	A callback which is called when command is launched.
scope	Object	A scope, in which the callback has to be called.

MobileCRM.UI.ViewDefinition Object

Represents the entity view definition.

Properties

Property	Type	Description
entityName	String	Gets the entity this view is for.
name	String	Gets the name of the view.
fetch	String	Gets the fetchXml query.
kind	Number	Gets the kind of the view (public, associated, etc.).
version	Number	Gets the version.
buttons	String	Gets the view buttons.
selector	String	Gets the view template selector workflow.

Functions

Function	Description
loadEntityViews	Asynchronously loads all view definitions for given entity.

MobileCRM.UI.ViewDefinition.loadEntityViews Function

Asynchronously loads all view definitions for given entity.

Arguments

Argument	Type	Description
entityName	String	The entity name.
callback	function(viewDefArray)	The callback function which is called asynchronously. Callback will obtain an array of ViewDefinition objects.
errorCallback	function(errorMsg)	The errorCallback which is called asynchronously in case of error.
scope	Object	The scope for callbacks.

MobileCRM.UI._AppointmentView Object

Represents the Javascript equivalent view of tourplan form object.

Properties

Property	Type	Description
name	String	Gets the name of view.
isVisible	Boolean	Gets or sets whether the view is visible.
mode	MobileCRM.UI.TourplanViewMode	Gets a view mode MobileCRM.UI.TourplanViewMode.
currentDate	Date	Gets the current date of displayed view.

MobileCRM.UI._Controller Object

Represents the Javascript equivalent of the view controller object.

Properties

Property	Type	Description
isDirty	Boolean	Gets or sets whether the controller contains dirty data that should be saved.
isLoaded	Boolean	Gets or sets whether the controller is loaded.
view	MobileCRM.UI._View	Gets or sets the view (control) instance.

MobileCRM.UI._DetailItem Object

Represents the Javascript equivalent of detail item which is controlling the field editing.

Properties

Property	Type	Description
dataMember	String	Gets or sets the item data binding.
errorMessage	String	Gets or sets the item error message displayed during validation.
isEnabled	Boolean	Gets or sets whether the item is editable.
isNullable	Boolean	Gets or sets whether the item value can be "null".
isVisible	Boolean	Gets or sets whether the item is visible.
label	String	Gets or sets the item label.
name	String	Gets or sets the item name.
validate	Boolean	Gets or sets whether the item needs validation.

isPassword (text items only)	Boolean	Gets or sets whether the text value should be masked. Used for password entry.
kind (text items only)	Number	Gets or sets the value kind (0 for Text, 1 for Email, 2 for Url, 3 for Phone).
maxLength (text items only)	Number	Gets to sets the maximum text length.
numberOfLines (text items only)	Number	Number of lines to display. Default is one.
value (text items only)	String	Gets or sets the bound item value.

decimalPlaces (numeric items only)	Number	Gets or sets the number of decimal places.
displayFormat (numeric items only)	String
increment (numeric items only)	Number	Gets or sets the increment (if the Up/Down control is visible).
maximum (numeric items only)	Number	Gets or sets the maximum allowed value.
minimum (numeric items only)	Number	Gets or sets the minimum allowed value.
upDownVisible (numeric items only)	Boolean	Gets or sets whether the up/down control is visible.
value (numeric items only)	Number	Gets or sets the bound item value.

textChecked (boolean items only)	String	Gets or sets the text for checked state.
textUnchecked (boolean items only)	String	Gets or sets the text for unchecked state.
value (boolean items only)	Boolean	Gets or sets the bound item value.

parts (DateTime items only)	Number	Gets or sets whether to display and edit the date, time or both (0=both, 1=date only, 2=time only).
value (DateTime items only)	Date	Gets or sets the bound item value.

value (Duration items only)	Number	Gets or sets the bound item value (duration in minutes).

displayMember (OptionSet items only)	String	Gets or sets the name of the property whose value is used as the label of an option.
value (OptionSet items only)	Number	Gets or sets the bound item value (selected value).
valueMember (OptionSet items only)	String	Gets or sets the name of the property whose value is used as the value of an option. Set "null" to use the option object as the value.

isMultiline (Link items only)	Boolean	Gets or sets whether the item is multiline. Default is false.
value (Link items only)	MobileCRM.Reference	Gets or sets the bound item value (a MobileCRM.Reference object or "null").

MobileCRM.UI._DetailView Object

Represents the Javascript equivalent of detail view with set of items responsible for fields editing.

This object is not available under Essential license.

Properties

Property	Type	Description
isDirty	Boolean	Indicates whether the value of an item has been modified.
isEnabled	Boolean	Gets or sets whether the all items are enabled or disabled.
isVisible	Boolean	Gets or sets whether the view is visible.
items	Array	An array of MobileCRM.UI._DetailItem objects
name	String	Gets the name of the view

Methods

Method	Description
addItemToGrid	[since 13.1] Add detail item to desired position in to grid.
executeItemAction	[v19.1] Executes the detail item specific action, e.g. scan barcode.
filterStringListOptions	[v18.1] Filters allowed StringList options in MobileCRM.UI.DetailViewItems.LinkItem.
getItemByName	Returns the MobileCRM.UI._DetailItem with specified name or "null".
getItemContentAsync	[v19.1] Gets the content of detail item as string, e.g. base64 encoded binary data of image item.
getItemIndex	Returns index of MobileCRM.UI._DetailItem with specified name or -1.
insertItem	[v8.0] Inserts the MobileCRM.UI.DetailViewItems.Item into this detailed view.
insertItems	[v8.0] Inserts the MobileCRM.UI.DetailViewItems.Item into this detailed view.
registerClickHandler	[v8.0] Installs the handler which has to be called when user clicks on the link item.
removeItem	[v8.0] Removes the item from this detailed view.
removeItems	[v8.0] Removes all items from this detailed view.
startEditItem	[v9.2] Starts editing the detail item and sets the focus on it.
updateComboItemDataSource	[v9.1] Changes the data source for CombobBoxitem MobileCRM.UI.DetailViewItems.ComboBoxItem.
updateLinkItemViews	[v10.1] Changes the ComboBoxItem views and/or filters.

MobileCRM.UI._DetailView.addItemToGrid Method

[since 13.1] Add detail item to desired position in to grid.

Arguments

Argument	Type	Description
gridName	String	name of grid item.
item	MobileCRM.UI.DetailViewItems.Item	Detail item MobileCRM.UI.DetailViewItems.Itemobject.
column	Number	Optional Column x axis parameter, default is 0.
row	Number	Optional Row y axis parameter, default is 0.
colSpan	Number	Optional Column width x axis width , default is 1.
rowSpan	Number	Optional Row width y axis width, default is 1.

MobileCRM.UI._DetailView.executeItemAction Method

[v19.1] Executes the detail item specific action, e.g. scan barcode.

Arguments

Argument	Type	Description
index	Number	Selected item index.

MobileCRM.UI._DetailView.filterStringListOptions Method

[v18.1] Filters allowed StringList options in MobileCRM.UI.DetailViewItems.LinkItem.

Arguments

Argument	Type	Description
index	Number	Item index on the view.
allowedOptions	string[]	An array with options to be allowed (e.g. ["New", "Completed"]).
defaultValue	String	New data source default value. If not defined, the first item from allowedOptions will be used. Ignored, if value isn't in allowedOptions.

MobileCRM.UI._DetailView.getItemByName Method

Returns the MobileCRM.UI._DetailItem with specified name or "null".

Arguments

Argument	Type	Description
name	String	A name of requested detail item.

Return value

Type: MobileCRM.UI._DetailItem

An instance of MobileCRM.UI._DetailItem with specified name or "null".

MobileCRM.UI._DetailView.getItemContentAsync Method

[v19.1] Gets the content of detail item as string, e.g. base64 encoded binary data of image item.

Arguments

Argument	Type	Description
itemName	String	The name of the detail item.

MobileCRM.UI._DetailView.getItemIndex Method

Returns index of MobileCRM.UI._DetailItem with specified name or -1.

Arguments

Argument	Type	Description
name	String	A name of requested detail item.

Return value

Type: Number

Index of MobileCRM.UI._DetailItem with specified name or -1.

MobileCRM.UI._DetailView.insertItem Method

[v8.0] Inserts the MobileCRM.UI.DetailViewItems.Item into this detailed view.

Arguments

Argument	Type	Description
item	MobileCRM.UI.DetailViewItems.Item	An item to be added.
index	Number	An index on which the item should be placed. Set to -1 to append the item at the end.

MobileCRM.UI._DetailView.insertItems Method

[v8.0] Inserts the MobileCRM.UI.DetailViewItems.Item into this detailed view.

Arguments

Argument	Type	Description
items	Array(MobileCRM.UI.DetailViewItems.Item)	An array of items to be added.
index	Number	An index on which the items should be placed. Set to -1 to append the items at the end.

MobileCRM.UI._DetailView.registerClickHandler Method

[v8.0] Installs the handler which has to be called when user clicks on the link item.

Arguments

Argument	Type	Description
item	MobileCRM.UI.DetailViewItems.LinkItem	An item
callback	function(String, String)	A callback which is called when user clicks on the link item. It obtains the link item name and the detail view name as arguments.
scope	Object	A scope, in which the callback has to be called.

MobileCRM.UI._DetailView.removeItem Method

[v8.0] Removes the item from this detailed view.

Arguments

Argument	Type	Description
index	Number	An index of the item which has to be removed.

MobileCRM.UI._DetailView.removeItems Method

[v8.0] Removes all items from this detailed view.

Arguments

Argument	Type	Description
indexes	Array	An array of item indexes that has to be removed.

MobileCRM.UI._DetailView.startEditItem Method

[v9.2] Starts editing the detail item and sets the focus on it.

Arguments

Argument	Type	Description
index	Number	Selected item index.

MobileCRM.UI._DetailView.updateComboItemDataSource Method

[v9.1] Changes the data source for CombobBoxitem MobileCRM.UI.DetailViewItems.ComboBoxItem.

Arguments

Argument	Type	Description
index	Number	Item index on the view.
listDataSource	Object	The data source object (e.g. {"label1":1, "label2":2}).
valueType	String	Type of list data source element value. Default is string, allowed int, string.
defaultValue	String\|Number	New data source default value. If not defined, the first item from listDataSource will be used.

MobileCRM.UI._DetailView.updateLinkItemViews Method

[v10.1] Changes the ComboBoxItem views and/or filters.

Arguments

Argument	Type	Description
index	Number	Item index on the view.
dialogSetup	MobileCRM.UI.DetailViewItems.LookupSetup	Lookup setup for modal lookup dialog.
inlinePickSetup	MobileCRM.UI.DetailViewItems.LookupSetup	Optional setup for inline lookup picker. Leave empty to use the same setup as modal dialog.
dialogOnly	Boolean	Optional - indicates whether to allow the inline picker. Set true to disable the inline picker and always use the modal dialog. Set false; to allow the inline picker. Default value is true
allowCreateNew	Boolean	Optional - [v18.0] Indicates whether to allow creation of new items. Default value is true.

MobileCRM.UI._DocumentController Object

Represents Media tab controller containing specific kind of document.

This field is not available directly, it is special type of _Controller for Media tab. Use EntityForm.getController to get it.

Properties

Property	Type	Description
isEmpty	boolean	Indicated whether the Media tab is empty.
noteSubject	String	Gets Media tab note subject used for identifying right instance of related attachment.
view	MobileCRM.UI._DocumentView	_Document view presenting attached document.

MobileCRM.UI._DocumentInfo Object

Represents information about attached document.

Properties

Property	Type	Description
documentKind	number	0=None, 1=Signature, 2=WebPage, 3=Image, 4=OtherFileType
fileSize	number	Attachment file size.
imageHeight	number	Image attachment height.
imageWidth	number	Image attachment width.

MobileCRM.UI._DocumentView Object

Represents the document view object containing the attachment document (binary field content).

Properties

Property	Type	Description
isVisible	Boolean	Gets or sets whether the view is visible.
name	String	Gets the name of the view.
documentInfo	_DocumentInfo	Contains information about attached document.
fileName	string	Attached document file name".
isEmpty	boolean	Indicates whether the view is empty or whether user has already provided a document.
isReadOnly	boolean	Indicates whether the view is read-only.
mimeType	string	Attached document file MIME type.
inkTitle	string	Signature title.
saveSignatureAsImage	boolean	Signature save mode: image or SVG.
strokeWidth	number	Signature stroke width.
maxImageWidth	number	Maximum allowed image width. Zero or negative numbers stand for no preference.
maxImageHeight	number	Maximum allowed image height. Zero or negative numbers stand for no preference.
desiredRatio	number	Desired width/height ratio. Zero values stand for no preference. Negative ratio means that reverse ratio is also allowed (accepts both 4:3 and 3:4).
enforcementMode	number	Defines an action to take when image is included into ImageView (captured or selected from gallery). 0=NoEnforcement, 1=AutoCrop, 2=AutoResize, 3=AutoCrop&resize, 32768=OpenImageEditor.

MobileCRM.UI._EntityList Object

Represents the Javascript equivalent of the entity list controller object.

Properties

Property	Type	Description
allowAddExisting	Boolean	Gets or sets whether adding an existing entity is allowed. If false only the creation of new entities is allowed, otherwise the user can selected an existing entity. Adding an existing entity works only when the list is displaying a list of related entities.
allowedViews	Object	Gets or sets the allowed views (e.g. {"view1":"Label 1", "view2":"Label 2"};).
entityName	String	Gets the name of the entities in this list.
hasMapViews	Boolean	Gets whether the list has a view that can be displayed on map.
internalName	String	Gets the internal list name. Used for localization and image lookup.
isDirty	Boolean	Gets or sets whether the list is dirty.
isLoaded	Boolean	Gets or sets whether the list is loaded.
listButtons	Array	Gets or sets the list buttons.
listView	MobileCRM.UI._ListView	Gets the list view control.

MobileCRM.UI._ListView Object

Represents the Javascript equivalent of the list view (control) object.

Properties

Property	Type	Description
isVisible	Boolean	Gets or sets whether the view is visible.
name	String	Gets the name of the view.
selectedIndex	Number	Gets or sets the index of the selected row.
templateIndex	Number	Gets or sets the index of the template used to paint rows in the normal state.
selectedTemplateIndex	Number	Gets or sets the index of the template used to paint rows in the selected state.
isScrollEnabled	Boolean	Gets or sets whether list can scroll. Default true.

MobileCRM.UI._View Object

Represents the Javascript equivalent of the view (control) object.

Properties

Property	Type	Description
isVisible	Boolean	Gets or sets whether the view is visible.
name	String	Gets the name of the view.

MobileCRM.UI.DetailViewItems Namespace

Contains a set of objects representing particular detail view items.

Objects

Object	Description
ButtonItem	[8.0] Represents the MobileCRM.UI._DetailView duration item.
CheckBoxItem	[8.0] Represents the MobileCRM.UI._DetailView checkbox item.
ComboBoxItem	[8.0] Represents the MobileCRM.UI._DetailView combobox item.
DateTimeItem	[8.0] Represents the MobileCRM.UI._DetailView date/time item.
DetailGridLength	[13.0] Represents the grid length in grid unit type.
DropDownFormat	An enumeration defining the values of LinkItem's dropdown format.
DurationItem	[8.0] Represents the MobileCRM.UI._DetailView duration item.
GridItem	[13.0] Represents the MobileCRM.UI._DetailView grid item.
GridStyleDefintion	[13.0] Represents the columns and rows style definition for grid item.
Item	[8.0] Represents the MobileCRM.UI._DetailView item.
LinkItem	[8.0] Represents the MobileCRM.UI._DetailView link item.
LookupSetup	Represents a configuration for lookup and inline lookup.
NumericItem	[8.0] Represents the MobileCRM.UI._DetailView numeric item.
SeparatorItem	[8.0] Represents the MobileCRM.UI._DetailView separator item.
TextBoxItem	[8.0] Represents the MobileCRM.UI._DetailView text item.

MobileCRM.UI.DetailViewItems.ButtonItem Object

[8.0] Represents the MobileCRM.UI._DetailView duration item.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.ButtonItem object.

MobileCRM.UI.DetailViewItems.ButtonItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.ButtonItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
clickText	String	Gets or sets the text content of click button.
label	String	Defines the item label.

MobileCRM.UI.DetailViewItems.CheckBoxItem Object

[8.0] Represents the MobileCRM.UI._DetailView checkbox item.

Properties

Property	Type	Description
textChecked	String	Gets or sets the text for checked state.
textUnchecked	String	Gets or sets the text for unchecked state.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.CheckBoxItem object.

MobileCRM.UI.DetailViewItems.CheckBoxItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.CheckBoxItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.

MobileCRM.UI.DetailViewItems.ComboBoxItem Object

[8.0] Represents the MobileCRM.UI._DetailView combobox item.

Properties

Property	Type	Description
listDataSource	Object	Gets or sets the object with props and values to be displayed in the combo list (e.g. {"label1":1, "label2":2}).

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.ComboBoxItem object.

MobileCRM.UI.DetailViewItems.ComboBoxItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.ComboBoxItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.

MobileCRM.UI.DetailViewItems.DateTimeItem Object

[8.0] Represents the MobileCRM.UI._DetailView date/time item.

Properties

Property	Type	Description
minimum	Date	Gets or sets the minimum allowed value.
maximum	Date	Gets or sets the maximum allowed value.
parts	Number	Gets or sets whether to display and edit the date, time or both.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.DateTimeItem object.

MobileCRM.UI.DetailViewItems.DateTimeItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.DateTimeItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.

MobileCRM.UI.DetailViewItems.DetailGridLength Object

[13.0] Represents the grid length in grid unit type.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.DetailGridLength object.

MobileCRM.UI.DetailViewItems.DetailGridLength.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.DetailGridLength object.

Arguments

Argument	Type	Description
value	String	Grid length value.
gridUnitType	MobileCRM.UI.DetailViewItems.DetailGridUnitType	Defines the grid MobileCRM.UI.DetailViewItems.DetailGridUnitType unit type.

MobileCRM.UI.DetailViewItems.DropDownFormat Object

An enumeration defining the values of LinkItem's dropdown format.

Properties

Property	Type	Description
StringList	Number	StringList dropdown format.
StringListInput	Number	StringListInput dropdown format.
MultiStringList	Number	MultiStringList dropdown format.
MultiStringListInput	Number	MultiStringListInput dropdown format.

MobileCRM.UI.DetailViewItems.DurationItem Object

[8.0] Represents the MobileCRM.UI._DetailView duration item.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.DurationItem object.

MobileCRM.UI.DetailViewItems.DurationItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.DurationItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.

MobileCRM.UI.DetailViewItems.GridItem Object

[13.0] Represents the MobileCRM.UI._DetailView grid item.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.GridItem object.
addItem	[since 13.1] Add detail item to desired position in to grid.

MobileCRM.UI.DetailViewItems.GridItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.GridItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.
gridStyleDefintion	MobileCRM.UI.DetailViewItems.GridStyleDefintion	Gets or sets the style definition for grid item.

MobileCRM.UI.DetailViewItems.GridItem.addItem Method

[since 13.1] Add detail item to desired position in to grid.

Arguments

Argument	Type	Description
item	MobileCRM.UI.DetailViewItems.Item	Detail item MobileCRM.UI.DetailViewItems.Itemobject.
column	Number	Optional Column x axis parameter, default is 0.
row	Number	Optional Row y axis parameter, default is 0.
colSpan	Number	Optional Column width x axis width , default is 1.
rowSpan	Number	Optional Row width y axis width, default is 1.

MobileCRM.UI.DetailViewItems.GridStyleDefintion Object

[13.0] Represents the columns and rows style definition for grid item.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.GridStyleDefintion object.

MobileCRM.UI.DetailViewItems.GridStyleDefintion.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.GridStyleDefintion object.

Arguments

Argument	Type	Description
columns	Array	MobileCRM.UI.DetailViewItems.DetailGridLength>">Defines the columns style.
rows	Array	MobileCRM.UI.DetailViewItems.DetailGridLength>">Defines the rows style.

MobileCRM.UI.DetailViewItems.Item Object

[8.0] Represents the MobileCRM.UI._DetailView item.

Properties

Property	Type	Description
name	String	Gets or sets the item name.
label	String	Gets or sets the item label.
dataMember	String	Gets or sets the name of the property containing the item value in data source objects.
errorMessage	String	Gets or sets the item error message.
supportingText	String	Gets or sets the item supporting text (e.g. description).
isEnabled	Boolean	Gets or sets whether the item is editable.
isVisible	Boolean	Gets or sets whether the item is visible.
value	Object	Gets or sets the bound item value.
isNullable	Boolean	Gets or sets whether the item value can be "null".
validate	Boolean	Gets or sets whether the item needs validation.
style	String	The name of the Woodford item style.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.Item object.

MobileCRM.UI.DetailViewItems.Item.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.Item object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.

MobileCRM.UI.DetailViewItems.LinkItem Object

[8.0] Represents the MobileCRM.UI._DetailView link item.

Properties

Property	Type	Description
isMultiLine	Boolean	Gets or sets whether the item is multiline. Default is false.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.LinkItem object.

MobileCRM.UI.DetailViewItems.LinkItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.LinkItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.
listDropDownFormat	MobileCRM.UI.DetailViewItems.DropDownFormat	Defines item's drop down format.

MobileCRM.UI.DetailViewItems.LookupSetup Object

Represents a configuration for lookup and inline lookup.

Defines the lookup records filter for updateLinkItemViews

Methods

Method	Description
addFilter	Defines a fetch XML filter for entity records.
addView	Appends an entity view to the list of allowed views.

MobileCRM.UI.DetailViewItems.LookupSetup.addFilter Method

Defines a fetch XML filter for entity records.

Arguments

Argument	Type	Description
entityName	string	Entity logical name.
filterXml	string	A string defining the fetch XML which has to be applied as filter for entity records.

MobileCRM.UI.DetailViewItems.LookupSetup.addView Method

Appends an entity view to the list of allowed views.

Arguments

Argument	Type	Description
entityName	string	Entity logical name.
viewName	string	A name of the view.
isDefault	Boolean	true, if the view should be set as default.

MobileCRM.UI.DetailViewItems.NumericItem Object

[8.0] Represents the MobileCRM.UI._DetailView numeric item.

Properties

Property	Type	Description
minimum	Number	Gets or sets the minimum allowed value.
maximum	Number	Gets or sets the maximum allowed value.
increment	Number	Gets or sets the increment (if the upDownVisible is true).
upDownVisible	Boolean	Gets or sets whether the up/down control is visible.
decimalPlaces	Number	Gets or sets the number of decimal places.
displayFormat	String	Gets or sets the value format string.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.NumericItem object.

MobileCRM.UI.DetailViewItems.NumericItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.NumericItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.

MobileCRM.UI.DetailViewItems.SeparatorItem Object

[8.0] Represents the MobileCRM.UI._DetailView separator item.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.SeparatorItem object.

MobileCRM.UI.DetailViewItems.SeparatorItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.SeparatorItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.

MobileCRM.UI.DetailViewItems.TextBoxItem Object

[8.0] Represents the MobileCRM.UI._DetailView text item.

Properties

Property	Type	Description
numberOfLines	Number	Gets or sets the number of lines to display. Default is one.
isPassword	Boolean	Gets or sets whether the text value should be masked. Used for password entry.
maxLength	Number	Gets to sets the maximum text length.
kind	Number	Gets or sets the value kind (Text=0, Email=1, Url=2, Phone=3, Barcode=4).
placeholderText	Number	Gets or sets the text that is displayed in the control until the value is changed by a user action or some other operation. Default is empty string.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.UI.DetailViewItems.TextBoxItem object.

MobileCRM.UI.DetailViewItems.TextBoxItem.constructor Method

Constructs an instance of MobileCRM.UI.DetailViewItems.TextBoxItem object.

Arguments

Argument	Type	Description
name	String	Defines the item name.
label	String	Defines the item label.

MobileCRM.Services Namespace

Contains non-UI classes for accessing documents...

Objects

Object	Description
AIVision	[v12.3] Represents a service for AI image recognition.
AIVisionSettings	[v12.3] Represents the settings for AI image recognition service.
AddressBookService	[v9.1] Represents a service for accessing the address book.
AudioRecorder	[v10.0] Represents a service for recording an audio.
ChatService	[v9.3] Represents a service for sending instant messages to users or shared channels.
CompanyInformation	Represents CompanyInformation object.
DocumentService	[v8.1] Represents a service for acquiring the documents.
DynamicsReport	[v10.0] Represents a service for downloading MS Dynamics reports.
FileInfo	Carries the result of a DocumentService operation.
GeoAddress	[v9.3] Represents a service for translating geo position into the civic address and back.
GeoFenceRecord	[v17.1] Represents geo-fence definition record.
GeoFencingService	[v17.1] Represents geo-fencing service.
HttpWebRequest	[v11.0] Instance of http web request.
SynchronizationResult	[v8.1] Represents the synchronization result.
ZebraScanner	Represents a service for scanning barcodes using Zebra scanner.

MobileCRM.Services.AIVision Object

[v12.3] Represents a service for AI image recognition.

Properties

Property	Type	Description
action	number	Sets action for AI vision service. Capture photo or Select picture.
settings	Array	Array sets of json formated prediction key and url.

Methods

Method	Description
recognizeCapturedPhoto	[v12.3] Recognize captured photo using AIVison service.
recognizeSelectedPicture	[v12.3] Select photo and recognize it with AIVison service.

Functions

Function	Description
create	[v12.3]Create AIVsion instance using MobileCRM.Services.AIVisionSettings object.
createFromEntity	[v12.3]Create AIVsion instance using entity name. The name is used to get settings from Woodford AI Image Recognition configuration.

MobileCRM.Services.AIVision.recognizeCapturedPhoto Method

[v12.3] Recognize captured photo using AIVison service.

Arguments

Argument	Type	Description
sucessCallback	function	A callback function that is called with the object having array of tags and its probability and file path properties. {tags:[{tag:"", probability:""}], filePath:""}
failureCallback	function(errorMsg)	A callback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.AIVision.recognizeSelectedPicture Method

[v12.3] Select photo and recognize it with AIVison service.

Arguments

Argument	Type	Description
sucessCallback	function	A callback function that is called with the object having array of tags and its probability and file path properties. {tags:[{tag:"", probability:""}], filePath:""}
failureCallback	function(errorMsg)	A callback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.AIVision.create Function

[v12.3]Create AIVsion instance using MobileCRM.Services.AIVisionSettings object.

Arguments

Argument	Type	Description
settings	MobileCRM.Services.AIVisionSettings	AIVision settings.

MobileCRM.Services.AIVision.createFromEntity Function

[v12.3]Create AIVsion instance using entity name. The name is used to get settings from Woodford AI Image Recognition configuration.

Arguments

Argument	Type	Description
entityName	String	The entity name of Woodford AI Image Recognition configuration.

MobileCRM.Services.AIVisionSettings Object

[v12.3] Represents the settings for AI image recognition service.

Properties

Property	Type	Description
modelName	String	Gets or sets the model name.
predictionKey	String	Gets or sets the model prediction key.
url	String	Gets or sets the url to train model.
serviceType	String	Gets or sets the service type. By default we use Azure.

MobileCRM.Services.AddressBookService Object

[v9.1] Represents a service for accessing the address book.

Methods

Method	Description
getContact	[v9.1] Gets an address book contact by its ID.

Functions

Function	Description
getService	[v9.1] Gets an instance of AddressBookService object.

Objects

Object	Description
AddressBookRecord

MobileCRM.Services.AddressBookService.getContact Method

[v9.1] Gets an address book contact by its ID.

Arguments

Argument	Type	Description
id	String	Requested contact id.
callback	function(MobileCRM.Services.AddressBookService.AddressBookRecord)	The callback function which is called asynchronously with MobileCRM.Services.AddressBookService.AddressBookRecord object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.AddressBookService.getService Function

[v9.1] Gets an instance of AddressBookService object.

Arguments

Argument	Type	Description
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

Return value

Type: MobileCRM.Services.AddressBookService

An instance of AddressBookService object.

MobileCRM.Services.AddressBookService.AddressBookRecord Object

Properties

Property	Type	Description
recordId	String	Record id.
firstName	String	Record first name.
lastName	String	Record last name.
middleName	String	Record middle name.
nickName	String	Record nick name.
jobTitle	String	Job title.
organization	String	Organization name.
prefix	String	Name prefix (Title) name.
suffix	String	Name suffix (Title) name.
geo	Array	Address GPS coordinates.
url	String	Web page URL of record.

MobileCRM.Services.AudioRecorder Object

[v10.0] Represents a service for recording an audio.

Methods

Method	Description
getRecordBase64	[v10.0] Returns recorded audio from microphone as base64 string
getRecordFilePath	[v10.0] Returns absolute path to the file containing the record
stopRecording	[v10.0] Stops recording audio from microphone

Functions

Function	Description
startRecording	[v10.0] Starts recording audio from microphone

MobileCRM.Services.AudioRecorder.getRecordBase64 Method

[v10.0] Returns recorded audio from microphone as base64 string

Arguments

Argument	Type	Description
callback	function(String)	The callback function that is called asynchronously with the base64-encoded recording data.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.AudioRecorder.getRecordFilePath Method

[v10.0] Returns absolute path to the file containing the record

Arguments

Argument	Type	Description
callback	function(String)	The callback function that is called asynchronously with the file path.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.AudioRecorder.stopRecording Method

[v10.0] Stops recording audio from microphone

Arguments

Argument	Type	Description
callback	function	The callback function which is called asynchronously in case of success.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.AudioRecorder.startRecording Function

[v10.0] Starts recording audio from microphone

Arguments

Argument	Type	Description
callback	function	The callback function which is called asynchronously in case of success.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.ChatService Object

[v9.3] Represents a service for sending instant messages to users or shared channels.

Instance of this object cannot be created directly. Use MobileCRM.Services.ChatService.getService to create new instance.

Properties

Property	Type	Description
chatUser	MobileCRM.DynamicEntity	An instance of the resco_chatuser entity for current user (either system or external).
userEntity	String	The user entity name (either systemuser or external user entity name).
userId	String	Primary key (id) of the current user (either system or external).

Methods

Method	Description
attachNoteToPost	Creates a note (annotation) entity with the file attachment related to specified post.
postMessage	Submits a new post into the channel defines by related entity reference.
subscribeToEntityChannel	Subscribes current user to a channel specified by related entity.

Functions

Function	Description
getService	Asynchronously creates the new instance of the ChatService.

MobileCRM.Services.ChatService.attachNoteToPost Method

Creates a note (annotation) entity with the file attachment related to specified post.

The file path can be either a relative path to application data or a full path to a file being attached.

Arguments

Argument	Type	Description
postId	String	An id of the resco_chatpost entity which should have the note attached.
filePath	String	A path to a file that has to be attached.
mimeType	String	A MIME type of the file.
subject	String	A text which will be used as note's subject.
callback	function(MobileCRM.DynamicEntity)	The callback function which is called asynchronously with MobileCRM.DynamicEntity representing newly created annotation record.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.ChatService.postMessage Method

Submits a new post into the channel defines by related entity reference.

Use reference to resco_chattopic entity to specify a shared channel or reference to a peer user to specify the private channel.

Arguments

Argument	Type	Description
regardingEntity	MobileCRM.Reference	A reference to an entity that the post should relate to.
text	String	The post content.
callback	function(MobileCRM.DynamicEntity)	The callback function which is called asynchronously with MobileCRM.DynamicEntity representing newly created resco_chatpost record.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.ChatService.subscribeToEntityChannel Method

Subscribes current user to a channel specified by related entity.

Use reference to resco_chattopic entity to specify a shared channel.

Arguments

Argument	Type	Description
regardingEntity	MobileCRM.Reference	Reference to an entity that has to be subscribed/unsubscribed.
subscribe	Boolean	Determines whether to subscribe or unsubscribe entity channel.
callback	Function	The callback function which is called asynchronously in case of success.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.ChatService.getService Function

Asynchronously creates the new instance of the ChatService.

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.ChatService)	The callback function which is called asynchronously with MobileCRM.Services.ChatService instance as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.CompanyInformation Object

Represents CompanyInformation object.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.Services.CompanyInformation object.

Functions

Function	Description
getCompanyInfoFromVat	Return callback with CompanyInformation object with properties name and address

MobileCRM.Services.CompanyInformation.constructor Method

Constructs an instance of MobileCRM.Services.CompanyInformation object.

MobileCRM.Services.CompanyInformation.getCompanyInfoFromVat Function

Return callback with CompanyInformation object with properties name and address

Arguments

Argument	Type	Description
vat	string	VAT number of company. e.g. "SK2020232390"
callback	function(CompanyInformation)	The callback function which is called asynchronously in case of success.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService Object

[v8.1] Represents a service for acquiring the documents.

Properties

Property	Type	Description
maxImageSize	String	Gets or sets the maximum captured image size. If captured image size is greater, the image is resized to specified maximum size [640x480,1024x768,1600x1200,2048x1536,2592x1936 ].
maxUploadImageSize	String	Gets or sets the maximum uploaded image size. If uploaded image size is greater then image is resized to specified maximum size [640x480,1024x768,1600x1200,2048x1536,2592x1936 ].
recordQuality	String	Gets or sets the record quality for audio/video recordings [Low, Medium, High].
allowChooseVideo	Boolean	Indicates whether the video files should be included into the image picker when selecting the photos. The default is true.
allowMultipleFiles	Boolean	Indicates whether to allow multiple files for DocumentActions SelectPhoto and SelectFile.[Not implemented on iOS.]
allowCancelHandler	Boolean	Indicates whether to allow handling of cancel event. Callback will pass the null argument in this case.

Methods

Method	Description
capturePhoto	Asks the user to capture a photo and calls the async callback with file info.
loadFrom	[13.3.4]Asks the user to choose a file and calls the async callback with file info.
loadFromMultiple	[13.3.4]Asks the user to choose a multiple files and calls the async callback with file info.
pasteFile	Takes the file from clipboard and calls the async callback with file info.
print	[v9.1] Prints the document defined by file path.
recordAudio	Asks the user to record an audio note and calls the async callback with file info.
recordVideo	Asks the user to record an video and calls the async callback with file info.
resizeImage	[v11.1] Resize image defined by file path.
saveFileDialog	[v11.2] Ask to user to choose a location and saves the passed data as a file at that location.
selectFile	Asks the user to choose a file and calls the async callback with file info.
selectMultipleFiles	[v14.2.0] Asks the user to choose multiple files and calls the async callback with linked list of file infos (see FileInfo.nextInfo).
selectMultiplePhotos	[v11.2.3] Asks the user to choose multiple photos and calls the async callback with linked list of file infos (see FileInfo.nextInfo).
selectPhoto	Asks the user to choose a media (image, video, depending on the value of allowChooseVideo property) and calls the async callback with file info.

MobileCRM.Services.DocumentService.capturePhoto Method

Asks the user to capture a photo and calls the async callback with file info.

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.loadFrom Method

[13.3.4]Asks the user to choose a file and calls the async callback with file info.

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.loadFromMultiple Method

[13.3.4]Asks the user to choose a multiple files and calls the async callback with file info.

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.pasteFile Method

Takes the file from clipboard and calls the async callback with file info.

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.print Method

[v9.1] Prints the document defined by file path.

Arguments

Argument	Type	Description
filePath	String	A file path.
landscape	Boolean	True, to print the document in landscape. False, to print it in portrait
errorCallback	function(errorMsg)	The error callback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.recordAudio Method

Asks the user to record an audio note and calls the async callback with file info.

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.recordVideo Method

Asks the user to record an video and calls the async callback with file info.

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.resizeImage Method

[v11.1] Resize image defined by file path.

Arguments

Argument	Type	Description
filePath	String	A file path.
maxWidth	Number	Max width.
maxHeight	Number	Max height.
callback	function(result)	A callback function for asynchronous result. In case of success result argument will be true otherwise false.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.saveFileDialog Method

[v11.2] Ask to user to choose a location and saves the passed data as a file at that location.

Arguments

Argument	Type	Description
fileName	String	A file name.
fileData	String	Base64 encoded file data.
callback	function(result)	A callback function for asynchronous result. In case of success result argument will be true otherwise false.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.selectFile Method

Asks the user to choose a file and calls the async callback with file info.

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.selectMultipleFiles Method

[v14.2.0] Asks the user to choose multiple files and calls the async callback with linked list of file infos (see FileInfo.nextInfo).

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.selectMultiplePhotos Method

[v11.2.3] Asks the user to choose multiple photos and calls the async callback with linked list of file infos (see FileInfo.nextInfo).

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DocumentService.selectPhoto Method

Asks the user to choose a media (image, video, depending on the value of allowChooseVideo property) and calls the async callback with file info.

Arguments

Argument	Type	Description
callback	function(MobileCRM.Services.FileInfo)	The callback function which is called asynchronously with MobileCRM.Services.FileInfo object as an argument.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.DynamicsReport Object

[v10.0] Represents a service for downloading MS Dynamics reports.

Methods

Method	Description
constructor	Constructs an instance of MobileCRM.Services.DynamicsReport object.
download	Downloads the MS Dynamics report into a file.

MobileCRM.Services.DynamicsReport.constructor Method

Constructs an instance of MobileCRM.Services.DynamicsReport object.

MobileCRM.Services.DynamicsReport.download Method

Downloads the MS Dynamics report into a file.

Arguments

Argument	Type	Description
fileName	String	A file name for resulting file. Leave "null" to let app to safely generate the file name and extension.
format	String	One of following formats (must be supported in Dynamics): XML, CSV, PDF, MHTML, EXCELOPENXML, WORDOPENXML, IMAGE.
success	function(location)	A callback function that is called with the full path to downloaded file.
failed	function(errorMsg)	A callback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.FileInfo Object

Carries the result of a DocumentService operation.

In case of canceled document service operation, all properties in this object will be set to "null".

Properties

Property	Type	Description
filePath	String	Gets the full path of the local file.
url	String	Gets the local URL of the file which can be used from within this HTML document.
mimeType	String	Gets the file MIME type.
nextInfo	MobileCRM.Services.FileInfo	Gets the next file info or "null".

MobileCRM.Services.GeoAddress Object

[v9.3] Represents a service for translating geo position into the civic address and back.

Properties

Property	Type	Description
streetNumber	String	Gets or sets the street number.
street	String	Gets or sets the street.
city	String	Gets or sets the city.
zip	String	Gets or sets the zip code.
stateOrProvince	String	Gets or sets the state or province.
country	String	Gets or sets the country.
isValid	String	Indicates whether the address is valid.

Methods

Method	Description
toLocation	Translates the civic address represented by GeoAddress object into GPS position.

Functions

Function	Description
fromLocation	Translates the geo position represented by latitude and longitude values into the GeoAddress object.

MobileCRM.Services.GeoAddress.toLocation Method

Translates the civic address represented by GeoAddress object into GPS position.

Arguments

Argument	Type	Description
success	function(location)	A callback function that is called with the location object having latitude and longitude properties.
failed	function(errorMsg)	A callback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.GeoAddress.fromLocation Function

Translates the geo position represented by latitude and longitude values into the GeoAddress object.

Arguments

Argument	Type	Description
latitude	Number	Latitude value of the GPS position.
longitude	Number	Longitude value of the GPS position.
success	function(address)	A callback function that is called with the GeoAddress object as argument.
failed	function(errorMsg)	A callback which is called in case of error.
scope	Object	The scope for callbacks.

MobileCRM.Services.GeoFenceRecord Object

[v17.1] Represents geo-fence definition record.

Properties

Property	Type	Description
eventTypeMask	number	Defines numeric mask for geo fence events (Enter = 1, Exit = 2, Both = 3).
id	String	Unique id of geo-fence record. If it is associated with some entity record, it must have form logicalname:id (e.g. appointment:4595AA3E-9873-4DC4-B723-C94DE27B82BE).
name	String	Human-readable name of record used for notifications.
latitude	number	Latitude of geo-fence center.
longitude	number	Longitude of geo-fence center.
radius	number	Geo-fence radius in meters.
expiration	number	Geo-fence expiration in seconds.

MobileCRM.Services.GeoFencingService Object

[v17.1] Represents geo-fencing service.

Properties

Property	Type	Description
isEnabled	Boolean	Indicates whether the service is active.
realtimeFlushing	Boolean	Indicates whether the events should be delivered realtime using Resco forwarding service.
logLevel	number	Defines logging verbosity (0=Normal, 1=Diagnostic, -1=None)
notificationMask	number	Defines event mask for showing notifications (0=None, 1=WhenArrived, 2=WhenExited, 3=Always)
businessHours	String	Business hours interval (e.g. '9:00-17:00')
businessDaysMask	number	Business days mask (the lowest bit is Sunday, the next Monday, ...)

Methods

Method	Description
updateGeoFences	[v17.1] Updates geo-fences being monitored.

MobileCRM.Services.GeoFencingService.updateGeoFences Method

[v17.1] Updates geo-fences being monitored.

MobileCRM.Services.HttpWebRequest Object

[v11.0] Instance of http web request.

Properties

Property	Type	Description
userName	String	The authentication user name.
password	String	The authentication password.
method	String	The http method to use for the request (e.g. "POST", "GET", "PUT").
headers	Object	An object of additional header key/value pairs to send along with requests using the HttpWebRequest.
contentType	String	The htt request data content type.
allowRedirect	Boolean	The http allows servers to redirect a client request to a different location.
responseEncoding	String	The http web response encoding type. (default: UTF-8), e.g. Base64, ASCII, UTF-8, Binary in case of blob.
responseType	String	The HttpWebResponse content type.

Methods

Method	Description
send	[v11.0] Allow to send http web request against an HTTP server.
sendAsync	[v13.3] Allow to send http web request against an HTTP server.
setBody	[v11.0] Set content body of http web request.
setCredentials	[v10.4] Set Network credentials information.
setResponseEncoding	[v11.0] Set encoding for content type of http web response.

MobileCRM.Services.HttpWebRequest.send Method

[v11.0] Allow to send http web request against an HTTP server.

Arguments

Argument	Type	Description
url	String	The Url of server where HTTP request will be sent.
callback	function(response)	A callback function that is called with the web response having "responseCode" and "responseText" properties.
scope	Object	The scope for callbacks.

MobileCRM.Services.HttpWebRequest.sendAsync Method

[v13.3] Allow to send http web request against an HTTP server.

Arguments

Argument	Type	Description
url	String	The Url of server where HTTP request will be sent.

Return value

Type: Promise<IWebResponse>

A Promise object which is asynchronously resolved with the web response object, or rejected with the web response object, where responseText contains error message.

MobileCRM.Services.HttpWebRequest.setBody Method

[v11.0] Set content body of http web request.

Arguments

Argument	Type	Description
body	String	The body content.
encoding	String	The encoding (e.g. UTF-8, ASCII, Base64, Binary)

MobileCRM.Services.HttpWebRequest.setCredentials Method

[v10.4] Set Network credentials information.

Arguments

Argument	Type	Description
userName	String	The authentication user name.
password	String	The authentication password.

MobileCRM.Services.HttpWebRequest.setResponseEncoding Method

[v11.0] Set encoding for content type of http web response.

Arguments

Argument	Type	Description
encoding	String	The encoding (e.g. UTF-8, ASCII, Base64)

MobileCRM.Services.SynchronizationResult Object

[v8.1] Represents the synchronization result.

Properties

Property	Type	Description
newCustomizationReady	Boolean	Indicates whether the new customization is ready.
customizationDownloaded	Boolean	Indicates whether the new customization was applied.
dataErrorsEncountered	Boolean	Indicates whether some data errors were encountered during sync (cannot upload, delete, change status, owner, etc.).
appWasLocked	Boolean	Application was locked.
syncAborted	Boolean	Sync was aborted.
adminFullSync	Boolean	Full sync was requested so background sync was aborted.
webError	Boolean	Indicates whether sync failed due to a communication error (HttpException, for example).
connectFailed	Boolean	Indicates whether sync could not start because of a connection failure.
wasBackgroundSync	Boolean	Indicates whether the last sync was background sync or foreground sync.
OAuthError	Boolean	Sync failed because the OAuth access token can't be acquired or refreshed.
syncDownloadRestartedOnBackground	Boolean	New customization was downloaded. Sync is still downloading data on background.
warning	Boolean	Sync result contains some warnings that are not critical.

MobileCRM.Services.ZebraScanner Object

Represents a service for scanning barcodes using Zebra scanner.

Functions

Function	Description
connect	Connects to the Zebra scanner.
onScan	Registers the handler for the scan event.
setPower	Set power of antenna the Zebra scanner.
setVolume	Set volume of the Zebra scanner.

MobileCRM.Services.ZebraScanner.connect Function

Connects to the Zebra scanner.

Arguments

Argument	Type	Description
successCallback	function	The callback function that is called when the connection is established.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope in which the callback function is called.

MobileCRM.Services.ZebraScanner.onScan Function

Registers the handler for the scan event.

Arguments

Argument	Type	Description
handler	function(data)	The handler function that is called when the scan event is raised.
bind	Boolean	Indicates whether to bind the handler to the event.
scope	Object	The scope in which the handler function is called.

MobileCRM.Services.ZebraScanner.setPower Function

Set power of antenna the Zebra scanner.

Arguments

Argument	Type	Description
power	Number	The power of the scanner.
successCallback	function	The callback function that is called when the connection is established.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope in which the callback function is called.

MobileCRM.Services.ZebraScanner.setVolume Function

Set volume of the Zebra scanner.

Arguments

Argument	Type	Description
volume	Number	The volume of the scanner.
successCallback	function	The callback function that is called when the connection is established.
errorCallback	function(errorMsg)	The errorCallback which is called in case of error.
scope	Object	The scope in which the callback function is called.

MobileCRM.Services.Workflow Namespace

Contains objects accessing the Dynamics 365 workflow.

Objects

Object	Description
Action	[v11.2] Represents custom workfow action.

MobileCRM.Services.Workflow.Action Object

[v11.2] Represents custom workfow action.

Functions

Function	Description
execute	[v11.2] Asynchronously executes custom workfow action on the server.

MobileCRM.Services.Workflow.Action.execute Function

[v11.2] Asynchronously executes custom workfow action on the server.

Arguments

Argument	Type	Description
actionName	String	The unique name of the custom action to execute.
parameters	Object	The object containing the parameters for the custom action.
success	function(string)	A callback function for successful asynchronous result. The result argument will carry the serialized response from the server.
failed	function(error)	A callback function for command failure. The error argument will carry the error message.
scope		A scope for calling the callbacks; set "null" to call the callbacks in global scope.

Resco Mobile CRM - Javascript Bridge Reference

MobileCRM Namespace

Namespaces

Properties

Objects

MobileCRM.AboutInfo Object

Properties

Functions

MobileCRM.AboutInfo.requestObject Function

Arguments

MobileCRM.ActivityParty Object

Properties

Methods

MobileCRM.ActivityParty.constructor Method

Arguments

MobileCRM.Application Object

Functions

MobileCRM.Application.checkUserRoles Function

Arguments

MobileCRM.Application.createDirectory Function

Arguments

MobileCRM.Application.createDirectoryAsync Function

Arguments

MobileCRM.Application.deleteDirectory Function

Arguments

MobileCRM.Application.deleteDirectoryAsync Function

Arguments

MobileCRM.Application.deleteFile Function

Arguments

MobileCRM.Application.deleteFileAsync Function

Arguments

MobileCRM.Application.directoryExists Function

Arguments

MobileCRM.Application.directoryExistsAsync Function

Arguments

MobileCRM.Application.fileExists Function

Arguments

MobileCRM.Application.fileExistsAsync Function

Arguments

MobileCRM.Application.getAccessToken Function

Arguments

MobileCRM.Application.getAppColor Function

Arguments

MobileCRM.Application.getAppImage Function

Arguments

MobileCRM.Application.getDirectories Function

Arguments

MobileCRM.Application.getDirectoriesAsync Function

Arguments

MobileCRM.Application.getFiles Function

Arguments

MobileCRM.Application.getFilesAsync Function

Arguments

MobileCRM.Application.getLastSignificantTimeChange Function

Arguments

MobileCRM.Application.moveFile Function

Arguments

MobileCRM.Application.moveFileAsync Function

Arguments

MobileCRM.Application.onSyncFinished Function

Arguments

MobileCRM.Application.readFile Function

Arguments

MobileCRM.Application.readFileAsBase64 Function

Arguments

MobileCRM.Application.readFileAsync Function

Arguments

MobileCRM.Application.setAppColors Function

Arguments

MobileCRM.Application.showAppLogin Function

MobileCRM.Application.showSetup Function

MobileCRM.Application.startSmartSync Function

Arguments

Return value

MobileCRM.Application.synchronize Function

Arguments

MobileCRM.Application.synchronizeOnForeground Function

Arguments

MobileCRM.Application.writeFile Function

Arguments