$createRoom_Request method

  1. @experimental
Request $createRoom_Request({
  1. required RoomCreateRoomRequestApplicationJson $body,
  2. RoomCreateRoomApiVersion? apiVersion,
  3. bool? oCSAPIRequest,
})

Create a room with a user, a group or a circle.

Returns a DynamiteRequest backing the createRoom operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

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

Status codes:

  • 200: Room already existed
  • 201: Room created successfully
  • 400: Room type invalid
  • 403: Missing permissions to create room
  • 404: User, group or other target to invite was not found

See:

  • createRoom for a method executing this request and parsing the response.
  • $createRoom_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $createRoom_Request({
  required RoomCreateRoomRequestApplicationJson $body,
  RoomCreateRoomApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  var __apiVersion = _$jsonSerializers.serialize(apiVersion, specifiedType: const FullType(RoomCreateRoomApiVersion));
  __apiVersion ??= 'v4';
  _parameters['apiVersion'] = __apiVersion;

  final _path = _i5.UriTemplate('/ocs/v2.php/apps/spreed/api/{apiVersion}/room').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i6.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var __oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  __oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert(__oCSAPIRequest);

  _request.headers['Content-Type'] = 'application/json';
  _request.body = json.encode(
    _$jsonSerializers.serialize($body, specifiedType: const FullType(RoomCreateRoomRequestApplicationJson)),
  );
  return _request;
}