AFCore/com.advantahealth.api/AFErrorKind

AFErrorKind

What kind of failure an AFException represents, classified by the SDK the same way on every platform.

Use it to choose your own localized copy, an icon, or whether to offer a retry. AFException.message is already safe to show a member for every kind; AFException.technicalMessage holds the diagnostic text for logs.

Entries

NO_CONNECTION

The device has no usable connection, or the server could not be reached.

TIMEOUT

The request or connection took too long. Usually worth retrying.

SECURE_CONNECTION

A secure (TLS) connection could not be established.

UNAUTHORIZED

The session is missing, expired or rejected (HTTP 401).

SERVER_ERROR

The server failed (HTTP 5xx or 429). Usually worth retrying later.

CLIENT_ERROR

The server rejected the request (HTTP 4xx). When the server sent a message for the member, AFException.message carries it unchanged.

INVALID_RESPONSE

The server answered with something the SDK could not read.

UNKNOWN

Anything else.

Properties

entries

val entries: EnumEntries<AFErrorKind>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): AFErrorKind

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<AFErrorKind>

Returns an array containing the constants of this enum type, in the order they're declared.