getRooms method

Future<DynamiteResponse<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders>> getRooms({
  1. RoomGetRoomsApiVersion? apiVersion,
  2. RoomGetRoomsNoStatusUpdate? noStatusUpdate,
  3. RoomGetRoomsIncludeStatus? includeStatus,
  4. int? modifiedSince,
  5. bool? oCSAPIRequest,
})

Get all currently existent rooms which the user has joined.

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".
  • noStatusUpdate When the user status should not be automatically set to online set to 1 (default 0). Defaults to 0.
  • includeStatus Include the user status. Defaults to 0.
  • modifiedSince Filter rooms modified after a timestamp. Defaults to 0.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Return list of rooms

See:

Implementation

Future<_i1.DynamiteResponse<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders>> getRooms({
  RoomGetRoomsApiVersion? apiVersion,
  RoomGetRoomsNoStatusUpdate? noStatusUpdate,
  RoomGetRoomsIncludeStatus? includeStatus,
  int? modifiedSince,
  bool? oCSAPIRequest,
}) async {
  final _request = $getRooms_Request(
    apiVersion: apiVersion,
    noStatusUpdate: noStatusUpdate,
    includeStatus: includeStatus,
    modifiedSince: modifiedSince,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _streamedResponse = await _rootClient.httpClient.send(_request);
  final _response = await _i3.Response.fromStream(_streamedResponse);

  final _serializer = $getRooms_Serializer();
  return _i1.ResponseConverter<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders>(_serializer)
      .convert(_response);
}