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

    Interface UseJoinTokenActions

    interface UseJoinTokenActions {
        clearError: () => void;
        joinRoom: (
            userId: string,
            password?: string,
            options?: JoinRoomOptions,
        ) => Promise<void>;
        reset: () => void;
        validateToken: (password?: string) => Promise<JoinTokenValidationOutcome>;
    }
    Index

    Properties

    clearError joinRoom reset validateToken

    Properties

    clearError: () => void

    Clear the current error.

    joinRoom: (
        userId: string,
        password?: string,
        options?: JoinRoomOptions,
    ) => Promise<void>

    Join the room using the validated token.

    reset: () => void

    Reset all state to initial values.

    validateToken: (password?: string) => Promise<JoinTokenValidationOutcome>

    Validate the token and get room info. Pass password if required.

    Settings

    Member Visibility

    On This Page

    Properties