mediasfu-angular/dist/lib/producers/socket-receive-methods/participant-requested.service.d.ts

mediasfu-angular - Angular 17/18/19 WebRTC SDK for video conferencing, webinars, broadcasts, live streaming, chat, recording, whiteboard, and AI agents. Prebuilt rooms and fully custom UIs.

import { Request, WaitingRoomParticipant } from '../../@types/types';
import * as i0 from "@angular/core";
export interface ParticipantRequestedOptions {
    userRequest: Request;
    requestList: Request[];
    waitingRoomList: WaitingRoomParticipant[];
    updateTotalReqWait: (count: number) => void;
    updateRequestList: (list: Request[]) => void;
}
export type ParticipantRequestedType = (options: ParticipantRequestedOptions) => Promise<void>;
/**
 * Service to handle participant requests in an event's waiting room.
 *
 * @class
 * @name ParticipantRequested
 * @description
 * Manages participant requests by adding new requests to the list and updating the total count of requests and waiting room participants.
 *
 * @method
 * participantRequested
 *
 * @param {ParticipantRequestedOptions} options - Contains request information and update functions:
 *   - `userRequest` {Request}: The new request from a participant.
 *   - `requestList` {Request[]}: The current list of requests.
 *   - `waitingRoomList` {WaitingRoomParticipant[]}: The list of participants in the waiting room.
 *   - `updateTotalReqWait` {Function}: Function to update the total count of requests and waiting room participants.
 *   - `updateRequestList` {Function}: Function to update the request list.
 *
 * @returns {Promise<void>} Updates the request list and total request count.
 *
 * @example
 * const options = {
 *   userRequest: { id: '123', name: 'John Doe', icon: 'fa-user', username: 'johndoe' },
 *   requestList: existingRequests,
 *   waitingRoomList: waitingParticipants,
 *   updateTotalReqWait: (count) => console.log(`Total requests: ${count}`),
 *   updateRequestList: (list) => console.log('Updated request list', list)
 * };
 * await participantRequestedService.participantRequested(options);
 * // Adds "John Doe" to request list and updates the total count.
 */
export declare class ParticipantRequested {
    /**
     * Handles a participant's request by adding it to the request list and updating the total count of requests and waiting room participants.
     *
     * @param {ParticipantRequestedOptions} options - The options for handling the participant's request.
     * @param {UserRequest} options.userRequest - The user request to be added to the request list.
     * @param {UserRequest[]} options.requestList - The current list of user requests.
     * @param {UserRequest[]} options.waitingRoomList - The current list of participants in the waiting room.
     * @param {Function} options.updateTotalReqWait - Function to update the total count of requests and waiting room participants.
     * @param {Function} options.updateRequestList - Function to update the request list.
     * @returns {Promise<void>} A promise that resolves when the participant's request has been handled.
     */
    participantRequested: ({ userRequest, requestList, waitingRoomList, updateTotalReqWait, updateRequestList, }: ParticipantRequestedOptions) => Promise<void>;
    static ɵfac: i0.ɵɵFactoryDeclaration<ParticipantRequested, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<ParticipantRequested>;
}