setMemberMeta

setMemberMeta(params): Promise<void>

Assigns custom metadata to the specified RoomSession member. You can use this to store metadata whose meaning is entirely defined by your application.

Note that calling this method overwrites any metadata that had been previously set on the specified member.

Parameters

params

object

Object containing the parameters of the method.

memberId

string

Id of the member to affect. If omitted, affects the default device in the local client.

Returns

Promise<void>

Permissions

room.self.set_meta: to set the metadata for the local member.
room.member.set_meta: to set the metadata for a remote member.

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

Examples

Setting metadata for the current member:

1 await roomSession.setMemberMeta({
2   meta: {
3     email: "joe@example.com",
4   },
5 });

Setting metadata for another member:

1 await roomSession.setMemberMeta({
2   memberId: 'de550c0c-3fac-4efd-b06f-b5b8614b8966'  // you can get this from getMembers()
3   meta: {
4     email: 'joe@example.com'
5   }
6 })