Difference between revisions of "Bot Playground/Commands/setGroupRole"
From SmartBots Developers Docs
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:{{SUBPAGENAME}}}} | {{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"> | <syntaxhighlight lang="javascript"> | ||
Revision as of 20:55, 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);
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 | |