Module: rosetta-api

Rosetta API

Source: rosettajs/dist/lib/rosetta/API.js, line 55

Methods

(inner) createDominoAccessObject(credentials) → {*}

DRAPI framework based API: createDominoAccessObject; Creates the Domino Access object to be used under the DRAPI API layer

Parameters:

Name	Type	Description
`credentials`	*	The credentials used in creating the Domino Access object

Source: rosettajs/dist/lib/rosetta/API.js, line 966

Throws:

Error object with string representing the failure message
Type Object

Returns:

The Domino Access object that provides authentication support

Type:: *

(inner) deregisterAPI(apiRef, data)

Deregister an API defined by an extension definition objects.

Parameters:

Name	Type	Description
`apiRef`	object	reference to the rosetta api object
`data`	Array	a JSON objects representing a custom API that have been registered. See registerAPI data parameter for schema.

Source: rosettajs/dist/lib/rosetta/API.js, line 495

Throws:

An error if the deregister failed.

(inner) deregisterAPIs(apiRef, dataArray) → {Array}

Deregister APIs from an array of JSON API extension definition objects.

Parameters:

Name	Type	Description
`apiRef`	object	reference to the rosetta api object
`dataArray`	Array	an array of JSON objects, each representing a custom APIs that have been registered. See registerAPI data parameter for schema.

Source: rosettajs/dist/lib/rosetta/API.js, line 628

Returns:

An array of errors indicating any APIs that failed to deregister. An empty array if all were successful.

Type:: Array

(inner) getActionEventObject() → {*}

Volt MX framework based API: getActionEventObject; Gets the Action Event Object

Source: rosettajs/dist/lib/rosetta/API.js, line 1017

Throws:

Error object with string representing the failure message
Type Object

Returns:

The current Action Event Object

Type:: *

(inner) getCurrentFramework() → {string}

Get current framework

Source: rosettajs/dist/lib/rosetta/API.js, line 157

Returns:

current framework

Type:: string

(inner) getCurrentScopeName() → {String}

DRAPI framework based API: getCurrentScopeName; Gets the current scope name being used under the DRAPI API layer

Source: rosettajs/dist/lib/rosetta/API.js, line 990

Throws:

Error object with string representing the failure message
Type Object

Returns:

The current scope name under the DRAPI API layer

Type:: String

(inner) getCurrentServerDatabase() → {String}

Volt MX framework based API: getCurrentServerDatabase; Get the server location and file name being used under the VoltMX API layer

Source: rosettajs/dist/lib/rosetta/API.js, line 926

Throws:

Error object with string representing the failure message
Type Object

Returns:

The server location and file name of the database under the VoltMX API layer

Type:: String

(inner) getCurrentServiceName() → {String}

Volt MX framework based API: getCurrentServiceName; Gets the current service name being used under the VoltMX API layer

Source: rosettajs/dist/lib/rosetta/API.js, line 978

Throws:

Error object with string representing the failure message
Type Object

Returns:

The current service name under the VoltMX API layer

Type:: String

(inner) getDefaultAPI() → {string}

Set getDefaultAPI

Source: rosettajs/dist/lib/rosetta/API.js, line 91

Returns:

the default API currently set

Type:: string

(inner) getDefaultContext() → {string}

Get default context

Source: rosettajs/dist/lib/rosetta/API.js, line 183

Returns:

the currently set default context (all|local|db)

Type:: string

(inner) getDefaultFramework() → {string}

Get default framework

Source: rosettajs/dist/lib/rosetta/API.js, line 126

Returns:

default framework (JS or VMX)

Type:: string

(inner) getDefaultServiceType() → {String}

Volt MX framework based API: getDefaultServiceType; returns the default service type under the VoltMX API layer expressed as a string

Source: rosettajs/dist/lib/rosetta/API.js, line 800

Throws:

Error object with string representing the failure message
Type String

Returns:

The default service type under the VoltMX API layer

Type:: String

