heartbeat method

Future<DynamiteResponse<HeartbeatHeartbeatResponseApplicationJson, void>> heartbeat({
  1. required String status,
  2. 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:

  • heartbeatRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<HeartbeatHeartbeatResponseApplicationJson, void>> heartbeat({
  required String status,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = heartbeatRaw(
    status: status,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}