Script event of MyChat Server: OnConfLeave

Script event of MyChat Server: OnConfLeave

The event when a user exit the conference.

 

Event template

function OnConfLeave(iCID, iUIN, iUID: integer; sConfName: string): boolean;
begin
  // your own code
    
  result := true;  
end;

begin

end.

You can put your code instead of the comment.

Description of parameters

Parameter

Type

Value

iCID

integer

Connection ID of the client, unique session identifier in the online structure of network connections to the server;

iUIN

integer

user's unique identifier (number > 0);

iUID

integer

unique identifier of a conference (number > 0);

sConfName

string

text name of a conference.

 

Return value

Notice! When you start using this event it will overlap the server logic for analysis whether a user can exit the conference or not. Now the script is going to do this. If it returns True — a user can leave the conference, if False — he can't..

 

Example

function OnConfLeave(iCID, iUIN, iUID: integer; sConfName: string): boolean;
var
  bFlag: boolean;
begin
  bFlag := true;
  
    if sConfName = 'main' then 
      if mIsUserIncludedToAutoConf(iUIN, iUID) then bFlag := false;
    
  result := bFlag;  
end;

begin

end.

The conference "main" is created automatically with the prohibition to leave it. Users from specified groups are added to this conference automatically.

 

It is important that users that enter the conference by themselves could exit it.
 

See also

OnConfJoin