setPassword method

Future<DynamiteResponse<RoomSetPasswordResponseApplicationJson, void>> setPassword({ required String password, required String token, RoomSetPasswordApiVersion? apiVersion, bool? oCSAPIRequest, })

Set a password for 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:

• password New password.
• apiVersion Defaults to "v4".
• token
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Password set successfully
• 403: Setting password is not allowed
• 400: Setting password is not possible

See:

• $setPassword_Request for the request send by this method.
• $setPassword_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<RoomSetPasswordResponseApplicationJson, void>> setPassword({
  required String password,
  required String token,
  RoomSetPasswordApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final _request = $setPassword_Request(
    password: password,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $setPassword_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<RoomSetPasswordResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}