TsgcWSPClient_E2EEMethods › LeaveGroup

LeaveGroup Method

Leaves a group the local user is currently a member of.

Syntax

function LeaveGroup(const aGroup: string; aTimeout: Integer = 10000): Boolean;

Parameters

NameTypeDescription
aGroupconst stringName of the group the local user wants to leave.
aTimeoutIntegerMaximum time in milliseconds to wait for the server acknowledgment (default 10000).

Return Value

True when the server confirmed the membership change within the timeout, False otherwise (Boolean).

Remarks

Removes the local user from the specified group. After a successful leave the client no longer receives group messages and the remaining members are notified through OnE2EEGroupMemberLeave, while the local side fires OnE2EEGroupLeave. The group itself is not deleted; use DeleteGroup for that.

Example

oE2EE.LeaveGroup('TEAM01');

Back to Methods