1 Native Pulsar UI Interaction
- 1.1 setLeavePageMessage
- 1.2 exit
- 1.3 showCreate
- 1.4 viewObject
- 1.5 viewRelated
- 1.6 viewList
- 1.7 lookupObject
- 1.8 scanBarcode
- 1.9 executeQuickAction
- 1.10 cameraPhoto
- 1.11 cameraPhotoPicker
- 1.12 filePicker
- 1.13 displayUrl

Native Pulsar UI Interaction

The calls that support Pulsar native screen interaction need to know that you will only see the response when the native screen is dismissed by the user. For example, if your code calls viewObject in edit mode, when the user types the data on the screen and hits save or cancel, you will see the JSAPI response. This way, you can take the appropriate action based on that response.

setLeavePageMessage

The setLeavePageMessage API allows you to display a confirmation prompt whenever the user tries to leave the page. If a message is specified, the user will be prompted to select 'Yes' or 'No' for the Done button press as well as for these web navigation buttons: Refresh, Back, Forward. To disable this prompt, call this command again with a zero length string.

var request = { 
	"type" : "setLeavePageMessage",
	"object" : "",
	"data" : "Are you sure you want to leave this page?" // message displayed in a yes/no confirmation alert
};
bridge.send(request, function (responseData) { alert('Javascript got its view response: ' + responseData); });

exit

The exit API closes the html document. This command is the same as pressing the Done button and will work alongside the setLeavePageMessage command.

var request = { 
	"type" : "exit",
	"data" : {}
};
bridge.send(request, function (responseData) { console.log('exit: ' + responseData); });

showCreate

The showCreate API allows the user to create an object within the native Pulsar interface. The response data contains two parameters:

"createResult" --- boolean success flag ("TRUE" or "FALSE")

"createId" -- the created object Id, if the create was successful

var request = {
    "type" : "showCreate",
    "object" : "Account",
    "data" : { "Name" : "John Doe Industries", "Phone" : "867-5309" }
};
bridge.send(request, function(responseData) {
    if (responseData.type === "showcreateResponse" 
        && responseData.data.createResult === "TRUE") {
    	alert('Create Success! ObjectId: ' + responseData.data.createId);
    } else {
   		alert('Error during create: ' + responseData.data);
    }
});

viewObject

The viewObject API allows the user to jump directly to a referenced object in the native Pulsar interface. The object can be opened in edit mode directly by using the boolean "editmode" parameter (passing "1", "true", or "TRUE" will enable this functionality).

var request = { 
	"type" : "viewObject",
	"object" : "Account",
	"data" : { 
         "Id" : "00123456789ABCD", // This will open the Account object with this Id
         "editmode" : "1"          // OPTIONAL: allows the object to be opened in edit mode 
    } 
};
bridge.send(request, function (responseData) { 
  if (responseData.type === "viewResponse") {
    	success(responseData.data);
    } else if (responseData.type == 'error') {
   		failure(responseData.data);
    } 
});

viewRelated

The viewRelated API allows the user to jump directly to a referenced object's related lists in the native Pulsar interface.

Note: You should use the API name of the child relationship. You can get this information from Workbench by doing a describe object call and expanding ChildRelationships element.

var request = { 
	"type" : "viewRelated",
	"object" : "Account",
	"data" : { "Id" : "001234567891234", "relationshipName" : "Contacts" }  // Open the Contacts related list for the specified Account object
};
bridge.send(request, function (responseData) { 
	if (responseData.type === "viewResponse") {
    	success(responseData.data);
    } else if (responseData.type == 'error') {
   		failure(responseData.data);
    } 
});

viewList

The viewList API allows the user to open an object list view in the native Pulsar interface.

var request = {
   "type" : "viewList",
   "object" : "Account",
   "data" : { "@@listviewid" : "00B123456789101" }
};
bridge.send(request, function(responseData) {
    if (responseData.type === "viewListResponse") {
    	success(responseData.data);
    } else if (responseData.type == 'error') {
   		failure(responseData.data);
    }
});

lookupObject

