Meeting key-value store
Last updated Oct 19, 2026 The RealtimeKit Stores API allows you to create multiple key-value pair realtime stores. Users can subscribe to changes in a store and receive real-time updates. Data is stored until a session is active.
WebMobile
ReactWeb ComponentsAngular
Create a Store
You can create a realtime store (changes are synced with other users):
| Param | Type | Description | Required |
|---|---|---|---|
name |
string | Name of the store | true |
To create a store:
const stores = useRealtimeKitSelector((m) => m.stores);
const store = stores.create('myStore');
const store = meeting.stores.create('myStore');
const store = meeting.stores.create('myStore');
val meeting = RealtimeKitMeetingBuilder.build(activity)
val store = meeting.stores.create("myStore")
let meeting = RealtimeKitiOSClientBuilder().build()
let store = meeting.stores.create(name: "myStore")
Note
This method must be executed for every user.
Update a Store
You can add, update or delete entries in a store:
| Param | Type | Description | Required |
|---|---|---|---|
key |
string | Unique identifier used to store/update a value in the store | Yes |
value |
StoreValue | Value that can be stored against a key | Yes |
type StoreValue = string | number | object | array;
const stores = useRealtimeKitSelector((m) => m.stores.stores);
const store = stores.get("myStore");
await store.set("user", { name: "John Doe" });
await store.update("user", { age: 34 }); // { name: 'John Doe', age: 34 }
await store.delete("user");
type StoreValue = string | number | object | array;
const { stores } = meeting.stores;
const store = stores.get("myStore");
await store.set("user", { name: "John Doe" });
await store.update("user", { age: 34 }); // { name: 'John Doe', age: 34 }
await store.delete("user");
type StoreValue = string | number | object | array;
const { stores } = meeting.stores;
const store = stores.get("myStore");
await store.set("user", { name: "John Doe" });
await store.update("user", { age: 34 }); // { name: 'John Doe', age: 34 }
await store.delete("user");
val store = meeting.stores.get("myStore")
store.set("user", mapOf("name" to "John Doe"))
let store = meeting.stores.get(name: "myStore")
store.set("user", ["name": "John Doe"])
Note
The set method overwrites the existing value, while the update method updates the existing value.
For example, if the stored value is ['a', 'b'] and you call update with ['c'], the final value will be ['a', 'b', 'c'].
Subscribe to a Store
You can attach event listeners on a store's key, which fire when the value changes.
const stores = useRealtimeKitSelector((m) => m.stores.stores);
const store = stores.get('myStore');
store.subscribe('key', (data) => {
console.log(data);
});
// subscribe to all keys of a store
store.subscribe('\*', (data) => {
console.log(data);
});
store.unsubscribe('key');
const { stores } = meeting.stores;
const store = stores.get('myStore');
store.subscribe('key', (data) => {
console.log(data);
});
// subscribe to all keys of a store
store.subscribe('\*', (data) => {
console.log(data);
});
store.unsubscribe('key');
const { stores } = meeting.stores;
const store = stores.get('myStore');
store.subscribe('key', (data) => {
console.log(data);
});
// subscribe to all keys of a store
store.subscribe('\*', (data) => {
console.log(data);
});
store.unsubscribe('key');
val store = meeting.stores.create("myStore")
val keyChangeCallback = { key: String, value: Any? ->
println(value)
}
store.subscribe("key", keyChangeCallback)
// Subscribe to all keys
store.subscribe(RtkStore.WILDCARD_KEY) { key, value ->
println(value)
}
store.unsubscribe("key", keyChangeCallback)
let store = meeting.stores.create(name: "myStore")
let keyChangeCallback: ((String, (Any?)) -> Void) = { key, value in
print(value ?? "null")
}
store.subscribe(key: "key", onChange: keyChangeCallback)
// Subscribe to all keys
store.subscribe(key: RtkStore.Companion().WILDCARD_KEY) { key, value in
print(value ?? "null")
}
store.unsubscribe(key: "key", onChange: keyChangeCallback)
Fetch Store Data
You can fetch the data stored in the store:
const stores = useRealtimeKitSelector((m) => m.stores.stores);
const store = stores.get('myStore');
// fetch value for a specific key
const data = store.get('key');
// fetch all the data in the store
const data = store.getAll();
const { stores } = meeting.stores;
const store = stores.get('myStore');
// fetch value for a specific key
const data = store.get('key');
// fetch all the data in the store
const data = store.getAll();
const { stores } = meeting.stores;
const store = stores.get('myStore');
// fetch value for a specific key
const data = store.get('key');
// fetch all the data in the store
const data = store.getAll();
val store = meeting.stores.create("myStore")
// fetch value for a specific key
val data = store.get("key")
// fetch all the data in the store
val data = store.getAll()
let store = meeting.stores.create(name: "myStore")
// fetch value for a specific key
store.get(key: "key")
// fetch all the data in the store
store.getAll()
Was this helpful?
YesNo
On this page
{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/realtime/realtimekit/collaboration/meeting-key-value-store/#page","headline":"Meeting key-value store","description":"Create real-time key-value stores that sync shared state across participants in a RealtimeKit session.","url":"https://developers.cloudflare.com/realtime/realtimekit/collaboration/meeting-key-value-store/","inLanguage":"en","image":"https://developers.cloudflare.com/realtime/realtimekit/collaboration/meeting-key-value-store/og.png?v=a32d894e1c376908","dateModified":"2026-10-19","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}
description: Send custom broadcast messages to all participants in a RealtimeKit meeting. title: Message broadcast image: https://developers.cloudflare.com/realtime/realtimekit/collaboration/message-broadcast/og.png?v=f55262cc4bd037d0
Documentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/realtime/llms.txt
Use this file to discover all available pages before exploring further.
Docs