LoopBack API Documentation

Name	Type	Description
app	`Object`	The loopback application created via `app = loopback()`.
options	`Object`
ngModuleName	`string`	A name for the generated Angular module. Default: `lbServices`.
apiUrl	`string`	The URL where the client can access the LoopBack server app. Default: `/`.
includeSchema	`Boolean`	Include model definition.

Name	Type	Description
result	`string`	The generated javascript code.

Class: AccessToken

A $resource object for interacting with the AccessToken model.

Example

See $resource for an example of using this object.

AccessToken.count(parameters, successCb, errorCb)

Count instances of the model matched by where from the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. Data properties: `count` – `{number=}` -

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

AccessToken.create(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.createChangeStream(parameters, postData, successCb, errorCb)

Create a change stream.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. Data properties: `changes` – `{ReadableStream=}` -

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

changes – {ReadableStream=} -

AccessToken.createMany(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

Name	Type	Description
result	`Array.<Object>`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.deleteById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.destroyById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.exists(parameters, successCb, errorCb)

Check whether a model instance exists in the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. Data properties: `exists` – `{boolean=}` -

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

exists – {boolean=} -

AccessToken.find(parameters, successCb, errorCb)

Find all instances of the model matched by filter from the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `filter` – `{object=}` - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"}) `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Array.<Object>`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.findById(parameters, successCb, errorCb)

Find a model instance by {{id}} from the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id `filter` – `{object=}` - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"}) `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

id – {*} - Model id
filter – {object=} - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.findOne(parameters, successCb, errorCb)

Find first instance of the model matched by filter from the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `filter` – `{object=}` - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"}) `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.patchOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.prototype$patchAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - AccessToken id `options` – `{object=}` - `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

id – {*} - AccessToken id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.prototype$updateAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - AccessToken id `options` – `{object=}` - `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

id – {*} - AccessToken id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.removeById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.replaceById(parameters, postData, successCb, errorCb)

Replace attributes for a model instance and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.replaceOrCreate(parameters, postData, successCb, errorCb)

Replace an existing model instance or insert a new one into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.update(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. Information related to the outcome of the operation

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

AccessToken.updateAll(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. Information related to the outcome of the operation

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

AccessToken.updateOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.upsert(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.upsertWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `AccessToken` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

AccessToken.user(parameters, successCb, errorCb)

Fetches belongsTo relation user.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - AccessToken id `options` – `{object=}` - `refresh` – `{boolean=}` - `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

id – {*} - AccessToken id
options – {object=} -
refresh – {boolean=} -
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. (The remote method definition does not provide any description. This usually means the response is a `User` object.)

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

Class: ACL

A $resource object for interacting with the ACL model.

Example

See $resource for an example of using this object.

ACL.count(parameters, successCb, errorCb)

Count instances of the model matched by where from the data source.

Arguments

Name Type Description

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

parameters

Object

Request parameters.

where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server. Data properties: `count` – `{number=}` -

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

ACL.create(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.createChangeStream(parameters, postData, successCb, errorCb)

Create a change stream.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

changes – {ReadableStream=} -

ACL.createMany(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.deleteById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.destroyById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.exists(parameters, successCb, errorCb)

Check whether a model instance exists in the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

exists – {boolean=} -

ACL.find(parameters, successCb, errorCb)

Find all instances of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.findById(parameters, successCb, errorCb)

Find a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
filter – {object=} - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.findOne(parameters, successCb, errorCb)

Find first instance of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.patchOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.prototype$patchAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - ACL id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.prototype$updateAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - ACL id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.removeById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.replaceById(parameters, postData, successCb, errorCb)

Replace attributes for a model instance and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.replaceOrCreate(parameters, postData, successCb, errorCb)

Replace an existing model instance or insert a new one into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.update(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

ACL.updateAll(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

ACL.updateOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.upsert(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

ACL.upsertWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a ACL object.)

Class: Application

A $resource object for interacting with the Application model.

Example

See $resource for an example of using this object.

Application.count(parameters, successCb, errorCb)

Count instances of the model matched by where from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

Application.create(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.createChangeStream(parameters, postData, successCb, errorCb)

Create a change stream.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

changes – {ReadableStream=} -

Application.createMany(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.deleteById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.destroyById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.exists(parameters, successCb, errorCb)

Check whether a model instance exists in the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

exists – {boolean=} -

Application.find(parameters, successCb, errorCb)

Find all instances of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.findById(parameters, successCb, errorCb)

Find a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
filter – {object=} - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.findOne(parameters, successCb, errorCb)

Find first instance of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.patchOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.prototype$patchAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Application id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.prototype$updateAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Application id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.removeById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.replaceById(parameters, postData, successCb, errorCb)

Replace attributes for a model instance and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.replaceOrCreate(parameters, postData, successCb, errorCb)

Replace an existing model instance or insert a new one into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.update(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Application.updateAll(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Application.updateOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.upsert(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Application.upsertWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Application object.)

Class: Change

A $resource object for interacting with the Change model.

Example

See $resource for an example of using this object.

Change.count(parameters, successCb, errorCb)

Count instances of the model matched by where from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

Change.create(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.createChangeStream(parameters, postData, successCb, errorCb)

Create a change stream.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

changes – {ReadableStream=} -

Change.createMany(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.deleteById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.destroyById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.exists(parameters, successCb, errorCb)

Check whether a model instance exists in the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

exists – {boolean=} -

Change.find(parameters, successCb, errorCb)

Find all instances of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.findById(parameters, successCb, errorCb)

Find a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
filter – {object=} - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.findOne(parameters, successCb, errorCb)

Find first instance of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.patchOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.prototype$patchAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Change id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.prototype$updateAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Change id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.removeById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.replaceById(parameters, postData, successCb, errorCb)

Replace attributes for a model instance and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.replaceOrCreate(parameters, postData, successCb, errorCb)

Replace an existing model instance or insert a new one into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.update(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Change.updateAll(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Change.updateOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.upsert(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Change.upsertWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Change object.)

Class: Checkpoint

A $resource object for interacting with the Checkpoint model.

Example

See $resource for an example of using this object.

Checkpoint.count(parameters, successCb, errorCb)

Count instances of the model matched by where from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

Checkpoint.create(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.createChangeStream(parameters, postData, successCb, errorCb)

Create a change stream.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

changes – {ReadableStream=} -

Checkpoint.createMany(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.deleteById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.destroyById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.exists(parameters, successCb, errorCb)

Check whether a model instance exists in the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

exists – {boolean=} -

Checkpoint.find(parameters, successCb, errorCb)

Find all instances of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.findById(parameters, successCb, errorCb)

Find a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
filter – {object=} - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.findOne(parameters, successCb, errorCb)

Find first instance of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.patchOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.prototype$patchAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Checkpoint id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.prototype$updateAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Checkpoint id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.removeById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.replaceById(parameters, postData, successCb, errorCb)

Replace attributes for a model instance and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.replaceOrCreate(parameters, postData, successCb, errorCb)

Replace an existing model instance or insert a new one into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.update(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Checkpoint.updateAll(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Checkpoint.updateOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.upsert(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Checkpoint.upsertWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Checkpoint object.)

Class: Email

A $resource object for interacting with the Email model.

Example

See $resource for an example of using this object.

Class: KeyValueModel

A $resource object for interacting with the KeyValueModel model.

Example

See $resource for an example of using this object.

Class: LoopBackResourceProvider

Use LoopBackResourceProvider to change the global configuration settings used by all models. Note that the provider is available to Configuration Blocks only, see Module Loading & Dependencies for more details.

Example

angular.module('app')
 .config(function(LoopBackResourceProvider) {
    LoopBackResourceProvider.setAuthHeader('X-Access-Token');
 });

LoopBackResourceProvider.getAuthHeader

Get the header name that is used for sending the authentication token.

LoopBackResourceProvider.getUrlBase

Get the URL of the REST API server. The URL provided to the code generator (lb-ng or grunt-loopback-sdk-angular) is used.

LoopBackResourceProvider.setAuthHeader(header)

Configure the REST transport to use a different header for sending the authentication token. It is sent in the Authorization header by default.

Arguments

Name	Type	Description
header	`string`	The header name to use, e.g. `X-Access-Token`

LoopBackResourceProvider.setUrlBase(url)

Change the URL of the REST API server. By default, the URL provided to the code generator (lb-ng or grunt-loopback-sdk-angular) is used.

Arguments

Name	Type	Description
url	`string`	The URL to use, e.g. `/api` or `//example.com/api`.

Class: Role

A $resource object for interacting with the Role model.

Example

See $resource for an example of using this object.

Role.count(parameters, successCb, errorCb)

Count instances of the model matched by where from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

Role.create(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.createChangeStream(parameters, postData, successCb, errorCb)

Create a change stream.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

changes – {ReadableStream=} -

Role.createMany(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.deleteById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.destroyById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.exists(parameters, successCb, errorCb)

Check whether a model instance exists in the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

exists – {boolean=} -

Role.find(parameters, successCb, errorCb)

Find all instances of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.findById(parameters, successCb, errorCb)

Find a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
filter – {object=} - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.findOne(parameters, successCb, errorCb)

Find first instance of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.patchOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.prototype$patchAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Role id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.prototype$updateAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Role id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.removeById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.replaceById(parameters, postData, successCb, errorCb)

Replace attributes for a model instance and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.replaceOrCreate(parameters, postData, successCb, errorCb)

Replace an existing model instance or insert a new one into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.update(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Role.updateAll(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Role.updateOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.upsert(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Role.upsertWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

Class: Role.principals

The object Role.principals groups methods manipulating RoleMapping instances related to Role.

Call Role.principals() to query all related instances.

Role.principals.count(parameters, successCb, errorCb)

Counts principals of Role.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Role id
options – {object=} -
where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

Role.principals.create(parameters, postData, successCb, errorCb)

Creates a new instance in principals of this model.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Role id
postData	`Object`	Request data. `options` – `{object=}` - `data` – `{object=}` - `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

Role.principals.createMany(parameters, postData, successCb, errorCb)

Creates a new instance in principals of this model.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Role id
postData	`Object`	Request data. `options` – `{object=}` - `data` – `{object=}` - `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

Role.principals.destroyAll(parameters, successCb, errorCb)

Deletes all principals of this model.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Role id
options – {object=} -
where – {object=} -
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

Role.principals.destroyById(parameters, successCb, errorCb)

Delete a related item by id for principals.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Role id
options – {object=} -
fk – {*} - Foreign key for principals
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

Role.principals.findById(parameters, successCb, errorCb)

Find a related item by id for principals.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Role id
options – {object=} -
fk – {*} - Foreign key for principals
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

Role.principals(parameters, successCb, errorCb)

Queries principals of Role.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Role id
options – {object=} -
filter – {object=} -
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

Role.principals.updateById(parameters, postData, successCb, errorCb)

Update a related item by id for principals.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{}` - Role id `fk` – `{}` - Foreign key for principals
postData	`Object`	Request data. `options` – `{object=}` - `data` – `{object=}` - `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

Class: RoleMapping

A $resource object for interacting with the RoleMapping model.

Details

Map principals to roles

Example

See $resource for an example of using this object.

RoleMapping.count(parameters, successCb, errorCb)

Count instances of the model matched by where from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

RoleMapping.create(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.createChangeStream(parameters, postData, successCb, errorCb)

Create a change stream.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

changes – {ReadableStream=} -

RoleMapping.createMany(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.deleteById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.destroyById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.exists(parameters, successCb, errorCb)

Check whether a model instance exists in the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

exists – {boolean=} -

RoleMapping.find(parameters, successCb, errorCb)

Find all instances of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.findById(parameters, successCb, errorCb)

Find a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
filter – {object=} - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.findOne(parameters, successCb, errorCb)

Find first instance of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.patchOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.prototype$patchAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - RoleMapping id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.prototype$updateAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - RoleMapping id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.removeById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.replaceById(parameters, postData, successCb, errorCb)

Replace attributes for a model instance and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.replaceOrCreate(parameters, postData, successCb, errorCb)

Replace an existing model instance or insert a new one into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.role(parameters, successCb, errorCb)

Fetches belongsTo relation role.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - RoleMapping id
options – {object=} -
refresh – {boolean=} -
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Role object.)

RoleMapping.update(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

RoleMapping.updateAll(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

RoleMapping.updateOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.upsert(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

RoleMapping.upsertWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a RoleMapping object.)

Class: Scope

A $resource object for interacting with the Scope model.

Details

Schema for Scope which represents the permissions that are granted,to client applications by the resource owner

Example

See $resource for an example of using this object.

Scope.count(parameters, successCb, errorCb)

Count instances of the model matched by where from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

Scope.create(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.createChangeStream(parameters, postData, successCb, errorCb)

Create a change stream.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

changes – {ReadableStream=} -

Scope.createMany(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.deleteById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.destroyById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.exists(parameters, successCb, errorCb)

Check whether a model instance exists in the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

exists – {boolean=} -

Scope.find(parameters, successCb, errorCb)

Find all instances of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.findById(parameters, successCb, errorCb)

Find a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
filter – {object=} - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.findOne(parameters, successCb, errorCb)

Find first instance of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.patchOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.prototype$patchAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Scope id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.prototype$updateAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Scope id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.removeById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.replaceById(parameters, postData, successCb, errorCb)

Replace attributes for a model instance and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.replaceOrCreate(parameters, postData, successCb, errorCb)

Replace an existing model instance or insert a new one into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.update(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Scope.updateAll(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

Scope.updateOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.upsert(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Scope.upsertWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a Scope object.)

Class: User

A $resource object for interacting with the User model.

Example

See $resource for an example of using this object.

User.changePassword(parameters, postData, successCb, errorCb)

Change a user's password.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `id` – `{*=}` - `oldPassword` – `{string}` - `newPassword` – `{string}` - `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

User.confirm(parameters, successCb, errorCb)

Confirm a user registration with identity verification token.

Arguments

Name Type Description

parameters

Object

Request parameters.

uid – {string} -
token – {string} -
redirect – {string=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

User.count(parameters, successCb, errorCb)

Count instances of the model matched by where from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

User.create(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.createChangeStream(parameters, postData, successCb, errorCb)

Create a change stream.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

changes – {ReadableStream=} -

User.createMany(parameters, postData, successCb, errorCb)

Create a new instance of the model and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.deleteById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.destroyById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.exists(parameters, successCb, errorCb)

Check whether a model instance exists in the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

exists – {boolean=} -

User.find(parameters, successCb, errorCb)

Find all instances of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.findById(parameters, successCb, errorCb)

Find a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
filter – {object=} - Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.findOne(parameters, successCb, errorCb)

Find first instance of the model matched by filter from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

filter – {object=} - Filter defining fields, where, include, order, offset, and limit - must be a JSON-encoded string ({"something":"value"})
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.getCachedCurrent

Get data of the currently logged user that was returned by the last call to User.login or User.getCurrent. Return null when there is no user logged in or the data of the current user were not fetched yet.

Returns

Name	Type	Description
result	`Object`	A User instance.

User.getCurrent(successCb, errorCb)

Get data of the currently logged user. Fail with HTTP result 401 when there is no user logged in.

Arguments

Name	Type	Description
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name	Type	Description
result	`Object`	An empty reference that will be populated with the actual data once the response is returned from the server.

User.getCurrentId

Returns

Name	Type	Description
result	`Object`	Id of the currently logged-in user or null.

User.isAuthenticated

Returns

Name	Type	Description
result	`boolean`	True if the current user is authenticated (logged in).

User.login(parameters, postData, successCb, errorCb)

Login a user with username/email and password.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `include` – `{string=}` - Related objects to include in the response. See the description of return value for more details. Default value: `user`. `rememberMe` - `boolean` - Whether the authentication credentials should be remembered in localStorage across app/browser restarts. Default: `true`.
postData	`Object`	Request data. This method expects a subset of model properties as request parameters.
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

The response body contains properties of the AccessToken created on login. Depending on the value of include parameter, the body may contain additional properties:

user - U+007BUserU+007D - Data of the currently logged in user. (include=user)

User.logout(parameters, postData, successCb, errorCb)

Logout a user with access token.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `access_token` – `{string=}` - Do not supply this argument, it is automatically extracted from request headers.
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

User.patchOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.prototype$patchAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - User id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.prototype$updateAttributes(parameters, successCb, errorCb)

Patch attributes for a model instance and persist it into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - User id
options – {object=} -
data – {object=} - An object of model property name/value pairs
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.prototype$verify(parameters, postData, successCb, errorCb)

Trigger user's identity verification with configured verifyOptions

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - User id
postData	`Object`	Request data. `options` – `{object=}` - `verifyOptions` – `{object=}` - `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

User.removeById(parameters, successCb, errorCb)

Delete a model instance by {{id}} from the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - Model id
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.replaceById(parameters, postData, successCb, errorCb)

Replace attributes for a model instance and persist it into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - Model id
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.replaceOrCreate(parameters, postData, successCb, errorCb)

Replace an existing model instance or insert a new one into the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `data` – `{object=}` - Model instance data `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.resetPassword(parameters, postData, successCb, errorCb)

Reset password for a user with email.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. This method expects a subset of model properties as request parameters.
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

User.setPassword(parameters, postData, successCb, errorCb)

Reset user's password via a password-reset token.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. This method does not accept any parameters. Supply an empty object or omit this argument altogether.
postData	`Object`	Request data. `id` – `{*=}` - `newPassword` – `{string}` - `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

User.update(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

User.updateAll(parameters, postData, successCb, errorCb)

Update instances of the model matched by {{where}} from the data source.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Information related to the outcome of the operation

User.updateOrCreate(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.upsert(parameters, successCb, errorCb)

Patch an existing model instance or insert a new one into the data source.

Arguments

Name Type Description

parameters

Object

Request parameters.

data – {object=} - Model instance data
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

User.upsertWithWhere(parameters, postData, successCb, errorCb)

Update an existing model instance or insert a new one into the data source based on the where criteria.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `where` – `{object=}` - Criteria to match model instances
postData	`Object`	Request data. `data` – `{object=}` - An object of model property name/value pairs `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a User object.)

Class: User.accessTokens

The object User.accessTokens groups methods manipulating AccessToken instances related to User.

Call User.accessTokens() to query all related instances.

User.accessTokens(parameters, successCb, errorCb)

Queries accessTokens of User.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - User id
options – {object=} -
filter – {object=} -
options – {object=} -

successCb

function(Array.<Object>, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

User.accessTokens.count(parameters, successCb, errorCb)

Counts accessTokens of User.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - User id
options – {object=} -
where – {object=} - Criteria to match model instances
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

Data properties:

count – {number=} -

User.accessTokens.create(parameters, postData, successCb, errorCb)

Creates a new instance in accessTokens of this model.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - User id
postData	`Object`	Request data. `options` – `{object=}` - `data` – `{object=}` - `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

User.accessTokens.createMany(parameters, postData, successCb, errorCb)

Creates a new instance in accessTokens of this model.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{*}` - User id
postData	`Object`	Request data. `options` – `{object=}` - `data` – `{object=}` - `options` – `{object=}` -
successCb	`function(Array.<Object>, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Array.<Object>

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

User.accessTokens.destroyAll(parameters, successCb, errorCb)

Deletes all accessTokens of this model.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - User id
options – {object=} -
where – {object=} -
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

User.accessTokens.destroyById(parameters, successCb, errorCb)

Delete a related item by id for accessTokens.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - User id
options – {object=} -
fk – {*} - Foreign key for accessTokens
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

This method returns no data.

User.accessTokens.findById(parameters, successCb, errorCb)

Find a related item by id for accessTokens.

Arguments

Name Type Description

parameters

Object

Request parameters.

id – {*} - User id
options – {object=} -
fk – {*} - Foreign key for accessTokens
options – {object=} -

successCb

function(Object, Object)

Success callback with two arguments: value, responseHeaders.

errorCb

function(Object)

Error callback with one argument: httpResponse.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

User.accessTokens.updateById(parameters, postData, successCb, errorCb)

Update a related item by id for accessTokens.

Arguments

Name	Type	Description
parameters	`Object`	Request parameters. `id` – `{}` - User id `fk` – `{}` - Foreign key for accessTokens
postData	`Object`	Request data. `options` – `{object=}` - `data` – `{object=}` - `options` – `{object=}` -
successCb	`function(Object, Object)`	Success callback with two arguments: `value`, `responseHeaders`.
errorCb	`function(Object)`	Error callback with one argument: `httpResponse`.

Returns

Name Type Description

result

Object

An empty reference that will be populated with the actual data once the response is returned from the server.

(The remote method definition does not provide any description. This usually means the response is a AccessToken object.)

Generator API

generateServices

Angular Client API

Class: AccessToken

Class: AccessToken Static Methods

AccessToken.count(parameters, successCb, errorCb)

AccessToken.create(parameters, postData, successCb, errorCb)

AccessToken.createChangeStream(parameters, postData, successCb, errorCb)

AccessToken.createMany(parameters, postData, successCb, errorCb)

AccessToken.deleteById(parameters, successCb, errorCb)

AccessToken.destroyById(parameters, successCb, errorCb)

AccessToken.exists(parameters, successCb, errorCb)

AccessToken.find(parameters, successCb, errorCb)

AccessToken.findById(parameters, successCb, errorCb)

AccessToken.findOne(parameters, successCb, errorCb)

AccessToken.patchOrCreate(parameters, successCb, errorCb)

AccessToken.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

AccessToken.prototype$patchAttributes(parameters, successCb, errorCb)

AccessToken.prototype$updateAttributes(parameters, successCb, errorCb)

AccessToken.removeById(parameters, successCb, errorCb)

AccessToken.replaceById(parameters, postData, successCb, errorCb)

AccessToken.replaceOrCreate(parameters, postData, successCb, errorCb)

AccessToken.update(parameters, postData, successCb, errorCb)

AccessToken.updateAll(parameters, postData, successCb, errorCb)

AccessToken.updateOrCreate(parameters, successCb, errorCb)

AccessToken.upsert(parameters, successCb, errorCb)

AccessToken.upsertWithWhere(parameters, postData, successCb, errorCb)

AccessToken.user(parameters, successCb, errorCb)

Class: ACL

Class: ACL Static Methods

ACL.count(parameters, successCb, errorCb)

ACL.create(parameters, postData, successCb, errorCb)

ACL.createChangeStream(parameters, postData, successCb, errorCb)

ACL.createMany(parameters, postData, successCb, errorCb)

ACL.deleteById(parameters, successCb, errorCb)

ACL.destroyById(parameters, successCb, errorCb)

ACL.exists(parameters, successCb, errorCb)

ACL.find(parameters, successCb, errorCb)

ACL.findById(parameters, successCb, errorCb)

ACL.findOne(parameters, successCb, errorCb)

ACL.patchOrCreate(parameters, successCb, errorCb)

ACL.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

ACL.prototype$patchAttributes(parameters, successCb, errorCb)

ACL.prototype$updateAttributes(parameters, successCb, errorCb)

ACL.removeById(parameters, successCb, errorCb)

ACL.replaceById(parameters, postData, successCb, errorCb)

ACL.replaceOrCreate(parameters, postData, successCb, errorCb)

ACL.update(parameters, postData, successCb, errorCb)

ACL.updateAll(parameters, postData, successCb, errorCb)

ACL.updateOrCreate(parameters, successCb, errorCb)

ACL.upsert(parameters, successCb, errorCb)

ACL.upsertWithWhere(parameters, postData, successCb, errorCb)

Class: Application

Class: Application Static Methods

Application.count(parameters, successCb, errorCb)

Application.create(parameters, postData, successCb, errorCb)

Application.createChangeStream(parameters, postData, successCb, errorCb)

Application.createMany(parameters, postData, successCb, errorCb)

Application.deleteById(parameters, successCb, errorCb)

Application.destroyById(parameters, successCb, errorCb)

Application.exists(parameters, successCb, errorCb)

Application.find(parameters, successCb, errorCb)

Application.findById(parameters, successCb, errorCb)

Application.findOne(parameters, successCb, errorCb)

Application.patchOrCreate(parameters, successCb, errorCb)

Application.patchOrCreateWithWhere(parameters, postData, successCb, errorCb)

Application.prototype$patchAttributes(parameters, successCb, errorCb)

Application.prototype$updateAttributes(parameters, successCb, errorCb)

Application.removeById(parameters, successCb, errorCb)

Application.replaceById(parameters, postData, successCb, errorCb)

Application.replaceOrCreate(parameters, postData, successCb, errorCb)

Application.update(parameters, postData, successCb, errorCb)

Application.updateAll(parameters, postData, successCb, errorCb)

Application.updateOrCreate(parameters, successCb, errorCb)

Application.upsert(parameters, successCb, errorCb)

Application.upsertWithWhere(parameters, postData, successCb, errorCb)

Class: Change

Class: Change Static Methods

Change.count(parameters, successCb, errorCb)

Change.create(parameters, postData, successCb, errorCb)