VideoRoomSessionMethods

deleteMeta

View as Markdown

deleteMeta

  • deleteMeta(keys): Promise<void>

Deletes the specified keys from the metadata for this RoomSession.

Parameters

keys
string[]

The keys to remove.

Returns

Promise<void>

Permissions

  • room.set_meta

You need to specify the permissions when creating the Video Room Token on the server side.

Example

1roomSession.on("room.updated", (e) => {
2  // We can set an event listener to log changes to the metadata.
3  console.log(e.room.meta);
4});
5
6await roomSession.setMeta({ foo: "bar", baz: true });
7// The logger will now print `{ foo: "bar", baz: true }`
8
9await roomSession.deleteMeta(["foo"]);
10// The logger will now print `{ baz: true }`