3-9. Pulsar System Interaction API

Export

saveAs

The saveAs operation will allow you to generate and display a PDF or PNG image file of the currently displayed document. This is useful for exporting displayed data or saving completed forms. This request returns the file path to the resulting PDF (default) or PNG image. In the below example we return image file path.

var request = { 
	"type" : "saveAs",
	"data" : { 
				"filename" : "demo.pdf", // the filename of the created PDF file - required
				"displayresult" : 0,      // this is a number, positive to display the file, 0 to simply return data
				"format" : "image"  // this is a string, either "image" or "pdf"-- default is "pdf" 
			 }
};

bridge.sendRequest(request, function (results) {
   console.log('Javascript got its response: ' + str(results));
   if (results.type === "saveAsResponse")	{
     var imageFilePath = results.data.FilePath;  // the resulting contains the file path to the file
      //do something with the data
   } else if (results.type == 'error') {
         errStr = results.data;
         alert('A problem occurred:\n' + errStr);
   }
});

print

The print operation will allow you to print the currently displayed document using the available system printing resources. This is useful for printing displayed data or saving completed forms (for example, printing to a file, if the option is available)

var request = { 
	"type" : "print",
	"data" : { 
				// data is empty
			 }
};

bridge.sendRequest(request, function (results) {
   console.log('Javascript got its response: ' + str(results));
   if (results.type === "printResponse")	{
      // success case
   } else if (results.type == 'error') {
         errStr = results.data;
         alert('A problem occurred:\n' + errStr);
   }
});

Communication

mail

The mail API allows you to open a pre-populated draft email composer window. The user can then make any necessary edits and send the email. The user will then be returned to the App running in Pulsar. This API is currently only supported on the iOS Pulsar platform.

var request = {
	"type" = "mail";
    "data" = { 
                "to"     : [ "list_of@emails.com" ],    // array of emails, optional
                "cc"     : [ "list_of_cc@emails.com" ], // array of emails, optional
                "attach" : [ "/list/of/file/paths" ],   // array of file paths to attach, optional
                "subject": "subject of this email",     // email subject text, optional
                "body"   : "body of the email ",        // body text, optional
            };
bridge.sendRequest(request, function (results) {
   console.log('Javascript got its response: ' + str(results));
});