TsgcWSPClient_E2EEMethods › DeleteGroup

DeleteGroup Method

Deletes an existing encrypted group.

Syntax

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

Parameters

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

Return Value

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

Remarks

Requests the server to remove the specified group. Only the group owner is allowed to delete it; other members should call LeaveGroup instead. After success the server fires OnE2EEGroupDeleted on every client that was part of the group.

Example

if oE2EE.DeleteGroup('TEAM01') then
  ShowMessage('group removed');

Back to Methods