heartbeat method

Future<DynamiteResponse<HeartbeatHeartbeatResponseApplicationJson, void>> heartbeat({ required String status, bool? oCSAPIRequest, })

Keep the status alive.

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:

• status Only online, away.
• 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_Request for the request send by this method.
• $heartbeat_Serializer for a converter to parse the Response from an executed request.

Implementation

Future<_i1.DynamiteResponse<HeartbeatHeartbeatResponseApplicationJson, void>> heartbeat({
  required String status,
  bool? oCSAPIRequest,
}) async {
  final _request = $heartbeat_Request(
    status: status,
    oCSAPIRequest: oCSAPIRequest,
  );
  final _response = await _rootClient.httpClient.send(_request);

  final _serializer = $heartbeat_Serializer();
  final _rawResponse =
      await _i1.ResponseConverter<HeartbeatHeartbeatResponseApplicationJson, void>(_serializer).convert(_response);
  return _i1.DynamiteResponse.fromRawResponse(_rawResponse);
}