gapi()¶
- Call:
appc.gapi()
- Parameters: none
- Returns: New gapi instance
Description:
Create a new Netrunr GAPI instance.
All of the GAPI methods described in this document are accessed through a GAPI instance.
Example:
var gapi = new appc.gapi();
// gapi.<a GAPI method> e.g.
gapi.login(params_object, success, error);
version(params, success, error)¶
- Call:
appc.gapi.prototype.version(params, success, error)
- Parameters: params, success, error
params: an empty object:
{ }
success: a callback accepting an object:
{
result: <result code>,
version: "<software version>",
system: "<system version>"
}
error: a callback accepting an object:
{ result: <result code> }
Description:
Get Netrunr software version information.
Example:
var gapi = new appc.gapi();
gapi.version({}, function(robj) {
console.log('version: software version: ' + robj.version);
console.log('version: system version: ' + robj.system);
}, function(robj) {
console.log('version: ERROR: ' + robj.result);
});
versionsdk(params, success, error)¶
- Call:
appc.gapi.prototype.versionsdk(params, success, error)
- Parameters: params, success, error
params: an empty object
{ }
success: a callback accepting an object:
{
result: <result code>,
version: "<SDK version>"
}
error: A callback accepting an error object.
{ result: <result code> }
Description:
Get Netrunr SDK version information.
Example:
gapi.versionsdk({}, function(robj) {
console.log('versionsdk: SDK version: ' + robj.version);
}, function(robj) {
console.log('version: ERROR: ' + robj.result);
});