The lookupObject API allows the user to select an object from a list view in the native Pulsar interface.

Two options for the data portion of the request:

specify fields and values to filter the resulting list:
{ field1 : value1, field2 : value2 } (this results in simple logic-- (field1=value1 AND field2=value2))
specify the Salesforce ListView to use by supplying the special keyword "@@listviewid" and the associated ListView Id:
{ "@@listviewid" : "00B123456789ABCDEF" }
See "listviewInfo" API for documentation about retrieving the ListView Id.
specify the Salesforce ListView to use by supplying the special keyword "@@whereClause":
{ "@@whereClause" : "Account.Name = 'Apple'" }

var request = { 
	"type" : "lookupObject",
	"object" : "Account",
	"data" : { "Type" : "Prospect" } // This is optional. This will open the list for Account objects with type "Prospect"
};
bridge.send(request, function (responseData) { 
	if ((responseData.type == 'lookupObjectResponse')
		&& (responseData.data != null)) { 
			alert('selected object: ' + responseData.data[0]); 
	}
});

scanBarcode

The scanBarcode API allows the user to scan a barcode. The response callback will return the value of the scanned barcode.

var request = { 
	"type" : "scanBarcode",
	"data" : { /* data is empty */ } 
};
bridge.send(request, function (responseData) { 
	if ((responseData.type == 'scanBarcodeResponse')
		&& (responseData.data != null)) { 
			alert('scanned barcode: ' + responseData.data.barcode); 
	}
});

executeQuickAction

The executeQuickAction API presents the user with a Quick Action. This depends on the PulsarSetting pulsar.sync.enableQuickActions, and should be used in conjunction with the getQuickActions API if the API name of the desired Quick Action is not known. Please note that only Quick Actions of type 'Update' and 'Create' are supported by Pulsar.

var request = {
	'type' : 'executeQuickAction',
	'data' : {
		'ActionName': 'UpdateCustomObject', /* (Required) The Quick Action's Salesforce API name */
		'ContextId' : '00123456789ABCDEFG', /* (Optional) The Id of the object related to the quick action's target object, if any */
		'Field1'    : 'Value1', /* (Optional) Any number of field values to be supplied as defaults to the target object of the quickaction */
		'Field2'    : 'Value2', 
	}
};
bridge.send(request, function(responseData) {
	if ((responseData.type === 'executeQuickActionResponse')
		&& (responseData.data != null))
	{
		var responseObject = responseData.data;
		/* the response object contains two properties:
			1. "executed" : the execution state of the quick action- true if the quick action was presented to the user. false otherwise
			2. "quickActionResult" : a flag representing whether the quickaction saved/created the target object- true if successful, false if failed. 
        */
		
	} else {
		// handle the API error or cancellation ...
	}
});

The getQuickActions API requests the list of Quick Actions that appear on a specific SObject page layout, or a list of Quick Actions from the global context. The response contains an array of QuickAction metadata in the form described here: https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_describelayout_describelayoutresult.htm#describequickactionlistitemresult. This depends on the PulsarSetting pulsar.sync.enableQuickActions. Please note that only Quick Actions of type 'Update' and 'Create' are supported by Pulsar.

var request = {
	'type' : 'getQuickActions',
	'object' : 'Account', /* (Required) The associated SObject API name, or 'Global' */
	'data' : {
		'RecordTypeName': 'CustomRecordType', /* (Optional) The RecordType DeveloperName (API Name) for the desired SObject's page layout */
		'RecordTypeId' : '0123456789ABCDEFGH' /* (Optional) The RecordType Id for the desired SObject's page layout */
	}
};
bridge.send(request, function(responseData) {
	if ((responseData.type === 'quickactionsResponse')
		&& (responseData.data != null))
	{
		var quickActionArray = responseData.data;
		/* the response array contains QuickAction metadata  */
		
	} else {
		// handle the API error or cancellation ...
	}
});

cameraPhoto

The cameraPhoto API opens the device camera, allowing the user to take a photo. The callback response data contains the file path of the generated photo. An optional “quality” param takes a string value of “high” (100%), “medium” (80%), or “low” (60%).

