createRoom method
Future<DynamiteResponse<RoomCreateRoomResponseApplicationJson, void> >
createRoom({
- required RoomCreateRoomRequestApplicationJson $body,
- RoomCreateRoomApiVersion? apiVersion,
- bool? oCSAPIRequest,
Create a room with a user, a group or a circle.
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:
apiVersion
Defaults to"v4"
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
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_Request for the request send by this method.
- $createRoom_Serializer for a converter to parse the
Response
from an executed request.
Implementation
Future<_i1.DynamiteResponse<RoomCreateRoomResponseApplicationJson, void>> createRoom({
required RoomCreateRoomRequestApplicationJson $body,
RoomCreateRoomApiVersion? apiVersion,
bool? oCSAPIRequest,
}) async {
final _request = $createRoom_Request(
apiVersion: apiVersion,
oCSAPIRequest: oCSAPIRequest,
$body: $body,
);
final _streamedResponse = await _rootClient.httpClient.send(_request);
final _response = await _i3.Response.fromStream(_streamedResponse);
final _serializer = $createRoom_Serializer();
return _i1.ResponseConverter<RoomCreateRoomResponseApplicationJson, void>(_serializer).convert(_response);
}