$setOutOfOffice_Request method

@experimental Request $setOutOfOffice_Request({ required String firstDay, required String lastDay, required String status, required String message, required String userId, bool? oCSAPIRequest, })

Set out-of-office absence.

Returns a DynamiteRequest backing the setOutOfOffice operation. 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:

• setOutOfOffice for a method executing this request and parsing the response.
• $setOutOfOffice_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $setOutOfOffice_Request({
  required String firstDay,
  required String lastDay,
  required String status,
  required String message,
  required String userId,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $firstDay = _$jsonSerializers.serialize(firstDay, specifiedType: const FullType(String));
  _parameters['firstDay'] = $firstDay;

  final $lastDay = _$jsonSerializers.serialize(lastDay, specifiedType: const FullType(String));
  _parameters['lastDay'] = $lastDay;

  final $status = _$jsonSerializers.serialize(status, specifiedType: const FullType(String));
  _parameters['status'] = $status;

  final $message = _$jsonSerializers.serialize(message, specifiedType: const FullType(String));
  _parameters['message'] = $message;

  final $userId = _$jsonSerializers.serialize(userId, specifiedType: const FullType(String));
  _parameters['userId'] = $userId;

  final _path =
      _i4.UriTemplate('/ocs/v2.php/apps/dav/api/v1/outOfOffice/{userId}{?firstDay*,lastDay*,status*,message*}')
          .expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('post', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i5.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}