setPassword method

Future<DynamiteResponse<RoomSetPasswordResponseApplicationJson, void>> setPassword({
  1. required String password,
  2. required String token,
  3. RoomSetPasswordApiVersion? apiVersion,
  4. 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:

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

Implementation

Future<_i1.DynamiteResponse<RoomSetPasswordResponseApplicationJson, void>> setPassword({
  required String password,
  required String token,
  RoomSetPasswordApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setPasswordRaw(
    password: password,
    token: token,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}