Batch Invite Avatars

21 August 2016

Release 9.118 - the command now checks for Membership→Manage ban list group permission in order to invite agents that have been banned; the soft parameter has been added in order to soft-unban any soft-banned agents before inviting them.

21 May 2016

Release 9.78 - added optional parameter target.

21 August 2015

Release 8.44 - added.

batchinvite (Commands)
Type	Corrade progressive command
Command	`batchinvite`
Description	The `batchinvite` command can be used to invite avatars en-bloc to a group.
Permissions	`group`
Parameters	`group`, `password`, `avatars`
Last Changes	Release 9.118 - the command now checks for `Membership→Manage ban list` group permission in order to invite agents that have been banned; the `soft` parameter has been added in order to soft-unban any soft-banned agents before inviting them.

The batchinvite command can be used to invite avatars en-bloc to a group. Compared to the single operation invite, batchinvite is much faster when inviting 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
`batchinvite`	`group`, `password`, `avatars`	`group`	* For inviting to the default `Everyone` role: `Membership→Invite People to this Group` * For inviting to Corrade's role in the group: `Roles→Assign Members to Assigner's Roles` * For inviting to any role in the group: `Roles→Assign Members to Any Role` * For inviting banned agents by unbanning them: `Membership→Manage ban list`	llInstantMessage(CORRADE, wasKeyValueEncode( [ "command", "batchinvite", "group", wasURLEscape(GROUP), "password", wasURLEscape(PASSWORD), // Soft-unban the agents. "soft", "True", "avatars", wasURLEscape( wasListToCSV( [ "Philip Linden", // invite by UUID "ff19c6b5-4824-4de3-995a-d739d588cf18", "Ectogram Resident" ] ) ), "callback", wasURLEscape(URL) ] ) );

The command will return a list of avatars that could not be invited to the group.

Optional Parameters	Possible Value	Description
`role`	A role name or UUID.	Invite to specified role.
`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 an avatar is invited but is also present on the soft-ban list then Corrade will refuse to invite the avatar. By setting `soft` to `True`, Corrade will soft-unban the avatar and then invite.

Notes

Note that in the Linden protocol, role names are not unique, such that a command sending a role name instead of a role UUID would be ambiguous in a context where two roles with the same name exist. In other words, in case you have multiple roles with the same name, it is better to previously issue a getroles command to retrieve a list of roles and their corresponding UUIDs and then issue the command by setting role to an UUID instead of a name.