AFCore/com.advantahealth.api.heartbeat/AFHeartbeatOutcome

AFHeartbeatOutcome

enum AFHeartbeatOutcome : Enum<AFHeartbeatOutcome>

Entries

The POST returned a 2xx — payload is in AFHeartbeatStatus.heartbeatId etc.

Suppressed: heartbeat is disabled by the consumer. See AFCore.setHeartbeatEnabled. This is the highest-priority guard — opted-out consumers never incur a token check, a permission probe, or a GPS warmup.

SUPPRESSED_NOT_LOGGED_IN

Suppressed: no access token in preferences.

SUPPRESSED_NO_PERMISSION

Suppressed: host app does not hold foreground location permission.

SUPPRESSED_THROTTLED

Suppressed: a heartbeat fired within the throttle window (30 s).

SUPPRESSED_NO_LOCATION_FIX

Suppressed: the platform returned no fresh fix and no last-known location.

NETWORK_ERROR

POST attempted; no HTTP response received (offline, DNS, timeout).

HTTP_ERROR

POST returned a non-2xx HTTP status — see AFHeartbeatStatus.httpCode.

Properties

entries

val entries: EnumEntries<AFHeartbeatOutcome>

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): AFHeartbeatOutcome

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<AFHeartbeatOutcome>

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