var request = { 
	"type" : "cameraPhoto",
	"data" : { "quality" : "medium" // optional parameter} 
};
bridge.send(request, function (responseData) { 
	if ((responseData.type == 'cameraPhotoResponse')
		&& (responseData.data != null)) { 
			var filePath = responseData.data.FilePath;
			var fileUrl = responseData.data.FileURL;                // new for 6.0
			var relativePath = responseData.data.RelativeFilePath;  // new for 6.0
			var contentType = responseData.data.ContentType;
			alert('camera photo path: ' + filePath + ' content type: ' + contentType); 
	}
});

cameraPhotoPicker

The cameraPhotoPicker API opens the device photo library, allowing the user to pick photos. The callback response data contains an array of objects containing file path and content type.

var request = {
	'type' = 'cameraPhotoPicker',
	'data' : { /* data is empty */ } 
};
bridge.send(request, function(responseData) {
    if ((responseData.type === 'cameraPhotoPickerResponse')
		&& (responseData.data != null))
	{
		var arrResult = responseData.data;
        var len = arrResult.length;
        for (var i=0; i<len; i++) {
 			var filePath = arrResult[i].FilePath;
			var fileUrl = arrResult[i].FileURL;               // new for 6.0
			var relativePath = arrResult[i].RelativeFilePath; // new for 6.0
            var contentType = arrResult[i].ContentType;
			console.log('camera photo path: ' + filePath + ' content type: ' + contentType); 
			// ...
        }
    } else {
		// handle error or cancellation ...
    }
});

filePicker

The filePicker API opens the file picker dialog for the device, allowing the user to pick arbitrary files. The callback response data contains an array of objects containing file path and content type.

var request = {
	'type' : 'filePicker',
	'data' : { /* data is empty */ }
};
bridge.send(request, function(responseData) {
	if ((responseData.type === 'filePickerResponse')
		&& (responseData.data != null))
	{
		var arrResult = responseData.data;
		var len = arrResult.length;
		for (var i=0; i<len; i++) {
			var filePath = arrResult[i].FilePath;
			var fileUrl = arrResult[i].FileURL;               // new for 6.0
			var relativePath = arrResult[i].RelativeFilePath; // new for 6.0
            var contentType = arrResult[i].ContentType;
			console.log('camera photo path: ' + filePath + ' content type: ' + contentType); 
			// ...
		}
	} else {
		// handle error or cancellation ...
	}
});

displayUrl

The displayUrl API allows loading a URL in a Pulsar embedded browser window. The caller may specify the following arguments:

fullUrl - (Optional) The full url to open in the browser window- this ignores the scheme, path, and queryParams parameters
externalBrowser - (Optional, default is false) Tell Pulsar whether to attempt to open the link inside of Pulsar or try to open in the system browser
scheme - (Optional) The scheme to use, for example "file://" for file URLs. ("https://" if not specified)
path - (Optional, if fullUrl specified) This is the combination of the host (if necessary) and path portion of the URL. For instance: "example.com/path/to/resource"
queryParams (Optional) This is a set of key/value pairs to be used to create a URL query parameter string. For example, in the final URL, the following queryParams data:
{ "param1": "value1", "param2": "value2" }

will become:

param1=value1&param2=value2

On Android, Pulsar will always attempt to open unencrypted HTTP URLs ("http://" without the "s") in an external browser app. This is due to security restrictions in place for the Android operating system.

// open a webview with the url "https://example.com/path/to/resource/?param1=value1&param2=value2
var request = { 
	"type" : "displayUrl",
	"data" : { 
		"externalBrowser" : true,
		"scheme" : "https://",
		"path" : "example.com/path/to/resource",
		"queryParams" : { "param1": "value1", "param2": "value2" } 
	}
};
bridge.send(request, function (responseData) { 
	if ((responseData.type !== 'displayUrlResponse')
		&& (responseData.data != null)) { 
			alert('Error occurred: ' + responseData.data); 
	}
});

Pulsar for Salesforce - Documentation

Native Pulsar UI Interaction API