setGroupRole

From SmartBots Developers Docs
Jump to: navigation, search

Puts member of a group in a specific role. Also see a revokeGroupRole function.

Bot.setGroupRole(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 moved to the specific role
group_uuid yes The UUID of the group
role_uuid yes The UUID of the group role. "Everyone" role is 00000000-0000-0000-0000-000000000000
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.