Interface PreJoinPageOptions

interface PreJoinPageOptions {
    localLink?: string;
    connectMediaSFU?: boolean;
    parameters: PreJoinPageParameters;
    credentials?: Credentials;
    returnUI?: boolean;
    noUIPreJoinOptions?: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions;
    createMediaSFURoom?: CreateRoomOnMediaSFUType;
    joinMediaSFURoom?: JoinRoomOnMediaSFUType;
    containerProps?: HTMLAttributes<HTMLDivElement>;
    logoContainerProps?: HTMLAttributes<HTMLDivElement>;
    logoImageProps?: ImgHTMLAttributes<HTMLImageElement>;
    inputContainerProps?: HTMLAttributes<HTMLDivElement>;
    orContainerProps?: HTMLAttributes<HTMLDivElement>;
    orTextProps?: HTMLAttributes<HTMLSpanElement>;
    toggleContainerProps?: HTMLAttributes<HTMLDivElement>;
    toggleButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    createButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    joinButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>;
    createNameInputProps?: InputHTMLAttributes<HTMLInputElement>;
    durationInputProps?: InputHTMLAttributes<HTMLInputElement>;
    capacityInputProps?: InputHTMLAttributes<HTMLInputElement>;
    eventTypeSelectProps?: SelectHTMLAttributes<HTMLSelectElement>;
    joinNameInputProps?: InputHTMLAttributes<HTMLInputElement>;
    eventIdInputProps?: InputHTMLAttributes<HTMLInputElement>;
    errorProps?: HTMLAttributes<HTMLParagraphElement>;
    renderContainer?: ((options: {
        defaultContainer: ReactNode;
        isCreateMode: boolean;
        error: string;
    }) => ReactNode);
    renderLogo?: ((options: {
        defaultLogo: ReactNode;
    }) => ReactNode);
    renderCreateForm?: ((options: {
        defaultContent: ReactNode;
        values: {
            name: string;
            duration: string;
            eventType: string;
            capacity: string;
        };
        submit: (() => Promise<void>);
        setValues: {
            onNameChange: ChangeEventHandler<HTMLInputElement>;
            onDurationChange: ChangeEventHandler<HTMLInputElement>;
            onEventTypeChange: ChangeEventHandler<HTMLSelectElement>;
            onCapacityChange: ChangeEventHandler<HTMLInputElement>;
        };
    }) => ReactNode);
    renderJoinForm?: ((options: {
        defaultContent: ReactNode;
        values: {
            name: string;
            eventID: string;
        };
        submit: (() => Promise<void>);
        setValues: {
            onNameChange: ChangeEventHandler<HTMLInputElement>;
            onEventIDChange: ChangeEventHandler<HTMLInputElement>;
        };
    }) => ReactNode);
    renderToggle?: ((options: {
        defaultToggle: ReactNode;
        isCreateMode: boolean;
        toggle: (() => void);
    }) => ReactNode);
    renderError?: ((options: {
        defaultError: ReactNode;
        error: string;
    }) => ReactNode);
    renderContent?: ((options: {
        defaultContent: ReactNode;
        isCreateMode: boolean;
        error: string;
    }) => ReactNode);
}

Properties

localLink? connectMediaSFU? parameters credentials? returnUI? noUIPreJoinOptions? createMediaSFURoom? joinMediaSFURoom? containerProps? logoContainerProps? logoImageProps? inputContainerProps? orContainerProps? orTextProps? toggleContainerProps? toggleButtonProps? createButtonProps? joinButtonProps? createNameInputProps? durationInputProps? capacityInputProps? eventTypeSelectProps? joinNameInputProps? eventIdInputProps? errorProps? renderContainer? renderLogo? renderCreateForm? renderJoinForm? renderToggle? renderError? renderContent?

Properties

OptionallocalLink

localLink?: string

OptionalconnectMediaSFU

connectMediaSFU?: boolean

parameters

parameters: PreJoinPageParameters

