setDescription method

Future<DynamiteResponse<RoomSetDescriptionResponseApplicationJson, void>> setDescription({
  1. required String description,
  2. required String token,
  3. RoomSetDescriptionApiVersion? apiVersion,
  4. 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 to true.

Status codes:

  • 200: Description updated successfully
  • 400: Updating description is not possible

See:

  • setDescriptionRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<RoomSetDescriptionResponseApplicationJson, void>> setDescription({
  required String description,
  required String token,
  RoomSetDescriptionApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setDescriptionRaw(
    description: description,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}