setBackground method

Future<DynamiteResponse<Background, void>> setBackground({
  1. required String type,
  2. String? value,
  3. String? color,
  4. bool? oCSAPIRequest,
})

Set the background.

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:

  • value Path of the background image. Defaults to ''.
  • color Color for the background.
  • type Type of background.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Background set successfully
  • 400: Setting background is not possible
  • 500

See:

Implementation

Future<DynamiteResponse<Background, void>> setBackground({
  required String type,
  String? value,
  String? color,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setBackgroundRaw(
    type: type,
    value: value,
    color: color,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}