Multiuser Lingo Dictionary > Multiuser Lingo Dictionary > leave |  |

leave

Syntax

    system.group.leave ["@groupName"]

Description

Multiuser Server command; removes the current user from the given group. If the user is not a member of the group, the server returns an error message.

Calling `leave` for the default group @AllUsers returns an error message.

The server responds with a message for each group that is left, matching the subject of the request message and containing the name of the group successfully left.

Example

This statement removes the sender from the group @RedTeam:

    errCode = gMultiuserInstance.sendNetMessage("system.group.leave", "anySubject", "@RedTeam")

The server's response looks like this:

    [#errorCode: 0, #recipients: ["userName"], #senderID: "system.group.leave", #subject: "anySubject", #content: "@RedTeam", #timeStamp: 762551131]

See also

`sendNetMessage()`