Hiyve Components - v1.0.0
    Preparing search index...

    Interface UseJoinTokenOptions

    Options for the useJoinToken hook.

    interface UseJoinTokenOptions {
        autoValidate?: boolean;
        onError?: (error: JoinTokenError) => void;
        onJoined?: () => void;
        onValidated?: (roomName: string, isActive: boolean) => void;
        password?: string;
    }
    Index

    Properties

    autoValidate? onError? onJoined? onValidated? password?

    Properties

    autoValidate?: boolean

    Automatically validate the token on mount

    onError?: (error: JoinTokenError) => void

    Callback when an error occurs

    onJoined?: () => void

    Callback when room is successfully joined

    onValidated?: (roomName: string, isActive: boolean) => void

    Callback when token is successfully validated

    password?: string

    Password for a password-protected token, when the consumer already knows it (e.g. a post-join stage that re-validates after the user entered it on a join form). Used by auto-validation and the room-active poll; an explicit validateToken(password) / joinRoom(userId, password) argument takes precedence.

    Settings

    Member Visibility

    On This Page

    Properties