updateContainer

abstract suspend fun updateContainer(containerId: String, newName: String, newDescription: String? = null): RainbowResult<Container>

Updates the details of an existing room container identified by its unique ID.

This method allows users to modify the name and description of a specific room container. The containerId parameter is required to identify which container is to be updated. The newName parameter is also required and must be a non-null string with a length between 1 and 64 characters. The newDescription is optional and can have a length of up to 255 characters.

The method returns a RainbowResult containing the updated Container. If the update operation is successful, the RainbowResult indicates success; otherwise, it indicates failure.

Return

A RainbowResult containing the updated Container. The RainbowResult indicates whether the operation was successful or not. In case of invalid parameters, a RainbowResult.Failure will be returned with the error details.

Parameters

containerId

The unique identifier of the room container to update.

newName

The new name for the room container. Must be a non-null string with a length between 1 and 64 characters.

newDescription

An optional new description for the room container. If provided, it can have a length of up to 255 characters.