(inner) getDominoAccessObject() → {*}

DRAPI framework based API: getCurrentScopeName; Gets the Domino Access object to be used under the DRAPI API layer

Source: rosettajs/dist/lib/rosetta/API.js, line 953

Throws:

Error object with string representing the failure message
Type Object

Returns:

dominoAccess The Domino Access object that provides authentication support

Type:: *

(inner) getServiceType(serviceName) → {string}

getServiceType

Parameters:

Name	Type	Description
`serviceName`	string	for the Volt MX Object Service

Source: rosettajs/dist/lib/rosetta/API.js, line 763

Returns:

the service type for the specified service

Type:: string

(inner) isCurrentAPINotes() → {boolean}

Is current API Notes.

Source: rosettajs/dist/lib/rosetta/API.js, line 114

Returns:

True if the current API is set to Notes; false otherwise

Type:: boolean

(inner) isCurrentAPIOpenFormula() → {boolean}

Is current API Open Formula.

Source: rosettajs/dist/lib/rosetta/API.js, line 120

Returns:

True if the current API is set to Open Formula false otherwise

Type:: boolean

(inner) isCurrentContextAll() → {boolean}

Is current context all?

Source: rosettajs/dist/lib/rosetta/API.js, line 214

Returns:

true if the current context is set to all; false otherwise

Type:: boolean

(inner) isCurrentContextDb() → {boolean}

Is current context database?

Source: rosettajs/dist/lib/rosetta/API.js, line 224

Returns:

true if the current context is set to db; false otherwise

Type:: boolean

(inner) isCurrentContextLocal() → {boolean}

Is current context local?

Source: rosettajs/dist/lib/rosetta/API.js, line 219

Returns:

true if the current context is set to local; false otherwise

Type:: boolean

(inner) isCurrentFrameworkDRAPI() → {boolean}

Is current framework Javascript.

Source: rosettajs/dist/lib/rosetta/API.js, line 177

Returns:

True if the current framework is set to js; false otherwise

Type:: boolean

(inner) isCurrentFrameworkJS() → {boolean}

Is current framework Javascript.

Source: rosettajs/dist/lib/rosetta/API.js, line 171

Returns:

True if the current framework is set to js; false otherwise

Type:: boolean

(inner) isCurrentFrameworkVoltMX() → {boolean}

Is current framework Volt MX.

Source: rosettajs/dist/lib/rosetta/API.js, line 165

Returns:

True if the current framework is set to vmx; false otherwise

Type:: boolean

(inner) isCurrentServiceTypeDRAPI() → {Boolean}

DRAPI framework based API: isCurrentServiceTypeDRAPI; Is current service type "drapi"?

Source: rosettajs/dist/lib/rosetta/API.js, line 899

Throws:

Error object with string representing the failure message
Type Object

Returns:

true if the current service type is set to integration

Type:: Boolean

(inner) isCurrentServiceTypeIntegration() → {Boolean}

Volt MX framework based API: isCurrentServiceTypeIntegration; Is current service type "integration"?

Source: rosettajs/dist/lib/rosetta/API.js, line 887

Throws:

Error object with string representing the failure message
Type Object

Returns:

true if the current service type is set to integration

Type:: Boolean

(inner) isCurrentServiceTypeOfflineObjects() → {Boolean}

Volt MX framework based API: isCurrentServiceTypeOfflineObjects; Is current service type "object.offline"?

Source: rosettajs/dist/lib/rosetta/API.js, line 875

Throws:

Error object with string representing the failure message
Type Object

Returns:

true if the current service type is set to object.offline

Type:: Boolean

(inner) isCurrentServiceTypeOnlineObjects() → {Boolean}

Volt MX framework based API: isCurrentServiceTypeOnlineObjects; Is current service type "object.online"?

Source: rosettajs/dist/lib/rosetta/API.js, line 863

Throws:

Error object with string representing the failure message
Type Object

Returns:

true if the current service type is set to object.online

