Difference between revisions of "Bot Playground/Commands/revokeGroupRole"

From SmartBots Developers Docs
Jump to: navigation, search
 
Line 25: Line 25:
  
 
Make sure your bot has sufficient rights to assign/revoke members from group roles.
 
Make sure your bot has sufficient rights to assign/revoke members from group roles.
 +
 +
Check the [[Bot_Playground/Setting_and_revoking_group_roles|complex example]] for function usage.
  
 
{{NavMenu}}
 
{{NavMenu}}
 
__NOTOC__
 
__NOTOC__

Latest revision as of 21:11, 31 October 2016

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.