Interface MessagesModalOptions

Interface defining the props for the MessagesModal component.

interface MessagesModalOptions {
    isMessagesModalVisible: boolean;
    onMessagesClose: (() => void);
    onSendMessagePress?: ((options: SendMessageOptions) => Promise<void>);
    messages: Message[];
    position?:
        | "topLeft"
        | "topRight"
        | "bottomLeft"
        | "bottomRight";
    backgroundColor?: string;
    activeTabBackgroundColor?: string;
    eventType: EventType;
    member: string;
    islevel: string;
    coHostResponsibility: CoHostResponsibility[];
    coHost: string;
    startDirectMessage: boolean;
    directMessageDetails: Participant;
    updateStartDirectMessage: ((start: boolean) => void);
    updateDirectMessageDetails: ((participant: Participant) => void);
    showAlert?: ShowAlert;
    roomName: string;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    chatSetting: string;
}

Properties

isMessagesModalVisible onMessagesClose onSendMessagePress? messages position? backgroundColor? activeTabBackgroundColor? eventType member islevel coHostResponsibility coHost startDirectMessage directMessageDetails updateStartDirectMessage updateDirectMessageDetails showAlert? roomName socket chatSetting

Properties

isMessagesModalVisible

isMessagesModalVisible: boolean

Determines if the messages modal is visible.

onMessagesClose

onMessagesClose: (() => void)

Function to close the messages modal.

OptionalonSendMessagePress

onSendMessagePress?: ((options: SendMessageOptions) => Promise<void>)

Function to handle sending messages. Defaults to the imported sendMessage function.

messages

messages: Message[]

Array of message objects to display.

Optionalposition

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

Position of the modal on the screen. Possible values: 'topRight', 'topLeft', 'bottomRight', 'bottomLeft'.

Default

'topRight'

OptionalbackgroundColor

backgroundColor?: string

Background color of the modal.

Default

'#f5f5f5'

OptionalactiveTabBackgroundColor

activeTabBackgroundColor?: string

Background color of the active tab.

Default

'#7AD2DCFF',

eventType

eventType: EventType

Type of the event (e.g., webinar, conference, broadcast, chat).

member

member: string

Current member's username.

islevel

islevel: string

Level of the user.

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Array of co-host responsibilities.

coHost

coHost: string

Co-host's username.

startDirectMessage

startDirectMessage: boolean

Flag to start a direct message.

directMessageDetails

directMessageDetails: Participant

Details of the direct message.

updateStartDirectMessage

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

Function to update the start direct message flag.

updateDirectMessageDetails

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

Function to update direct message details.

OptionalshowAlert

showAlert?: ShowAlert

Function to show alerts.

roomName

roomName: string

Name of the chat room.

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket object for real-time communication.

chatSetting

chatSetting: string

Settings for the chat.

Settings

Member Visibility

On This Page

Properties