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

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"); }
  });

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

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

Check the complex example for function usage.

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:{{SUBPAGENAME}}}}
-<onlyinclude>Revokes a specific role from a group member.</onlyinclude>
+<onlyinclude>Removes a group member from a specific role.</onlyinclude> Also see a [[Bot Playground/Commands/setGroupRole|setGroupRole]] function.
 <syntaxhighlight lang="javascript">
@@ Line 21: / Line 21: @@
 {{API Variables Table End}}
+== Comments ==
+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}}
 __NOTOC__