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

    Function useStoredRooms

    • Access stored rooms state and CRUD actions.

      Returns {
          addStoredRoom: (
              options: CreateStoredRoomOptions,
              userId: string,
          ) => Promise<StoredRoom | null>;
          clearError: () => void;
          clearStoredRooms: () => void;
          deleteStoredRoom: (roomName: string, userId: string) => Promise<boolean>;
          error: string | null;
          fetchStoredRooms: (
              userId: string,
              options?: { consumerOnly?: boolean; offlineOnly?: boolean },
          ) => Promise<StoredRoom[]>;
          getStoredRoom: (
              roomName: string,
              userId: string,
          ) => Promise<StoredRoom | null>;
          isLoading: boolean;
          lastFetchedAt: number | null;
          rooms: StoredRoom[];
          updateStoredRoom: (
              roomName: string,
              updates: StoredRoomUpdates,
              userId: string,
          ) => Promise<boolean>;
      }

      Object containing stored rooms state and management actions

      Stored rooms are persistent rooms that can be created, listed, edited, and deleted before a room session is active (dashboard/lobby context).