MediaSFU React Native
    Preparing search index...

    Interface MessagesModalOptions

    Configuration options for the MessagesModal component.

    MessagesModalOptions

    Modal Control:

    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;
        chatSetting: string;
        style?: StyleProp<ViewStyle>;
        renderContent?: (
            options: {
                defaultContent: Element;
                dimensions: { width: number; height: number };
            },
        ) => Element;
        renderContainer?: (
            options: {
                defaultContainer: Element;
                dimensions: { width: number; height: number };
            },
        ) => Element;
    }
    Index

    Properties

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

    Properties

    isMessagesModalVisible: boolean

    Controls visibility of the chat modal.

    onMessagesClose: () => void

    Invoked when the modal should close.

    Messaging:

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

    Handler triggered when sending a message.

    messages: Message[]

    Collection of messages to render within the panel.

    Appearance:

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

    Preferred anchor position.

    backgroundColor?: string

    Surface color of the modal.

    activeTabBackgroundColor?: string

    Highlight color for the active tab.

    eventType: EventType

    Session type directing permissions and UI.

    member: string

    Display name of the current user.

    islevel: string

    Permission level for the current user.

    coHostResponsibility: CoHostResponsibility[]

    Matrix describing co-host capabilities.

    coHost: string

    Co-host identifier.

    startDirectMessage: boolean

    Flag that determines whether direct message mode is active.

    directMessageDetails: Participant

    Target participant for direct messaging.

    updateStartDirectMessage: (start: boolean) => void

    State setter for direct message mode.

    updateDirectMessageDetails: (participant: Participant) => void

    Setter for direct message context.

    Alerts:

    showAlert?: ShowAlert

    Optional alert callback for user feedback.

    Advanced Render Overrides:

    roomName: string

    Active room identifier.

    socket: Socket

    Socket.io connection for real-time updates.

    chatSetting: string

    Chat configuration toggle (e.g., 'all' | 'hostOnly').

    Direct Messaging:

    style?: StyleProp<ViewStyle>

    Additional styles merged into the modal container.

    Session Context:

    renderContent?: (
        options: {
            defaultContent: Element;
            dimensions: { width: number; height: number };
        },
    ) => Element

    Override for the default chat panel layout.

    renderContainer?: (
        options: {
            defaultContainer: Element;
            dimensions: { width: number; height: number };
        },
    ) => Element

    Override for wrapping the modal with custom UI (e.g., animated containers).

    Settings

    Member Visibility

    On This Page

    Properties