setKeepaliveRaw method

  1. @experimental
DynamiteRawResponse<SetKeepaliveResponseApplicationJson, void> setKeepaliveRaw({
  1. required int keepalive,
})

Set keepalive interval.

This endpoint requires admin access.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • keepalive Keep alive value in seconds.

Status codes:

  • 200

See:

  • setKeepalive for an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i3.experimental
_i1.DynamiteRawResponse<SetKeepaliveResponseApplicationJson, void> setKeepaliveRaw({required int keepalive}) {
  final _parameters = <String, dynamic>{};
  final _headers = <String, String>{'Accept': 'application/json'};

// coverage:ignore-start
  final authentication = authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

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

// coverage:ignore-end
  final $keepalive = _$jsonSerializers.serialize(keepalive, specifiedType: const FullType(int));
  _parameters['keepalive'] = $keepalive;

  final _path = _i2.UriTemplate('/index.php/apps/uppush/keepalive{?keepalive*}').expand(_parameters);
  return _i1.DynamiteRawResponse<SetKeepaliveResponseApplicationJson, void>(
    response: executeRequest(
      'put',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(SetKeepaliveResponseApplicationJson),
    headersType: null,
    serializers: _$jsonSerializers,
  );
}