$heartbeat_Request method

@experimental Request $heartbeat_Request({ required HeartbeatHeartbeatRequestApplicationJson $body, bool? oCSAPIRequest, })

Keep the status alive.

Returns a DynamiteRequest backing the heartbeat operation. 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: Status successfully updated
• 400: Invalid status to update
• 500
• 204: User has no status to keep alive

See:

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

Implementation

@_i2.experimental
_i3.Request $heartbeat_Request({
  required HeartbeatHeartbeatRequestApplicationJson $body,
  bool? oCSAPIRequest,
}) {
  const _path = '/ocs/v2.php/apps/user_status/api/v1/heartbeat';
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('put', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i4.IterableExtension(_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);

  _request.headers['Content-Type'] = 'application/json';
  _request.body = json.encode(
    _$jsonSerializers.serialize($body, specifiedType: const FullType(HeartbeatHeartbeatRequestApplicationJson)),
  );
  return _request;
}