revokeGroupRole

From SmartBots Developers Docs
Jump to: navigation, search

Removes a group member from a specific role. Also see a setGroupRole function.

Bot.revokeGroupRole(avatar_uuid, group_uuid, role_uuid)
  .then(function(result) {
    if(result.success) { console.log("Role revoked"); }
  });

Reference

This command accepts the following parameters:

Variable Required Description


Input:
avatar_uuid yes The UUID of the avatar which should be removed from the role
group_uuid yes The UUID of the group
role_uuid yes The UUID of the group role.
Output:
Function returns a Promise with the following data:
success bool true if command completed successfully
error string error string if command has failed

Comments

Make sure your bot has sufficient rights to assign/revoke members from group roles.

Check the complex example for function usage.