MediaSFU Angular
    Preparing search index...

    Class ConfirmExit

    Confirms the exit of a member from a room and optionally bans them.

    This method emits a socket event to disconnect the specified member from the given room. If the ban option is set to true, the member will be banned from rejoining the room.

    The options for confirming the exit.

    The socket instance to emit the event.

    The local socket instance to emit the event.

    The member who is exiting.

    The name of the room the member is exiting from.

    Whether to ban the member from the room.

    A promise that resolves when the exit is confirmed.

    const confirmExitService = new ConfirmExit();
    await confirmExitService.confirmExit({
      socket: socketInstance,
      localSocket: localSocketInstance,
      member: 'JohnDoe',
      roomName: 'Room1',
      ban: true, // Optional: set to true if you want to ban the member
    });
    Index

    Constructors

    constructor

    Methods

    confirmExit

    Constructors

    Methods

    • Confirms the exit of a member from a room and optionally bans them.

      Parameters

      • options: ConfirmExitOptions

        The options for confirming the exit.

        • socket: Socket
        • OptionallocalSocket?: Socket<DefaultEventsMap, DefaultEventsMap>
        • member: string
        • roomName: string
        • Optionalban?: boolean

      Returns Promise<void>

      A promise that resolves when the exit is confirmed.

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods