Skip to main content

IAudienceEvents Interface

Interface describing Audience events

Signature​

export interface IAudienceEvents extends IEvent

Extends: IEvent

Call Signatures​

CallSignature Description
(event: "addMember", listener: (clientId: string, client: IClient) => void): void Raised when a new user joins collaborative session.
(event: "removeMember", listener: (clientId: string, client: IClient) => void): void Raised when a user leaves collaborative session.
(event: "selfChanged", listener: (oldValue: ISelf | undefined, newValue: ISelf) => void): void Notifies that client established new connection and caught-up on ops.

Call Signature Details​

(event: "addMember", listener: (clientId: string, client: IClient) => void): void​

Raised when a new user joins collaborative session.

Signature​

(event: "addMember", listener: (clientId: string, client: IClient) => void): void;

(event: "removeMember", listener: (clientId: string, client: IClient) => void): void​

Raised when a user leaves collaborative session.

Signature​

(event: "removeMember", listener: (clientId: string, client: IClient) => void): void;

(event: "selfChanged", listener: (oldValue: ISelf | undefined, newValue: ISelf) => void): void​

Notifies that client established new connection and caught-up on ops.

Signature​

(event: "selfChanged", listener: (oldValue: ISelf | undefined, newValue: ISelf) => void): void;