getRooms method

Future<DynamiteResponse<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders>> getRooms({
  1. RoomGetRoomsNoStatusUpdate? noStatusUpdate,
  2. int? includeStatus,
  3. int? modifiedSince,
  4. RoomGetRoomsApiVersion? apiVersion,
  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:

  • 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.
  • apiVersion Defaults to v4.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Return list of rooms

See:

Implementation

Future<DynamiteResponse<RoomGetRoomsResponseApplicationJson, RoomRoomGetRoomsHeaders>> getRooms({
  RoomGetRoomsNoStatusUpdate? noStatusUpdate,
  int? includeStatus,
  int? modifiedSince,
  RoomGetRoomsApiVersion? apiVersion,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getRoomsRaw(
    noStatusUpdate: noStatusUpdate,
    includeStatus: includeStatus,
    modifiedSince: modifiedSince,
    apiVersion: apiVersion,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}