Invite an Avatar

21 August 2016

  • Release 9.118 - added the optional soft parameter to soft-unban an avatar before sending the invite; the command now uses the target group, if specified, instead of the command-group.

29 June 2016

  • Release 9.96 - Corrade now checks for permission to manage the group ban list before inviting someone that has been banned.

20 June 2016

  • Release 9.94 - removed the force parameter in favour of the verify parameter - commands should set verify to True if they want Corrade to check that the avatar is not inside the group to invite before inviting.

19 June 2016

  • Release 9.93 - added the optional force parameter.

21 May 2016

  • Release 9.78 - added optional parameter target.

21 December 2014

  • Release 7.34 - added group Corrade permissions.
invite (Commands)
TypeCorrade progressive command
Commandinvite
DescriptionThe invite command can be used to invite an agent to a group and optionally to set them to a certain provided role.
Permissionsgroup
Parametersgroup, password, firstname, lastname (or agent by UUID)
Last ChangesRelease 9.118 - added the optional soft parameter to soft-unban an avatar before sending the invite; the command now uses the target group, if specified, instead of the command-group.

The invite command can be used to invite an agent to a group and optionally to set them to a certain provided role. Note that the default behaviour for this command is to invite the avatar to the group regardless if they already are in the group or have been banned (Second Life behaviour). In order to check that the agent is not already in the group you need to the verify parameter as True along with the command.

Command Required Parameters Required Corrade Permissions Required Group Abilities Example
invite group, password, firstname, lastname (or agent by UUID) 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", "invite",
            "group", wasURLEscape(GROUP),
            "password", wasURLEscape(PASSWORD),
            // or "agent", "69ce412b-dffc-436d-86ff-d788bfa66d9d"
            "firstname", "Corrade",
            "lastname", "Resident",
            // Soft-unban the agent before inviting.
            "soft", "True"
        ]
    )
);
Optional Parameters Examples
role
llInstantMessage(CORRADE,
    wasKeyValueEncode(
        [
            "command", "invite",
            "group", wasURLEscape(GROUP),
            "password", wasURLEscape(PASSWORD),
            // or "agent", "69ce412b-dffc-436d-86ff-d788bfa66d9d"
            "firstname", "Corrade",
            "lastname", "Resident",
            "role", "Officers"
        ]
    )
);
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.
verify True or False. If the verify parameter is set to True, then Corrade will check whether the avatar is already in the group and will not send an invite if they are.
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.

secondlife/scripted_agents/corrade/api/progressive/commands/invite.txt ยท Last modified: 2017/02/22 18:29 (external edit)

Access website using Tor


For the copyright, license, warranty and privacy terms for the usage of this website please see the license and privacy pages.