setDescription method
Future<DynamiteResponse<RoomSetDescriptionResponseApplicationJson, void> >
setDescription({
- required String description,
- required String token,
- RoomSetDescriptionApiVersion? apiVersion,
- bool? oCSAPIRequest,
Update the description of a room.
Returns a Future containing a DynamiteResponse
with the status code, deserialized body and headers.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
description
New description.apiVersion
Defaults to"v4"
.token
oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Description updated successfully
- 400: Updating description is not possible
See:
- $setDescription_Request for the request send by this method.
- $setDescription_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<RoomSetDescriptionResponseApplicationJson, void>> setDescription({
required String description,
required String token,
RoomSetDescriptionApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $setDescription_Request(
description: description,
token: token,
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
);
final _response = await _rootClient.httpClient.send(_request);
final _serializer = $setDescription_Serializer();
final _rawResponse =
await _i1.ResponseConverter<RoomSetDescriptionResponseApplicationJson, void>(_serializer).convert(_response);
return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}