updateMemberMeta

View as Markdown

updateMemberMeta

  • updateMemberMeta(params): Promise<void>

Updates a member’s metadata in only the specified fields. This is different from setMemberMeta, which replaces the whole metadata object.

Parameters

NameTypeDescription
paramsObject-
params.memberId?stringId of the member to affect. If omitted, affects the current member.
params.metaRecord``<string, unknown>The update to the metadata.

Returns

Promise<void>

Example

1roomSession.on("member.updated", (e) => {
2 // We can set an event listener to log changes to the metadata.
3 console.log(e.member.meta);
4});
5
6await roomSession.setMemberMeta({
7 memberId: "...",
8 meta: { foo: "bar", baz: true },
9});
10// The logger will now print `{ foo: "bar", baz: true }`
11
12await roomSession.updateMemberMeta({
13 memberId: "...",
14 meta: { baz: false, t: 10 },
15});
16// The logger will now print `{ foo: "bar", baz: false, t: 10 }`