ejectGroupMember

From SmartBots Developers Docs
Bot PlaygroundCommands
Revision as of 20:50, 2 July 2016 by Phil (Talk | contribs) (Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}}}} <onlyinclude>Ejects residents from the group.</onlyinclude> <syntaxhighlight lang="javascript"> Bot.ejectGroupMember(avatar, groupuuid); </sy...")

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Ejects residents from the group.

Bot.ejectGroupMember(avatar, groupuuid);

Reference

This command accepts the following parameters:

Variable Required Description


Input:
avatar yes The UUID of the resident
groupuuid yes The UUID of the group
Output:
Function returns a Promise with the following data:
success bool true if command completed successfully
error string error string if command has failed

Important

If you are using a custom role (other than "Everyone") you need an additional abilities for your bot. Read this for details.