Type:: Boolean

(inner) parseCustomData(data) → {object}

Parse information from an object defining an extened API.

Parameters:

Name	Type	Description
`data`	object	object defining the extended API.

Source: rosettajs/dist/lib/rosetta/API.js, line 270

Returns:

Information about the extended API defined by data. The following keys will be returned: name, namef, funcArgs, cat, lang, and code. The any optional settings in data will be resolved to values in the returned object. funcArgs will contain any arguments defined for name.

Type:: object

(inner) registerAPI(apiRef, data) → {Object}

Register an API by adding it as an object to the referential array of APIs Defines/redefines the Rosetta API library by creating/updating a node in the API object The API object may be redefined if when using the existing category, name, language combination If language param is supplied, the API node will also define the method at the formula language level and the main method will point to call the method inside the language object

Parameters:

Name Type Description

Name	Type	Description
`apiRef`	Object	required. reference to the rosetta API object tree where to register the method.
`data`	Object	required. object defining the extended API. object props as follows: "name" :required. the API method name to register under rosetta "cat" :optional. the category name where the API name will be defined under. default: "Custom" "lang" :optional. the formula language implementation layer to register the method under. default: undefined "namef":optional. the method name to use in the formula lang implementations layer. default: name arg "code" : <String\|Function> optional. a string with the formula to convert or a callback function. default: noop: () => {}

apiRef

Object

required. reference to the rosetta API object tree where to register the method.

data

Object

required. object defining the extended API. object props as follows:

"name" :required. the API method name to register under rosetta
"cat" :optional. the category name where the API name will be defined under. default: "Custom"
"lang" :optional. the formula language implementation layer to register the method under. default: undefined
"namef":optional. the method name to use in the formula lang implementations layer. default: name arg
"code" : <String|Function> optional. a string with the formula to convert or a callback function. default: noop: () => {}

Source: rosettajs/dist/lib/rosetta/API.js, line 458

Throws:

Error object string representing registration failure
Type String

Returns:

the return value from registerCustomAPI

Type:: Object

Example

// code as actual js arrow function object, default params for the rest
// defines <rosettaObj>.Custom.hello = s => alert(`hello $(s)}`)
registerAPI(
  apiRef:rosettajs,
  {
    "name":"hello(s)",
    "code": s => alert(`hello $(s)}`)
  }
);

// code as actual js function object,
// defines <rosettaObj>.Text.hello(args...) -> .Text._notes.Hello_Test(args...) = function(name) { return "hello " + name; }
registerAPI(
  apiRef:rosettajs,
  {
    "name": "hello(name)",
    "cat": "Text",
    "lang": "notes",
    "namef": "Hello_Test",
    "code": function(name) { return "hello " + name; }
  }
);

