3-10. Pulsar Online Status API

Online Status

getOnlineStatus

The getOnlineStatus operation will return Pulsar's current "online" status. If the user is working offline, whether by disconnecting the device from the network or toggling the "Work Offline" switch in the app, this will return "FALSE". If online, this operation will return "TRUE".

var request = { 
	"type" : "getOnlineStatus",
	"data" : { } // empty object- this is required in the current API
};

bridge.sendRequest(request, function (results) {
	console.log('Javascript got its response: ' + str(results));
    if (results.type === "getOnlineStatusResponse")	{
		var isOnline = results.data; "TRUE" or "FALSE"
		// do something with the information
    } else if (results.type == 'error') {
	    errStr = results.data;
	    alert('A problem occurred:\n' + errStr);
    }
});

setOnlineStatus

The setOnlineStatus operation will attempt to change Pulsar's current "online" status. Sending "True" will request an online status, and sending "False" will request an offline status. If the user is offline and requesting to work online (sends "True") and the operation is successful, this will return "TRUE". If unsuccessful, such as if the network is disconnected, Pulsar is still offline, and this operation will return "FALSE".

var request = { 
	"type" : "setOnlineStatus",
	"data" : "FALSE"
};

bridge.sendRequest(request, function (results) {
	console.log('Javascript got its response: ' + str(results));
    if (results.type === "setOnlineStatusResponse")	{
		var isOnline = results.data; "TRUE" or "FALSE"
		// do something with the information
    } else if (results.type == 'error') {
	    errStr = results.data;
	    alert('A problem occurred:\n' + errStr);
    }
});