Ban Group Members

21 August 2016

Release 9.117 - added optional parameter soft.

21 May 2016

Release 9.78 - added optional parameter target.

29 August 2015

Release 8.50 - added.

ban (Commands)
Type	Corrade progressive command
Command	`ban`
Description	The `ban` command can be used to ban, unban and query the ban list for a given group.
Permissions	`group`
Parameters	`group`, `password`, `avatars`
Last Changes	Release 9.117 - added optional parameter `soft`.

The ban command can be used to ban, unban and query the ban list for a given group. Note that in Second Life terminology, "banning" means to revoke the permissions from an avatar to join a group and that does not mean that the avatar will be ejected. However, the ban command can optionally take a parameter eject, which, when set to True will also eject the avatars to be banned. In other words, you are able to ban an avatar to join a group, even if that avatar is already in the group, in which case, unless the avatar leaves the group, it will still be able to interact with other group members.

Command Required Parameters Required Corrade Permissions Required Group Abilities Example

ban

group, password, avatars

group

* Membership→Manage ban list
* If the eject parameter is set to True: * Membership→Eject Members from this Group
* Roles→Remove Members from Roles

llInstantMessage(CORRADE,
    wasKeyValueEncode(
        [
            "command", "ban",
            "group", wasURLEscape(GROUP),
            "password", wasURLEscape(PASSWORD),
            // ban some avatars
            "action", "ban",
            "avatars", wasURLEscape(
                wasListToCSV(
                    [
                        "Philip Linden",
                        // ban by UUID
                        "ff19c6b5-4824-4de3-995a-d739d588cf18"
                    ]
                )
            ),
            // and also eject them if they are in the group
            "eject", "True",
            "callback", wasURLEscape(URL)
        ]
    )
);

Parameter	Possible Value	Optional Parameter	Possible Value	Description
`action`	`ban`	`eject`	`True` or `False`	Ban an avatar from a group as well as optionally ejecting them in case `eject` is set to `True`
	`unban`			Unban an avatar from the group.
	`list`			Return a CSV list of avatar names, by UUIDs, by the time they were banned from the group.

Optional Parameter	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.
`soft`	`True` or `False`	In case the parameter is set to `True`, then the ban is also either added or removed from Corrade's softban list.

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