@resconet/jsbridge 18.2.0-beta.1 → 18.2.0-beta.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resconet/jsbridge",
-  "version": "18.2.0-beta.1",
+  "version": "18.2.0-beta.3",
   "main": "./src/JSBridge.js",
   "types": "./src/JSBridge.d.ts",
   "description": "Install npm JSBridge module",

package/src/JSBridge.d.ts

@@ -512,6 +512,15 @@ declare namespace MobileCRM {
 		static loadDocumentBody(entityName: string, id: string, sucess: (base64: string) => void, failed?: (error: string) => void, scope?: any);
 		static loadDocumentBodyAsync(entityName: string, id: string): Promise<string>;
 		static unzipDocumentBody(entityName: string, id: string, targetDir: string, sucess?: () => void, failed?: (error: string) => void, scope?: any);
+		/**
+		 * Asynchronously loads the content of a file field.
+		 * @since 18.2
+		 * @param entityName Logical name of entity containing the file field.
+		 * @param id An ID of record containing the file field.
+		 * @param fileFieldName Logical name of the file field.
+		 * @param online Optional flag forcing the online or offline mode.
+		 */
+		static loadFileFieldContent(entityName: string, id: string, fileFieldName: string, online?: string): Promise<string>;
 		static downloadAttachment(entityName: string, id: string, sucess: (base64: string) => void, failed?: (error: string) => void, scope?: any);
 		static downloadAttachmentAsync(entityName: string, id: string): Promise<string>;
 		/**
@@ -749,6 +758,16 @@ declare namespace MobileCRM {
 		 * @returns Promise resolved with Location object.
 		 */
 		public static getLocationAsync(age?: number, precision?: number, timeout?: number): Promise<Location>;
+		/**
+		 * @since 18.2
+		 * Registers or unregisters a handler for location updates.
+		 * When the location is updated, the handler is called with a Location object representing new location.
+		 * @param handler Handler function which will be called each time when the location is updated.
+		 * @param bind Indicates whether to bind or unbind handler.
+		 * @param scope Optional scope for calling the handler; set &quot;null&quot; to call the handler in global scope.
+		 * @returns Promise resolved when the handler is registered or unregistered.
+		 */
+		public static watchLocationUpdates(handler: (obj: Location) => void, bind: boolean, scope?: any): Promise<void>;
 		public static requestObject(callback: (platform: Platform) => void, errorCallback: () => void, scope?: any);
 		/**
 		 * @since 8.1
@@ -1893,13 +1912,21 @@ declare module MobileCRM.UI {
 		startEditItem(index: number);
 		/**
 		 * @since 9.1
-		 * Changes the data source for ComboBoxItem {MobileCRM.UI.DetailViewItems.ComboBoxItem}.</see>.
+		 * Changes the data source for ComboBoxItem {MobileCRM.UI.DetailViewItems.ComboBoxItem}.
 		 * @param index Item index on the view.
 		 * @param listDataSource The data source object (e.g. {label1 : 1, label2 : 2}).
 		 * @param defaultValue New data source default value. If not defined, the first item from listDataSource will be used.
 		 * @param valueType Type of list data source element value. Default is string, allowed int, string.
 		 */
 		updateComboItemDataSource(index: number, listDataSource: any, defaultValue?: string, valueType?: string);
+		/**
+		 * @since 18.1
+		 * Filters allowed StringList options in LinkItem {MobileCRM.UI.DetailViewItems.LinkItem}.
+		 * @param index Item index on the view.
+		 * @param allowedOptions An array with options to be allowed (e.g. ["Option1", "Option2"]).
+		 * @param defaultValue New data source default value. If not defined, the first item from allowedOptions will be used. Ignored, if value isn't in allowedOptions.
+		 */
+		filterStringListOptions(index: number, allowedOptions: string[], defaultValue?: string);
 		/**
 		 * @since 10.1
 		 * Changes the data source for MobileCRM.UI.DetailViewItems.ComboBoxItem.
@@ -2163,6 +2190,16 @@ declare module MobileCRM.UI {
 		 * @returns A promise resolved with boolean result of native field setter.
 		 */
 		public static setFieldValues(changes: { [fieldName: string]: any }): Promise<boolean>;
+		/**
+		 * 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.
+		 * @since 18.2
+		 * @param fileFieldName Logical name of the file field that has to be changed.
+		 * @param documentFileName A file name that should be used when presenting the binary content.
+		 * @param documentContent Base64-encoded binary file content.
+		 * @returns A promise resolved with boolean result of native field setter.
+		 */
+		public static setFileFieldContent(fileFieldName: string, documentFileName: string, documentContent: string);
 		/**
 		 * Binds or unbinds the handler for EntityForm command.
 		 * @param command The name of the EntityForm command.
@@ -2217,18 +2254,22 @@ declare module MobileCRM.UI {
 		public static openSalesEntityDetail(detail: MobileCRM.DynamicEntity, errorCallback: (err?: string) => void);
 		/**
 		 * @since 18.0
-		 * The clearance must be dutifully released using leaveUiTransaction() when manipulation is finished.
-		 * The clearance will not be obtained 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'".
-		 * If form sync behavior is configured as 'No action', the clearance is always obtained.
+		 * 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.
 		 * @returns true if form can give the clearance, false if it is not possible at this time.
 		 */
 		public static tryEnterUiTransaction(): Promise<boolean>;
 		/**
 		 * @since 18.0
-		 * Notifies UI form that clearance obtained using successful call to tryEnterUiTransaction() is no longer needed, because data manipulation is complete.
+		 * 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.
 		 */
-		public static leaveUiTransaction(): Promise;
+		public static leaveUiTransaction(): Promise<void>;
 		/**
 		 * @since 9.3
 		 * Binds or unbinds the handler for onSelectedViewChanged event on EntityForm.

package/src/JSBridge.js

@@ -193,7 +193,7 @@
 			/// <field name="bridge" type="MobileCRM.Bridge">Singleton instance of <see cref="MobileCRM.Bridge">MobileCRM.Bridge</see> providing the management of the Javascript/native code cross-calls.</field>
 			bridge: null,
 			Bridge: function (platform) {
-				/// <summary>Provides the management of the Javascript/native code cross-calls. Its only instance <see cref="MobileCRMbridge">MobileCRM.bridge</see> is created immediately after the &quot;JSBridge.js&quot; script is loaded.</summary>
+				/// <summary>Provides the management of the Javascript/native code cross-calls. Its only instance <see cref="MobileCRM.bridge">MobileCRM.bridge</see> is created immediately after the &quot;JSBridge.js&quot; script is loaded.</summary>
 				/// <param name="platform" type="String">A platform name</param>
 				/// <field name="platform" type="String">A string identifying the device platform (e.g. Android, iOS, Windows, WindowsRT, Windows10 or WindowsPhone).</field>
 				/// <field name="version" type="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.</field>
@@ -821,7 +821,7 @@
 				},
 				DetailViewItems: {
 					Item: function (name, label) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						/// <field name="name" type="String">Gets or sets the item name.</field>
@@ -840,14 +840,14 @@
 						this.label = label;
 					},
 					SeparatorItem: function (name, label) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> separator item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> separator item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						MobileCRM.UI.DetailViewItems.SeparatorItem.superproto.constructor.apply(this, arguments);
 						this._type = "Separator";
 					},
 					TextBoxItem: function (name, label) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> text item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> text item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						/// <field name="numberOfLines" type="Number">Gets or sets the number of lines to display. Default is one.</field>
@@ -859,7 +859,7 @@
 						this._type = "TextBox";
 					},
 					NumericItem: function (name, label) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> numeric item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> numeric item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						/// <field name="minimum" type="Number">Gets or sets the minimum allowed value.</field>
@@ -878,7 +878,7 @@
 						//this.displayFormat = "";
 					},
 					CheckBoxItem: function (name, label) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> checkbox item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> checkbox item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						/// <field name="textChecked" type="String">Gets or sets the text for checked state.</field>
@@ -888,7 +888,7 @@
 						this.isNullable = false;
 					},
 					DateTimeItem: function (name, label) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> date/time item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> date/time item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						/// <field name="minimum" type="Date">Gets or sets the minimum allowed value.</field>
@@ -898,14 +898,14 @@
 						this._type = "DateTime";
 					},
 					DurationItem: function (name, label) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> duration item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> duration item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						MobileCRM.UI.DetailViewItems.DurationItem.superproto.constructor.apply(this, arguments);
 						this._type = "Duration";
 					},
 					ComboBoxItem: function (name, label) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> combobox item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> combobox item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						/// <field name="listDataSource" type="Object">Gets or sets the object with props and values to be displayed in the combo list (e.g. {&quot;label1&quot;:1, &quot;label2&quot;:2}).</field>
@@ -914,7 +914,7 @@
 						this._type = "ComboBox";
 					},
 					LinkItem: function (name, label, listDropDownFormat) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> link item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> link item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						/// <param name="listDropDownFormat" type="MobileCRM.UI.DetailViewItems.DropDownFormat">Defines item&apos;s drop down format.</param>
@@ -926,7 +926,7 @@
 						}
 					},
 					ButtonItem: function (name, clickText) {
-						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> duration item.</summary>
+						/// <summary>[8.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> duration item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="clickText" type="String">Gets or sets the text content of click button.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
@@ -944,7 +944,7 @@
 						MultiStringListInput: 20,
 					},
 					GridItem: function (name, label, gridStyleDefintion) {
-						/// <summary>[13.0] Represents the <see cref="MobileCRM.UI._DetailView"></see> grid item.</summary>
+						/// <summary>[13.0] Represents the <see cref="MobileCRM.UI._DetailView">MobileCRM.UI._DetailView</see> grid item.</summary>
 						/// <param name="name" type="String">Defines the item name.</param>
 						/// <param name="label" type="String">Defines the item label.</param>
 						/// <param name="gridStyleDefintion" type="MobileCRM.UI.DetailViewItems.GridStyleDefintion">Gets or sets the style definition for grid item.</param>
@@ -965,7 +965,7 @@
 					DetailGridLength: function (value, gridUnitType) {
 						/// <summary>[13.0] Represents the grid length in grid unit type.</summary>
 						/// <param name="value" type="String">Grid length value.</param>
-						/// <param name="gridUnitType" type="MobileCRM.UI.DetailViewItems.DetailGridUnitType">Defines the grid <see cref="MobileCRM.UI.DetailViewItems.DetailGridUnitType"></see> unit type.</param>
+						/// <param name="gridUnitType" type="MobileCRM.UI.DetailViewItems.DetailGridUnitType">Defines the grid <see cref="MobileCRM.UI.DetailViewItems.DetailGridUnitType">MobileCRM.UI.DetailViewItems.DetailGridUnitType</see> unit type.</param>
 						this._value = value;
 						this._gridUnitType = gridUnitType;
 					},
@@ -1136,7 +1136,7 @@
 					/// <field name="realtimeFlushing" type="Boolean">Indicates whether the events should be delivered realtime using Resco forwarding service.</field>
 					/// <field name="logLevel" type="number">Defines logging verbosity (0=Normal, 1=Diagnostic, -1=None)</field>
 					/// <field name="notificationMask" type="number">Defines event mask for showing notifications (0=None, 1=WhenArrived, 2=WhenExited, 3=Always)</field>
-					/// <field name="businessHours" type="String">Business hours interval (e.g. '9:00-17:00')</field>
+					/// <field name="businessHours" type="String">Business hours interval (e.g. &apos;9:00-17:00&apos;)</field>
 					/// <field name="businessDaysMask" type="number">Business days mask (the lowest bit is Sunday, the next Monday, ...)</field>
 					this.isEnabled = false;
 					this.realtimeFlushing = true;
@@ -2426,6 +2426,22 @@
 			/// <param name="scope" type="">A scope for calling the callbacks; set &quot;null&quot; to call the callbacks in global scope.</param>
 			MobileCRM.bridge.command("documentBodyUnzip", targetDir + ";" + JSON.stringify({ entity: entityName, id: id }), success, failed, scope);
 		};
+		MobileCRM.DynamicEntity.loadFileFieldContent = function (entityName, id, fileFieldName, online) {
+			/// <summary>[18.2] Asynchronously loads the content of a file field.
+			/// <param name="entityName" type="String">Logical name of entity containing the file field.</param>
+			/// <param name="id" type="String">An ID of record containing the file field.</param>
+			/// <param name="fileFieldName" type="String">Logical name of the file field.</param>
+			// <param name="online" type="boolean|undefined">Optional flag forcing the online or offline mode.</param>
+			return MobileCRM.bridge.invokeCommandPromise(
+				"loadFileFieldContent",
+				JSON.stringify({
+					entityName: entityName,
+					id: id,
+					fileField: fileFieldName,
+					online: online,
+				})
+			);
+		};
 		MobileCRM.DynamicEntity.downloadAttachment = function (entityName, id, success, failed, scope) {
 			/// <summary>[v9.1] Initiates the attachment download for specified entity.</summary>
 			/// <remarks>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.</remarks>
@@ -3198,6 +3214,26 @@
 			}
 			return MobileCRM.bridge.invokeCommandPromise("getLocation", JSON.stringify(params));
 		};
+		MobileCRM.Platform._watchLocationHandlers = [];
+		MobileCRM.Platform.watchLocationUpdates = function (handler, bind, scope) {
+			/// <summary>[v18.2] Registers or unregisters a handler for location updates.</summary>
+			/// <remarks>When the location is updated, the handler is called with a <see cref="MobileCRM.Location">MobileCRM.Location</see> object having <b>latitude</b>, <b>longitude</b> and <b>timestamp</b> properties.</remarks>
+			/// <param name="handler" type="function(location)">Handler function which will be called each time when the location is updated. The <b>location</b> argument will carry an object with <b>latitude</b>, <b>longitude</b> and <b>timestamp</b> properties.</param>
+			/// <param name="bind" type="Boolean">Indicates whether to bind or unbind handler.</param>
+			/// <param name="scope" type="">Optional scope for calling the handler; set &quot;null&quot; to call the handler in global scope.</param>
+			/// <returns type="Promise&lt;void&gt;">A Promise object which will be resolved when the handler is successfully bound/unbound.</returns>
+			var register = bind && MobileCRM.Platform._watchLocationHandlers.length == 0;
+			_bindHandler(handler, MobileCRM.Platform._watchLocationHandlers, bind, scope);
+			if (register) {
+				return MobileCRM.bridge.invokeCommandPromise("watchLocation", JSON.stringify({ active: true }));
+			} else if (!bind && MobileCRM.Platform._watchLocationHandlers.length == 0) {
+				return MobileCRM.bridge.invokeCommandPromise("watchLocation", JSON.stringify({ active: false }));
+			}
+			return Promise.resolve();
+		};
+		MobileCRM.Platform._callLocationHandlers = function (location) {
+			_callHandlers(MobileCRM.Platform._watchLocationHandlers, location);
+		};
 		MobileCRM.Platform.preventBackButton = function (handler, scope) {
 			/// <summary>Prevents application to close when HW back button is pressed and installs handler which is called instead.</summary>
 			/// <remarks><p>Pass &quot;null&quot; handler to allow the HW back button.</p><p>Works only under OS having HW back button (Android, Windows 10).</p></remarks>
@@ -3915,7 +3951,7 @@
 			/// <param name="index" type="Number">Item index on the view.</param>
 			/// <param name="listDataSource" type="Object">The data source object (e.g. {&quot;label1&quot;:1, &quot;label2&quot;:2}).</param>
 			/// <param name="valueType" type="String">Type of list data source element value. Default is string, allowed int, string.</param>
-			/// <param name="defaultValue" type="String">New data source default value. If not defined, the first item from listDataSource will be used.</param>
+			/// <param name="defaultValue" type="String|Number">New data source default value. If not defined, the first item from listDataSource will be used.</param>
 			var data = {
 				action: "updateDataSource",
 				viewName: this.name,
@@ -3928,6 +3964,20 @@
 			//this.items[index].value = defaultValue !== undefined ? defaultValue : listDataSource[Object.keys(listDataSource)[0]];
 			MobileCRM.bridge.command("detailViewAction", JSON.stringify(data));
 		};
+		MobileCRM.UI._DetailView.prototype.filterStringListOptions = function (index, allowedOptions, defaultValue) {
+			/// <summary>[v18.1] Filters allowed StringList options in <see cref="MobileCRM.UI.DetailViewItems.Item">MobileCRM.UI.DetailViewItems.LinkItem</see>.</summary>
+			/// <param name="index" type="Number">Item index on the view.</param>
+			/// <param name="allowedOptions" type="string[]">An array with options to be allowed (e.g. [&quot;New&quot;, &quot;Completed&quot;]).</param>
+			/// <param name="defaultValue" type="String">New data source default value. If not defined, the first item from allowedOptions will be used. Ignored, if value isn&apos;t in allowedOptions.</param>
+			var data = {
+				action: "filterStringList",
+				viewName: this.name,
+				index: index,
+				filterOptions: allowedOptions,
+				value: defaultValue || allowedOptions[0],
+			};
+			MobileCRM.bridge.command("detailViewAction", JSON.stringify(data));
+		};
 		MobileCRM.UI._DetailView.prototype.updateLinkItemViews = function (index, dialogSetup, inlinePickSetup, dialogOnly, allowCreateNew) {
 			/// <summary>[v10.1] Changes the <see cref="MobileCRM.UI.DetailViewItems.ComboBoxItem">ComboBoxItem</see> views and/or filters.</summary>
 			/// <param name="index" type="Number">Item index on the view.</param>
@@ -5766,6 +5816,18 @@
 			/// <returns type="Promise&lt;boolean&gt;">A promise resolved with boolean result of native field setter.</returns>
 			return MobileCRM.bridge.invokeCommandPromise("setFormEntityFields", JSON.stringify(changes));
 		};
+		MobileCRM.UI.EntityForm.setFileFieldContent = function (fileFieldName, documentFileName, documentContent) {
+			/// <summary>[v18.2] Sets the file field content and file name on entity record shown on this EntityForm.</summary>
+			/// <remarks>Setting file field content is possible only in offline mode. This method fails in online mode.</remarks>
+			/// <param name="fieldName" type="String">Logical name of the file field that has to be changed.</param>
+			/// <param name="documentFileName" type="String">A file name that should be used when presenting the binary content.</param>
+			/// <param name="documentContent" type="String">Base64-encoded binary file content.</param>
+			/// <returns type="Promise&lt;boolean&gt;">A promise resolved with boolean result of native field setter.</returns>
+			var obj = {};
+			obj[fileFieldName + "_name"] = documentFileName;
+			obj[fileFieldName] = documentContent;
+			return MobileCRM.UI.EntityForm.setFieldValues(obj);
+		};
 		MobileCRM.UI.EntityForm.requestObject = function (callback, errorCallback, scope) {
 			/// <summary>Requests the managed EntityForm object.</summary>
 			/// <remarks>Method initiates an asynchronous request which either ends with calling the <b>errorCallback</b> or with calling the <b>callback</b> with Javascript version of EntityForm object. See <see cref="MobileCRM.Bridge.requestObject">MobileCRM.Bridge.requestObject</see> for further details.</remarks>
@@ -5907,18 +5969,14 @@
 			/// <param name="errorCallback" type="function(errorMsg)">The errorCallback which is called asynchronously in case of error.</param>
 			MobileCRM.bridge.invokeMethodAsync("EntityForm", "ShowEntityDetailDialog", [detail.id], null, errorCallback, null);
 		};
-		/// <summary>[v18.0] Obtains a clearance to perform manipulation with data.
-		/// The clearance must be dutifully released using leaveUiTransaction() when manipulation is finished.
-		/// The clearance will not be obtained 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'".
-		/// If form sync behavior is configured as 'No action', the clearance is always obtained.
-		/// </summary>
-		/// <returns>Returns true if form can give the clearance, false if it is not possible at this time.</returns>
 		MobileCRM.UI.EntityForm.tryEnterUiTransaction = function () {
+			/// <summary>[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.</summary>
+			/// <returns type="Promise&lt;boolean&gt;">Returns true if clearance is obtained, false if it is not possible at this time.</returns>
 			return MobileCRM.bridge.invokeCommandPromise("tryEnterUiTransaction");
 		};
-		/// <summary>[v18.0] Notifies UI form that clearance obtained using successful call to tryEnterUiTransaction() is no longer needed, because data manipulation is complete.</summary>
 		MobileCRM.UI.EntityForm.leaveUiTransaction = function () {
+			/// <summary>[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.</summary>
+			/// <returns type="Promise&lt;void&gt;">Returns an awaitable promise.</returns>
 			return MobileCRM.bridge.invokeCommandPromise("leaveUiTransaction");
 		};
 		// MobileCRM.UI.EntityForm.DetailCollection