SDK
SDK Javascript v5.x
1

You are currently looking at the documentation of a previous version of Kuzzle. We strongly recommend that you use the latest version. You can also use the version selector in the top menu.

saveRestricted #

Saves this user as restricted in Kuzzle. #

saveRestricted([options], [callback]) #

Arguments Type Description
options JSON Object Optional parameters
callback function (Optional) Callback handling the response

Options #

Option Type Description Default
queuable boolean Make this request queuable or not true

Return Value #

Returns the User object to allow chaining.


Callback Response #

Returns a User object.

Usage #

Copied to clipboard!
// Using callbacks (NodeJS or Web Browser)
user
  .saveRestricted(function(error, result) {
    // result is a User object
  });
// Using promises (NodeJS)
user
  .saveRestrictedPromise()
  .then(result => {
    // result is a User object
  });