Ovok exception

OvokAuthenticationExceptionCopy Anchor Link

class OvokAuthenticationException extends OvokException

ConstructorsCopy Anchor Link

OvokAuthenticationException.newCopy Anchor Link

OvokAuthenticationException(OvokErrorDetails details, {Object? cause})

Creates the exception from details.

OvokConfigExceptionCopy Anchor Link

class OvokConfigException extends OvokException

A bad option, or an action this client cannot take.

ConstructorsCopy Anchor Link

OvokConfigException.newCopy Anchor Link

OvokConfigException(OvokErrorDetails details, {Object? cause})

Creates the exception from details.

OvokConflictExceptionCopy Anchor Link

class OvokConflictException extends OvokException

ConstructorsCopy Anchor Link

OvokConflictException.newCopy Anchor Link

OvokConflictException(OvokErrorDetails details, {Object? cause})

Creates the exception from details.

OvokConnectionExceptionCopy Anchor Link

class OvokConnectionException extends OvokException

No answer: a network failure or a timeout.

ConstructorsCopy Anchor Link

OvokConnectionException.newCopy Anchor Link

OvokConnectionException(OvokErrorDetails details, {Object? cause})

Creates the exception from details.

OvokErrorDetailsCopy Anchor Link

class OvokErrorDetails

What an OvokException carries; every field but message may be unknown.

ConstructorsCopy Anchor Link

OvokErrorDetails.newCopy Anchor Link

OvokErrorDetails({
  required String message,
  int? status,
  String? code,
  String? type,
  String? traceId,
  String? requestId,
  int? retryAfterMs,
  List<OvokFieldError> fieldErrors = const [],
})

Creates the details; the SDK builds these from error responses.

PropertiesCopy Anchor Link

OvokErrorDetails.messageCopy Anchor Link

final String message

A human-readable description of the failure.

OvokErrorDetails.statusCopy Anchor Link

final int? status

The HTTP status; null when no response arrived.

OvokErrorDetails.codeCopy Anchor Link

final String? code

The condition the server named; null when only the status is known.

OvokErrorDetails.typeCopy Anchor Link

final String? type

The problem type URI, https://docs.ovok.com/errors/<code>.

OvokErrorDetails.traceIdCopy Anchor Link

final String? traceId

The trace ID from x-trace-id or the body.

OvokErrorDetails.requestIdCopy Anchor Link

final String? requestId

The request ID from x-request-id or the body.

OvokErrorDetails.retryAfterMsCopy Anchor Link

final int? retryAfterMs

How long to wait before retrying, from Retry-After or the body.

OvokErrorDetails.fieldErrorsCopy Anchor Link

final List<OvokFieldError> fieldErrors

The fields the server rejected.

OvokExceptionCopy Anchor Link

class OvokException implements Exception

Every failure the SDK reports; catch a subclass to handle one case.

ConstructorsCopy Anchor Link

OvokException.newCopy Anchor Link

OvokException(OvokErrorDetails details, {Object? cause})

Creates an exception from details; cause is the underlying error, if any.

PropertiesCopy Anchor Link

OvokException.messageCopy Anchor Link

final String message

A human-readable description of the failure.

OvokException.statusCopy Anchor Link

final int? status

The HTTP status; null when no response arrived.

OvokException.codeCopy Anchor Link

final String? code

The condition the server named; null when only the status is known.

OvokException.typeCopy Anchor Link

final String? type

The problem type URI, https://docs.ovok.com/errors/<code>.

OvokException.traceIdCopy Anchor Link

final String? traceId

Quote it when reporting a problem.

OvokException.requestIdCopy Anchor Link

final String? requestId

The request ID from x-request-id or the body.

OvokException.retryAfterMsCopy Anchor Link

final int? retryAfterMs

How long to wait before retrying, from Retry-After or the body.

OvokException.fieldErrorsCopy Anchor Link

final List<OvokFieldError> fieldErrors

The fields the server rejected; empty when none were named.

OvokException.causeCopy Anchor Link

final Object? cause

The underlying error, such as a timeout or socket failure.

OvokFieldErrorCopy Anchor Link

class OvokFieldError

One field the server rejected; path is the field's location, outermost first.

ConstructorsCopy Anchor Link

OvokFieldError.newCopy Anchor Link

OvokFieldError({
  required String message,
  List<String> path = const [],
  String? code,
  String? validation,
})

Creates a field error; the SDK builds these from error responses.

PropertiesCopy Anchor Link

OvokFieldError.messageCopy Anchor Link

final String message

Why the field was rejected.

OvokFieldError.pathCopy Anchor Link

final List<String> path

The field's location, outermost first; empty when the server named none.

OvokFieldError.codeCopy Anchor Link

final String? code

The rejection's code, when the server sent one.

OvokFieldError.validationCopy Anchor Link

final String? validation

The kind of validation that failed, when the server named it.

OvokNotFoundExceptionCopy Anchor Link

class OvokNotFoundException extends OvokException

ConstructorsCopy Anchor Link

OvokNotFoundException.newCopy Anchor Link

OvokNotFoundException(OvokErrorDetails details, {Object? cause})

Creates the exception from details.

OvokPermissionExceptionCopy Anchor Link

class OvokPermissionException extends OvokException

403: signed in, but not allowed.

ConstructorsCopy Anchor Link

OvokPermissionException.newCopy Anchor Link

OvokPermissionException(OvokErrorDetails details, {Object? cause})

Creates the exception from details.

OvokRateLimitExceptionCopy Anchor Link

class OvokRateLimitException extends OvokException

ConstructorsCopy Anchor Link

OvokRateLimitException.newCopy Anchor Link

OvokRateLimitException(OvokErrorDetails details, {Object? cause})

Creates the exception from details.

OvokServiceExceptionCopy Anchor Link

class OvokServiceException extends OvokException

5xx.

ConstructorsCopy Anchor Link

OvokServiceException.newCopy Anchor Link

OvokServiceException(OvokErrorDetails details, {Object? cause})

Creates the exception from details.

OvokValidationExceptionCopy Anchor Link

class OvokValidationException extends OvokException

400 or 422.

ConstructorsCopy Anchor Link

OvokValidationException.newCopy Anchor Link

OvokValidationException(OvokErrorDetails details, {Object? cause})

Creates the exception from details.