房间属性是附加到当前房间上的一系列key-value键值对，key为属性唯一名称，value为当前属性值。 NERoom允许开发者自定义房间属性，并在房间生命周期内对属性进行添加、更新、删除操作，同时还可以监听属性变更通知。

注意事项

• 在使用房间属性前，需要在控制台中创建对应属性，指定属性名称，并进行权限配置。
• 房间属性仅对当前设置的房间有效，在当前房间生命周期结束后会被统一清理，下次创建房间需要重新设置。

设置房间属性

NERoom 支持在创建房间时设置属性，或加入房间后设置和更新属性。

设置初始房间属性

在创建房间时，通过 NECreateRoomParams.initialProperties 参数可设置房间初始属性。

function createRoom(params: NECreateRoomParams, options: NECreateRoomOptions)

示例代码如下：

/**
 * 创建房间
 * @param params.configId 模板ID
 * @param params.roomName 房间名称
 * @param params.roomUuid 房间ID
 * @param params.initialProperties 房间ch
 * @param options.enableRtc 是否需要配置RTC房间
 * @param options.enableChatroom 是否需要配置聊天室房间
 * @param options.enableWhiteboard 是否需要配置白板房间
 
 */

const params = {
    configId: 'your configId',
    roomName: 'your roomName',
    roomUuid: 'your roomUuid'，
    initialProperties: {key: 'value'}
}
const options = {
    enableRtc: true,
    enableChatroom: true,
    enableWhiteboard: true,
    enableRecord: false
}
NERoomService.createRoom(params, options).then(res => {
    console.log(res, 'createRoom success')
}).catch(err => {
    console.error(err, 'createRoom fail')
})

房间内设置属性

在加入房间后，可通过 NERoomContext.updateRoomProperty 接口进行房间属性的设置和更新。

function updateRoomProperty(
    key: string,
    value: string,
    associatedUuid?: string,
)

相关参数说明如下表所示。

名称	描述
key	属性名称，如果属性名称不存在，则设置该属性；如果属性名称已存在，则更新该属性请确保已在云信控制台对应的模板中配置相关属性，否则会报错。
value	属性值
associatedUuid	指定该属性关联的用户。若成功关联，则该房间属性在关联用户离开房间后会自动删除

示例代码如下：

roomContext.updateRoomProperty("key", "value", null);

查询房间属性

通过 NERoomContext.roomProperties 可查询到当前时刻下房间的所有属性。key即为属性名称，value为属性值。

删除房间属性

在加入房间后，可通过 NERoomContext.deleteRoomProperty 接口进行房间属性的删除。

deleteRoomProperty(key: string): Promise<NEResponseBody> 

相关参数说明如下表所示。

名称	描述
key	待删除的属性名称

示例代码如下：

roomContext.deleteRoomProperty("key");

监听房间属性变更

在进行属性操作之后，会触发属性变更通知，通过以下回调接口监听到变更事件：

• NERoomListener.onRoomPropertiesChanged: 属性变更回调通知
• NERoomListener.onRoomPropertiesDeleted: 属性删除回调通知

示例代码如下：

NERoomContext.addRoomListener({
    onRoomPropertiesChanged: (properties) => {
        console.log('onRoomPropertiesChanged', properties)
    },
    onRoomPropertiesDeleted: (keys) => {
        console.log('onRoomPropertiesDeleted', keys)
    },
})

API 参考

方法	功能描述
updateRoomProperty	更新房间属性
deleteRoomProperty	删除房间属性