// code as stringified js function body,
// defines <rosettaObj>.Text.hellop(args...) -> .Text._notes.HelloPhone_Test(args...) = function(name,phone) { return `hello ${name}. phone is ${phone}` }
registerAPI(
  apiRef:rosettajs,
  {
    "name": "hellop(name,phone)",
    "cat": "Text",
    "lang": "notes",
    "namef": "HelloPhone_Test",
    "code": "{ return `hello ${name}. phone is ${phone}` }"
  }

// code as stringified notes formula code (gets auto-converted to rosettajs),
// defines <rosettaObj>.Custom.myAbs -> .Custom._notes.myAbs(args...) = n => { return rosettajs.Math.abs(n)+10 }`)
registerAPI(
  apiRef:rosettajs,
  {
    "name":"myAbs(n)",
    "code": "@Abs(n)+10;"
  }
);

// code as stringified open formula code (gets auto-converted to rosettajs),
// defines <rosettaObj>.Custom.myAbs -> .Custom._openFormula.MYABS(args...) = n => { return rosettajs.Math.abs(n)+10 }`)
registerAPI(
  apiRef:rosettajs,
  {
    "name":"myAbs(n)",
    "namef": "MYABS"
    "code": "=ABS(n)+10;"
  }
);

(inner) registerAPIs(apiRef, dataArray) → {Array}

Register APIs from an array of JSON API extension definition objects. Each object in the array must adhere to schema required in registerAPI method

Parameters:

Name	Type	Description
`apiRef`	String	required. reference to the rosetta api object tree
`dataArray`	Array	an array of JSON objects, each representing a custom API to register. See registerAPI data parameter for schema.

Source: rosettajs/dist/lib/rosetta/API.js, line 604

Throws:

Error object string representing registration failure
Type String

Returns:

Array of callbacks for the API methods registered

Type:: Array

Example

registerAPI(
  apiRef:rosettajs,
  [
    { // defines: <rosettajs>.Custom.simplest = () => { }
      "name": "simplest"
    },
    { // defines: <rosettajs>.Text.simpler = () => { }
      "name": "simpler",
      "cat": "Text",
    },
    { // defines: <rosettajs>.Text.simple = function(x) { return x+1; }
      "name": "simple(x)",
      "cat": "Text",
      "code": function(x) { return x+1; }
    },
    { // defines: <rosettajs>.Text.simple = function(x) { this._notes.simple(): function(x) { return x+1; } }
      "name": "simpleNotes(x)",
      "cat": "Text",
      "lang": "notes",
      "code": function(x) { return x+1; }
    },
    { // defines: <rosettajs>.Text.simple = function(x) { this._notes.ADVanceNOTES123(): function(x) { return x+1; } }
      "name": "advancedNotes(x)",
      "cat": "Text",
      "lang": "notes",
      "namef": "ADVanceNOTES123",
      "code": function(x) { return x+1; }
    },
    {
      "cat": "Text",
      "name": "hello(name)",
      "lang": "notes",
      "namef": "Hello",
      "code": function(name) { return "hello " + name; }
    },
    {
      "name": "goodbye(name)",
      "lang": "notes",
      "cat": "Text",
      "code": function(name) { return "bye bye " + name; }
    },
    { // defines: <rosettajs>.Custom.weather = function(x) { this._openFormula.WEATHER(): function(zip) { return "Sunny in " + zip; } }
      "name": "WEATHER(zip)",
      "lang": "open formula",
      "cat": "Custom",
      "code": function (zip) { return "Sunny in " + zip; }
    },
    { // defines: <rosettajs>.Custom.absPlusX = function(n,x) { this._notes.absPlusX(): javascript conversion result from "@Abs(n)+x" }
      "name": "AbsPlusX(n; x)",
      "lang": "notes",
      "cat": "Custom",
      "code": "@Abs(n)+x;"
    }
  ]
);

(inner) rosettajsLogger() → {*}

rosettajsLogger; returns the logger object

Source: rosettajs/dist/lib/rosetta/API.js, line 745

Throws:

Error object with string representing the failure message
Type Error

Returns:

The rosettajs logger object

Type:: *

(inner) setActionEventObject(eventobject)

Volt MX framework based API: setActionEventObject; Sets the Action Event Object

Parameters:

Name	Type	Description
`eventobject`	*	The Action Event Object used by Action Widgets.

Source: rosettajs/dist/lib/rosetta/API.js, line 1002

Throws:

Error object with string representing the failure message
Type Object

(inner) setCurrentServerDatabase(serverDatabase)

Volt MX framework based API: setCurrentServerDatabase; Sets the server location and file name to be used under the VoltMX API layer

Parameters:

Name	Type	Description
`serverDatabase`	*	The server location and file name of the database.

Source: rosettajs/dist/lib/rosetta/API.js, line 911

Throws:

Error object with string representing the failure message
Type Object

(inner) setDefaultAPIAsNotes() → {string}

Set default API to Notes when an underlaying Open Formula API function with the same name exists.

Source: rosettajs/dist/lib/rosetta/API.js, line 97

Returns:

The default API

Type:: string

(inner) setDefaultAPIAsOpenFormula() → {string}

Set default API to Open Formula when an underlaying Notes API function with the same name exists.

Source: rosettajs/dist/lib/rosetta/API.js, line 105

Returns:

The default API

Type:: string

(inner) setDefaultContextAsAll() → {string}

Set default context to all

Source: rosettajs/dist/lib/rosetta/API.js, line 190

Returns:

The default context

Type:: string

(inner) setDefaultContextAsDb() → {string}

Set default context to db

Source: rosettajs/dist/lib/rosetta/API.js, line 206

Returns:

The default context

Type:: string

(inner) setDefaultContextAsLocal() → {string}

Set default context to local

Source: rosettajs/dist/lib/rosetta/API.js, line 198

Returns:

The default context

Type:: string

(inner) setDefaultFrameworkAsDRAPI() → {string}

Set default framework to drapi

Source: rosettajs/dist/lib/rosetta/API.js, line 149

Returns:

The default framework

Type:: string

(inner) setDefaultFrameworkAsJS() → {string}

Set default framework to javascript

Source: rosettajs/dist/lib/rosetta/API.js, line 141

Returns:

The default framework

Type:: string

(inner) setDefaultFrameworkAsVoltMX() → {string}

Set default framework to voltmx

Source: rosettajs/dist/lib/rosetta/API.js, line 133

Returns:

The default framework

Type:: string

(inner) setDefaultServiceTypeAsDRAPI() → {String}

DRAPI framework based API: setDefaultServiceTypeAsDRAPI; Sets the default service type to "drapi", under the DRAPI API layer

Source: rosettajs/dist/lib/rosetta/API.js, line 851

Throws:

Error object with string representing the failure message
Type Object

Returns:

The default service type

Type:: String

(inner) setDefaultServiceTypeAsIntegration() → {String}

Volt MX framework based API: setDefaultServiceTypeAsIntegration; Sets the default service type to "integration", under the VoltMX API layer

Source: rosettajs/dist/lib/rosetta/API.js, line 839

Throws:

Error object with string representing the failure message
Type Object

Returns:

The default service type

Type:: String

(inner) setDefaultServiceTypeAsOfflineObjects() → {String}

Volt MX framework based API: setDefaultServiceTypeAsOfflineObjects; Sets the default service type to "object.offline", under the VoltMX API layer

Source: rosettajs/dist/lib/rosetta/API.js, line 827

Throws:

Error object with string representing the failure message
Type Object

Returns:

The default service type

Type:: String

(inner) setDefaultServiceTypeAsOnlineObjects() → {String}

Volt MX framework based API: setDefaultServiceTypeAsOnlineObjects; Sets the default service type to "object.online", under the VoltMX API layer

Source: rosettajs/dist/lib/rosetta/API.js, line 815

Throws:

Error object with string representing the failure message
Type Object

Returns:

The default service type

Type:: String

(inner) setDominoAccessObject(dominoAccess)

DRAPI framework based API: setCurrentScopeName; Sets the Domino Access object to be used under the DRAPI API layer

Parameters:

Name	Type	Description
`dominoAccess`	*	The Domino Access object that provides authentication support

Source: rosettajs/dist/lib/rosetta/API.js, line 941

Throws:

Error object with string representing the failure message
Type Object

(inner) setServiceTypeAsOfflineObjects(serviceName) → {string}

setServiceTypeAsOfflineObjects(serviceName)

Parameters:

Name	Type	Description
`serviceName`	string	for the Volt MX Object Service

Source: rosettajs/dist/lib/rosetta/API.js, line 777

Returns:

the service type for the specified service

Type:: string

(inner) setServiceTypeAsOnlineObjects(serviceName) → {string}

setServiceTypeAsOnlineObjects(serviceName)

Parameters:

Name	Type	Description
`serviceName`	string	for the Volt MX Object Service

Source: rosettajs/dist/lib/rosetta/API.js, line 788

Returns:

the service type for the specified service

Type:: string