Optionalcredentials

credentials?: Credentials

OptionalreturnUI

returnUI?: boolean

OptionalnoUIPreJoinOptions

noUIPreJoinOptions?: CreateMediaSFURoomOptions | JoinMediaSFURoomOptions

OptionalcreateMediaSFURoom

createMediaSFURoom?: CreateRoomOnMediaSFUType

OptionaljoinMediaSFURoom

joinMediaSFURoom?: JoinRoomOnMediaSFUType

OptionalcontainerProps

containerProps?: HTMLAttributes<HTMLDivElement>

OptionallogoContainerProps

logoContainerProps?: HTMLAttributes<HTMLDivElement>

OptionallogoImageProps

logoImageProps?: ImgHTMLAttributes<HTMLImageElement>

OptionalinputContainerProps

inputContainerProps?: HTMLAttributes<HTMLDivElement>

OptionalorContainerProps

orContainerProps?: HTMLAttributes<HTMLDivElement>

OptionalorTextProps

orTextProps?: HTMLAttributes<HTMLSpanElement>

OptionaltoggleContainerProps

toggleContainerProps?: HTMLAttributes<HTMLDivElement>

OptionaltoggleButtonProps

toggleButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalcreateButtonProps

createButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionaljoinButtonProps

joinButtonProps?: ButtonHTMLAttributes<HTMLButtonElement>

OptionalcreateNameInputProps

createNameInputProps?: InputHTMLAttributes<HTMLInputElement>

OptionaldurationInputProps

durationInputProps?: InputHTMLAttributes<HTMLInputElement>

OptionalcapacityInputProps

capacityInputProps?: InputHTMLAttributes<HTMLInputElement>

OptionaleventTypeSelectProps

eventTypeSelectProps?: SelectHTMLAttributes<HTMLSelectElement>

OptionaljoinNameInputProps

joinNameInputProps?: InputHTMLAttributes<HTMLInputElement>

OptionaleventIdInputProps

eventIdInputProps?: InputHTMLAttributes<HTMLInputElement>

OptionalerrorProps

errorProps?: HTMLAttributes<HTMLParagraphElement>

OptionalrenderContainer

renderContainer?: ((options: {
    defaultContainer: ReactNode;
    isCreateMode: boolean;
    error: string;
}) => ReactNode)

OptionalrenderLogo

renderLogo?: ((options: {
    defaultLogo: ReactNode;
}) => ReactNode)

OptionalrenderCreateForm

renderCreateForm?: ((options: {
    defaultContent: ReactNode;
    values: {
        name: string;
        duration: string;
        eventType: string;
        capacity: string;
    };
    submit: (() => Promise<void>);
    setValues: {
        onNameChange: ChangeEventHandler<HTMLInputElement>;
        onDurationChange: ChangeEventHandler<HTMLInputElement>;
        onEventTypeChange: ChangeEventHandler<HTMLSelectElement>;
        onCapacityChange: ChangeEventHandler<HTMLInputElement>;
    };
}) => ReactNode)

OptionalrenderJoinForm

renderJoinForm?: ((options: {
    defaultContent: ReactNode;
    values: {
        name: string;
        eventID: string;
    };
    submit: (() => Promise<void>);
    setValues: {
        onNameChange: ChangeEventHandler<HTMLInputElement>;
        onEventIDChange: ChangeEventHandler<HTMLInputElement>;
    };
}) => ReactNode)

OptionalrenderToggle

renderToggle?: ((options: {
    defaultToggle: ReactNode;
    isCreateMode: boolean;
    toggle: (() => void);
}) => ReactNode)

OptionalrenderError

renderError?: ((options: {
    defaultError: ReactNode;
    error: string;
}) => ReactNode)

OptionalrenderContent

renderContent?: ((options: {
    defaultContent: ReactNode;
    isCreateMode: boolean;
    error: string;
}) => ReactNode)

Settings

Member Visibility

On This Page

Properties