SDK
SDK PHP v3.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.

delete #

Deletes the role from Kuzzle.


delete([options], [callback]) #

ArgumentsTypeDescription
optionsJSON ObjectOptional parameters
callbackfunction(Optional) Callback handling the response

Options #

OptionTypeDescriptionDefault
queuablebooleanMake this request queuable or nottrue

Callback Response #

Returns the ID of the deleted role.

Usage #

<?php
use Kuzzle\Security\Role;
// ...
/*
  * @var $role Role
  */
try {
  $role->delete();
}
catch(ErrorException $e) {
  // error occurred
}