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

Latest revision as of 21:12, 31 October 2016

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

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

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>Puts member of a group in a specific role.</onlyinclude>
+<onlyinclude>Puts member of a group in a specific role.</onlyinclude> Also see a [[Bot Playground/Commands/revokeGroupRole|revokeGroupRole]] function.
 <syntaxhighlight lang="javascript">
-Bot.setGroupRole(location);
+Bot.setGroupRole(avatar_uuid, group_uuid, role_uuid)
+  .then(function(result) {
+    if(result.success) { console.log("Role revoked"); }
+  });
 </syntaxhighlight>
@@ Line 10: / Line 13: @@
 {{API Variable Group|Input}}
-{{API Variable|groupuuid|yes}} The UUID of the group
+{{API Variable|avatar_uuid|yes}} The UUID of the avatar which should be moved to the specific role
-{{API Variable|roleuuid|yes}} The UUID of the group role. "Everyone" role is 00000000-0000-0000-0000-000000000000
+{{API Variable|group_uuid|yes}} The UUID of the group
-{{API Variable|member|yes}} The UUID of the avatar which should be moved to the specific role
+{{API Variable|role_uuid|yes}} The UUID of the group role. "Everyone" role is 00000000-0000-0000-0000-000000000000
 {{API Variable Group|Output}}
@@ Line 18: / 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__