Generate Angular $resource services for the given loopback application.
var generateServices = require('loopback-sdk-angular').services;
var app = require('./server/server');
var client = generateServices(app, 'lbServices', '/api');
require('fs').writeFileSync('client/loopback.js', client, 'utf-8');
Name | Type | Description |
---|---|---|
app |
Object
|
The loopback application created via |
ngModuleName |
string
|
A name for the generated Angular module. Default: |
apiUrl |
string
|
The URL where the client can access the LoopBack server app. Default: |
Name | Type | Description |
---|---|---|
result |
string
|
The generated javascript code. |
A $resource object for interacting with the AccessToken
model.
Example
See $resource for an example of using this object.
Count instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Create a new instance of the model and persist it into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Check whether a model instance exists in the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find all instances of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find first instance of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update attributes for a model instance and persist it into the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Fetches belongsTo relation user
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
A $resource object for interacting with the ACL
model.
Example
See $resource for an example of using this object.
Count instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Create a new instance of the model and persist it into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Check whether a model instance exists in the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find all instances of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find first instance of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update attributes for a model instance and persist it into the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
A $resource object for interacting with the Application
model.
Example
See $resource for an example of using this object.
Count instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Create a new instance of the model and persist it into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Check whether a model instance exists in the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find all instances of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find first instance of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update attributes for a model instance and persist it into the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
A $resource object for interacting with the Change
model.
Example
See $resource for an example of using this object.
Count instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Create a new instance of the model and persist it into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Check whether a model instance exists in the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find all instances of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find first instance of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update attributes for a model instance and persist it into the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
A $resource object for interacting with the Checkpoint
model.
Example
See $resource for an example of using this object.
Count instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Create a new instance of the model and persist it into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Check whether a model instance exists in the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find all instances of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find first instance of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update attributes for a model instance and persist it into the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Name | Type | Description |
---|---|---|
header |
string
|
The header name to use, e.g. |
Name | Type | Description |
---|---|---|
url |
string
|
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
A $resource object for interacting with the Email
model.
Example
See $resource for an example of using this object.
A $resource object for interacting with the Role
model.
Example
See $resource for an example of using this object.
Count instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Create a new instance of the model and persist it into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Check whether a model instance exists in the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find all instances of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find first instance of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update attributes for a model instance and persist it into the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
The object Role.principals
groups methods
manipulating RoleMapping
instances related to Role
.
Call Role.principals() to query all related instances.
Counts principals of Role.
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Creates a new instance in principals of this model.
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Deletes all principals of this model.
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a related item by id for principals
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find a related item by id for principals
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Queries principals of Role.
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update a related item by id for principals
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
A $resource object for interacting with the RoleMapping
model.
Example
See $resource for an example of using this object.
Count instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Create a new instance of the model and persist it into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Check whether a model instance exists in the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find all instances of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find first instance of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update attributes for a model instance and persist it into the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Fetches belongsTo relation role
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
A $resource object for interacting with the Scope
model.
Example
See $resource for an example of using this object.
Count instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Create a new instance of the model and persist it into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Check whether a model instance exists in the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find all instances of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find first instance of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update attributes for a model instance and persist it into the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
A $resource object for interacting with the User
model.
Example
See $resource for an example of using this object.
Confirm a user registration with email verification token
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Count instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Create a new instance of the model and persist it into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Check whether a model instance exists in the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find all instances of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Find first instance of the model matched by filter from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
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.
Name | Type | Description |
---|---|---|
result |
Object
|
A User instance. |
Get data of the currently logged user. Fail with HTTP result 401 when there is no user logged in.
Name | Type | Description |
---|---|---|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
Name | Type | Description |
---|---|---|
result |
Object
|
An empty reference that will be populated with the actual data once the response is returned from the server. |
Name | Type | Description |
---|---|---|
result |
Object
|
Id of the currently logged-in user or null. |
Name | Type | Description |
---|---|---|
result |
boolean
|
True if the current user is authenticated (logged in). |
Login a user with username/email and password
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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
|
Logout a user with access token
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.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update attributes for a model instance and persist it into the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Delete a model instance by id from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Reset password for a user with email
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update instances of the model matched by where from the data source
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update an existing model instance or insert a new one into the data source
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: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
The object User.accessTokens
groups methods
manipulating AccessToken
instances related to User
.
Call User.accessTokens() to query all related instances.
Queries accessTokens of User.
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Array.<Object>, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Counts accessTokens of User.
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Creates a new instance in accessTokens of this model.
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Deletes all accessTokens of this model.
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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. |
Delete a related item by id for accessTokens
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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:
|
Find a related item by id for accessTokens
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |
Update a related item by id for accessTokens
Name | Type | Description |
---|---|---|
parameters |
Object
|
Request parameters.
|
postData |
Object
|
Request data. This method expects a subset of model properties as request parameters. |
successCb |
function(Object, Object)
|
Success callback with two arguments: |
errorCb |
function(Object)
|
Error callback with one argument: |
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.) |