TsgcWSPClient_E2EEMethods › JoinGroup

JoinGroup Method

Joins an existing encrypted group to receive membership and key context.

Syntax

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

Parameters

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

Return Value

True when the server accepted the join and delivered membership and key context within the timeout, False otherwise (Boolean).

Remarks

Joins an existing group. On success the client receives the current member list through OnE2EEGroupJoin and the group key material needed to encrypt and decrypt subsequent messages. If this component created the group, the join is implicit and calling JoinGroup again is not required.

Example

if oE2EE.JoinGroup('TEAM01') then
  oE2EE.SendGroupMessage('TEAM01', 'hello');

Back to Methods