1 General Information
- 1.1 userInfo
- 1.2 userPhoto
- 1.3 getDevServerEnabled
- 1.4 getPlatform
- 1.5 getLocation
- 1.6 getCustomLabels
2 Logging
- 2.1 logMessage

General Information

userInfo

The userInfo query returns the following information about the currently logged in user:

Salesforce Username
Salesforce UserId
Salesforce User Locale
Salesforce User Language
Salesforce User Full Name
Salesforce User Profile Id
Salesforce User Profile Name (if available)
Salesforce User Role Id
Salesforce User Role Name (if available)
Salesforce Org Id
Salesforce Session Id
Salesforce Instance URL
Pulsar Last Successful Sync date (or "1970-01-01T00:00:00.000Z" if never synced)
Pulsar Version
Device Language

Pulsar 9.0+ also includes

Pulsar Last Failed Sync date (or "1970-01-01T00:00:00.000Z" if never synced)
Salesforce User small photo URL
Salesforce User full photo URL

Example Response:

{
    "type": "userInfoResponse",
    "object": "",
    "data": {
        "devicelanguage": "en",
        "instanceurl": "https://mycompanydemo.my.salesforce.com/",
        "lastfailedsync": "1970-01-01T00:00:00.000Z",
        "lastsuccessfulsync": "1970-01-01T00:00:00.000Z",
        "locale": "en_US",
        "organizationid": "00D6A000001dc2eAAA",
        "sessionid": "00D6A000001dc2e!ABCDEFG1tC2a3gaJIkss4YkqdBc56eLWp7qvtylTPZFu8PW9aaFzcwWaVHc0FvebtMA1W2pfV_yBX7yPJyFm3fl4xHElVniN",
        "userFullPhoto": "http://127.0.0.1:12345/images/userPhoto/full",
        "userSmallPhoto": "http://127.0.0.1:12345/images/userPhoto/small",
        "userfullname": "John Doe",
        "userid": "0056A000001bCD2ABC",
        "userlanguage": "en_US",
        "username": "johndoe@mycompany.demo",
        "userprofileid": "00e6A0000001bcDEFG",
        "userprofilename": "Standard User",
        "userroleid": "00E6A0000002cdEFGH",
        "userrolename": "SVP, Customer Service & Support",
        "version": "9.0.0.0"
    }
}

Usage:

var request = {
    "type" : "userInfo",
    "data" : { } // empty object- this is required in the current API
};
 
bridge.send(request, function (results) {
    console.log('Javascript got its response: ' + results);
    if (results.type === "userInfoResponse")    {
        username =    results.data.username;
        userid =      results.data.userid;
        userlocale =  results.data.locale;
        fullname =    results.data.userfullname;
        /* additional fields available in response not shown in this example */
    } else if (results.type == 'error') {
        errStr = results.data;
        alert('A problem occurred:\n' + errStr);
    }
});

userPhoto

The userPhoto query returns the following information about the currently logged in user:

Salesforce User small photo URL
Salesforce User full photo URL

var request = {
    "type" : "userPhoto",
    "data" : { } // empty object- this is required in the current API
};
 
bridge.send(request, function (results) {
    console.log('Javascript got its response: ' + results);
    if (results.type === "userPhotoResponse")   {
        smallPhoto =    results.data.smallphoto;
        fullPhoto =      results.data.fullphoto;
    } else if (results.type == 'error') {
        errStr = results.data;
        alert('A problem occurred:\n' + errStr);
    }
});

getDevServerEnabled

The getDevServerEnabled API returns "TRUE" or "FALSE" depending on whether the Local Development Server is currently enabled for the current user, and (optional) given document Id.

