Class useRealtimeStore

constructor

• new useRealtimeStore(): useRealtimeStore

  Returns useRealtimeStore

key

getValue

• getValue(): Promise<string>
  • This method can be used to retrieve the value associated with a given key.

  Returns Promise<string>

  A promise that resolves to the stored value.

  Throws

  Throws an error if the key does not exist or the request fails.

  Example

  import { useRealtimeStore } from "@videosdk.live/react-sdk";
  
  const key = "BLOCKED_STUDENTS";
  
  const { getValue } = useRealtimeStore(key);
  
  async function handleGetValue() {
    try {
      const value = await getValue();
      console.log("Fetched value:", value);
    } catch (error) {
      console.error("Error while getting value:", error);
    }
  }
  
  handleGetValue();
  Copy

setValue

• setValue(value: string): Promise<any>

  • This method can be used to store or update a value in the Realtime Store.

  • If the specified key already exists, its value is overwritten. Passing null as the value deletes the key from the store.

  Parameters

  • value: string

    The value to store. Pass null to delete the key.

  Returns Promise<any>

  Throws

  Throws an error if:

  • The key is missing or invalid.
  • The value is not a string or exceeds the allowed size (1 KB).
  • The request fails.

  Example

  import { useRealtimeStore } from "@videosdk.live/react-sdk";
  
  const key = "BLOCKED_STUDENTS";
  
  const { setValue } = useRealtimeStore(key);
  
  async function handleSetValue() {
    try {
      await setValue("[abcd, efgh]");
      console.log("Value updated successfully");
    } catch (error) {
      console.error("Error while setting value:", error);
    }
  }
  
  handleSetValue();
  Copy

onValueChanged

• onValueChanged(option: { updatedBy: string; value: string }): void
  • Triggered when the value associated with the specified key is updated in the Realtime Store by any participant.

  Parameters

  • option: { updatedBy: string; value: string }

    • updatedBy: string

      Participant ID of the user who updated the value.

    • value: string

      The latest value stored for the key.

  Returns void

  Example

  import { useRealtimeStore } from "@videosdk.live/react-sdk";
  
  const key = "BLOCKED_STUDENTS";
  
  function onValueChanged({ updatedBy, value }) {
    console.log("Value updated by:", updatedBy, "New value:", value);
  }
  
  useRealtimeStore(key, {
    onValueChanged,
  });
  Copy