Interface ParticipantsModalParameters

Interface defining the parameters for the ParticipantsModal component.

ParticipantsModalParameters

Display Settings:

interface ParticipantsModalParameters {
    position?:
        | "center"
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    backgroundColor?: string;
    coHostResponsibility: CoHostResponsibility[];
    coHost: string;
    member: string;
    islevel: string;
    participants: Participant[];
    eventType: EventType;
    filteredParticipants: Participant[];
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    showAlert?: ShowAlert;
    roomName: string;
    updateIsMessagesModalVisible: ((isVisible: boolean) => void);
    updateDirectMessageDetails: ((participant: Participant) => void);
    updateStartDirectMessage: ((start: boolean) => void);
    updateParticipants: ((participants: Participant[]) => void);
    getUpdatedAllParams: (() => ParticipantsModalParameters);
    [key: string]: any;
}

Indexable

  • [key: string]: any

Properties

position? backgroundColor? coHostResponsibility coHost member islevel participants eventType filteredParticipants socket showAlert? roomName updateIsMessagesModalVisible updateDirectMessageDetails updateStartDirectMessage updateParticipants getUpdatedAllParams

Properties

Optionalposition

position?:
    | "center"
    | "topLeft"
    | "topRight"
    | "bottomLeft"
    | "bottomRight"

Modal position on screen

OptionalbackgroundColor

backgroundColor?: string

Background color of the modal

Participant Data:

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Co-host permissions and responsibilities

coHost

coHost: string

Co-host user ID

member

member: string

Current user's member ID

islevel

islevel: string

Current user's level/role ('0'=participant, '1'=moderator, '2'=host)

Session Info:

participants

participants: Participant[]

Array of all participants in the session

eventType

eventType: EventType

Type of event ('conference', 'webinar', 'broadcast', etc.)

filteredParticipants

filteredParticipants: Participant[]

Filtered list based on search/filter criteria

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io client for real-time communication

OptionalshowAlert

showAlert?: ShowAlert

Function to display alerts/notifications

State Update Functions:

roomName

roomName: string

Name/ID of the current room

updateIsMessagesModalVisible

updateIsMessagesModalVisible: ((isVisible: boolean) => void)

Toggle messages modal visibility

updateDirectMessageDetails

updateDirectMessageDetails: ((participant: Participant) => void)

Set direct message recipient

updateStartDirectMessage

updateStartDirectMessage: ((start: boolean) => void)

Initiate direct message flow

updateParticipants

updateParticipants: ((participants: Participant[]) => void)

Update participants list

Utility:

getUpdatedAllParams

getUpdatedAllParams: (() => ParticipantsModalParameters)

Get latest parameter state

Settings

Member Visibility

On This Page

Properties