var request = {
    "type" : "getDevServerEnabled",
    "args" : { "docId": "SomeDocumentId }
    "data" : { } // empty object- this is required in the current API
};
 
bridge.send(request, function (results) {
    console.log('Javascript got its response: ' + results);
    if (results.type === "devserverenabledResponse")    {
        var enabled = results.data;
        var enabledString = (enabled === "TRUE") ? "enabled" : "NOT enabled";
        alert('This local development server is ' + enabledString);
    } else if (results.type == 'error') {
         errStr = results.data;
         alert('A problem occurred:\n' + errStr);
    }
});

getPlatform

The getPlatform query returns one of the following:

windows
android
ios

var request = {
    "type" : "getPlatform",
    "data" : { } // empty object- this is required in the current API
};
 
bridge.send(request, function (results) {
    console.log('Javascript got its response: ' + results);
    if (results.type === "platformResponse")    {
        var platform = results.data;
        alert('This platform reports as:  ' + platform);
 
    } else if (results.type == 'error') {
         errStr = results.data;
         alert('A problem occurred:\n' + errStr);
    }
});

getLocation

The getLocation query returns the device location coordinates, in the form of a javascript object with "longitude" and "latitude" properties. This will not work properly if the user does not grant the app access to the device's location services. An optional parameter may be used to request one of the following levels of accuracy: Fine, Medium, Coarse. If no value is specified, Medium will used as the default. Retrieving location may also be a slow process. Consider tuning pulsar.location.updateFrequencySeconds Pulsar Setting to adjust the trade off between accuracy and speed.

var request = {
    "type" : "getLocation",
    "data" : { "locationAccuracy" : "Fine" }
};
 
bridge.send(request, function (results) {
    console.log('Javascript got its response: ' + results);
    if (results.type === "getLocationResponse") {
        var coord = results.data;
        alert('This device is at longitude: ' + coord.longitude + ' latitude: ' + coord.latitude + '. Accuracy level used was: ' + coord.locationAccuracy);
 
    } else if (results.type == 'error') {
         errStr = results.data;
         alert('A problem occurred:\n' + errStr);
    }
});

getCustomLabels

The getCustomLabels request allows you to retrieve the Salesforce Custom Labels that have been previously post-processed into auto-generated Pulsar Settings. This request will return a getCustomLabelsResponse containing a data object with the label name, value pairs.

var request = { 
    "type" : "getCustomLabels",
    "data" : {
        "labelNames" : [ "Foo_Label", "Bar_Label" ]
                            // Required. List of Custom Label Names to retrieve.
        "locale" : "es_MX", // Optional. Specify a `lang_Locale`, or just `lang`. (e.g.: 'es_MX', or 'es').
                            // - If specified: if label not found, returns null
                            // - If not specified: uses current user `lang_Locale`. If label not found, falls back to `lang`.
                            //   If label still not found, falls back to 'en_US'. If label still not found, returns null
    }
};
bridge.send(request, function (responseData) {
    if ((responseData.type == 'getCustomLabelsResponse') {
        const fooLabelValue = responseData.data.Foo_Label;
        const barLabelValue = responseData.data.Bar_Label;
        // ...
    } else {
        console.log('failed: '+ responseData.data);
    }
});

Logging

logMessage

The logMessage action logs a message to the Pulsar log. The log message will appear in the Pulsar log prefixed with "JSAPI: ". With this API call you can create your own logger function.

Optionally, you may specify the log level you wish to appear in the Pulsar log. The available levels are:

"info" - The default level. Logs will include the "[INFO]" tag
"warn" - Logs will include the "[WARN]" tag
"error" - Logs will include the "[ERROR]" tag
"debug" - Logs will include the "[DEBUG]" tag and will only appear when debug logging has been turned on in Pulsar
“Verbose” - Extra debug-level information will appear in the logs

function log(level, mesg) {
     var request = {};
     request["type"] = 'logMessage';
     // Message should be part of the data object, but it is also possible to use the message string in place of a data object
     request["data"] = {
            "message": mesg,
            "level" : level // optional - "info","warn","error" or "debug"
     };
     bridge.send(request, function(results) {
        if (results.type == 'error') {
            alert('There was a logging error!');
        }
     });
   }
  
log("info","This is a test log message!");

The above would result in the following message in the Pulsar log:

JSAPI: This is a test log message!

Pulsar for Salesforce - Documentation

Pulsar General Information API