getBackground method

Future<DynamiteResponse<Uint8List, void>> getBackground({
  1. bool? oCSAPIRequest,
})

Get the background image.

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:

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

Status codes:

  • 200: Background image returned
  • 404: Background image not found

See:

Implementation

Future<DynamiteResponse<Uint8List, void>> getBackground({bool? oCSAPIRequest}) async {
  final rawResponse = getBackgroundRaw(
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}