setOutOfOffice method

Future<DynamiteResponse<OutOfOfficeSetOutOfOfficeResponseApplicationJson, void>> setOutOfOffice({
  1. required String firstDay,
  2. required String lastDay,
  3. required String status,
  4. required String message,
  5. required String userId,
  6. bool? oCSAPIRequest,
})

Set out-of-office absence.

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:

  • firstDay First day of the absence in format YYYY-MM-DD.
  • lastDay Last day of the absence in format YYYY-MM-DD.
  • status Short text that is set as user status during the absence.
  • message Longer multiline message that is shown to others during the absence.
  • userId
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Absence data
  • 400: When the first day is not before the last day
  • 401: When the user is not logged in

See:

Implementation

Future<DynamiteResponse<OutOfOfficeSetOutOfOfficeResponseApplicationJson, void>> setOutOfOffice({
  required String firstDay,
  required String lastDay,
  required String status,
  required String message,
  required String userId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = setOutOfOfficeRaw(
    firstDay: firstDay,
    lastDay: lastDay,
    status: status,
    message: message,
    userId: userId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}