Batch Eject Group Members

22 October 2016

Release 9.140 - added the optional parameter demote.

21 May 2016

Release 9.78 - added optional parameter target.

21 August 2015

Release 8.47 - added.

batcheject (Commands)
Type	Corrade progressive command
Command	`batcheject`
Description	The `batcheject` command can be used to eject avatars en-bloc out of a group.
Permissions	`group`
Parameters	`group`, `password`, `avatars`
Last Changes	Release 9.78 - added optional parameter `target`.

The batcheject command can be used to eject avatars en-bloc out of a group. Compared to the single operation eject, batcheject is much faster when ejecting a larger number of avatars and the command can be used, for example, to perform group member transfers.

Command Required Parameters Required Corrade Permissions Required Group Abilities Example

batcheject

group, password, avatars

group

* Membership→Eject Members from this Group
* Roles→Remove Members from Roles

llInstantMessage(CORRADE,
    wasKeyValueEncode(
        [
            "command", "batcheject",
            "group", wasURLEscape(GROUP),
            "password", wasURLEscape(PASSWORD),
            "avatars", wasURLEscape(
                wasListToCSV(
                    [
                        "Philip Linden",
                        // eject by UUID
                        "ff19c6b5-4824-4de3-995a-d739d588cf18",
                        "Ectogram Resident"
                    ]
                )
            ),
            "callback", wasURLEscape(URL)
        ]
    )
);

The command will return a list of avatars that could not be ejected from the the group.

Optional Parameters	Possible Value	Description
`target`	A group name or UUID.	The group to act upon. If this parameter is omitted, then the command acts upon the configured group passed to the `group` parameter.
`demote`	`True` or `False`	In case `demote` is set to `False` then Corrade will fail to eject the avatar in case the avatar is part of any other role other than the `Everyone` role.