Class realtimeStore

Index

Constructors

Methods

getValue observe setValue stopObserving

Constructors

constructor

new realtimeStore(): realtimeStore

Returns realtimeStore

Methods

getValue

getValue(key: string): Promise<string>
- This method can be used to retrieve the value associated with a given key.
Parameters
- key: string
  The key whose value should be retrieved.
Returns Promise<string>
A promise that resolves to the stored value.
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.ERROR_INVALID_PARAMETER — key is missing or is not a string
- Errors.FAILED_TO_GET_VALUE — the get request fails on the server
- Errors.ERROR_OPERATION_TIMED_OUT — the request timed out
Example
```
try {
  const value = await meeting.realtimeStore.getValue("Blocked_Students");
  console.log("Current value:", value);
} catch (error) {
  console.error("Failed to get data:", error);
}
```
- Defined in realtimeStore.d.ts:59

observe

observe(key: string, callback: Function): Promise<string>
- This method can be used to subscribe to real-time updates for a specific key.
- The provided callback function is executed whenever the value associated with the key is updated by any participant.
Parameters
- key: string
  The key to observe for updates.
- callback: Function
  A function that handles value updates along with the ID of the participant who made the change.
Returns Promise<string>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.ERROR_INVALID_PARAMETER — key is missing, key is not a string, or callback is not a function
- Errors.FAILED_TO_OBSERVE_VALUE — the underlying subscribe request fails on the server
- Errors.ERROR_OPERATION_TIMED_OUT — the request timed out
Example
```
try {
  const observerId = await meeting.realtimeStore.observe(
    "Blocked_Students",
    (value, updatedBy) => {
      console.log("Value updated:", value, "by", updatedBy);
    }
  );
} catch (error) {
  console.error("Failed to observe key:", error);
}
```
- Defined in realtimeStore.d.ts:94

setValue

setValue(key: string, value: string): Promise<void>
- 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
- key: string
  A unique identifier used to store the value.
- value: string
  The value to store. Pass null to delete the key.
Returns Promise<void>
Throws
- Errors.ERROR_ACTION_PERFORMED_BEFORE_MEETING_JOINED — called before meeting is joined
- Errors.ERROR_MEETING_RECONNECTING — meeting is reconnecting
- Errors.ERROR_INVALID_PARAMETER — key is missing, key is not a string, or value is neither a string nor null
- Errors.ERROR_PAYLOAD_TOO_LARGE — value payload exceeds the allowed size (1 KB)
- Errors.FAILED_TO_SET_VALUE — the set request fails on the server
- Errors.ERROR_OPERATION_TIMED_OUT — the request timed out
Example
```
try {
  await meeting.realtimeStore.setValue("Blocked_Students", "[Halima, Rajan]");
  console.log("Data set successfully!");
} catch (error) {
  console.error("Failed to set data:", error);
}
```
- Defined in realtimeStore.d.ts:31

stopObserving

stopObserving(observerId: string): Promise<void>
- This method can be used to stop receiving updates for a previously registered observer.
- Safe to call from cleanup paths: this method never rejects. An unknown, already-stopped, or missing observerId resolves as a no-op, and a failed server unsubscribe is recorded in telemetry rather than surfaced.
Parameters
- observerId: string
  The unique observer ID returned by the observe() method.
Returns Promise<void>
Example
```
try {
  await meeting.realtimeStore.stopObserving(observerId);
  console.log("Stopped observing successfully!");
} catch (error) {
  console.error("Failed to stop observing:", error);
}
```
- Defined in realtimeStore.d.ts:114