AFHeartbeatStatus

data class AFHeartbeatStatus(val lastFireMillis: Long, val trigger: AFHeartbeatTrigger, val outcome: AFHeartbeatOutcome, val httpCode: Int? = null, val heartbeatId: String? = null, val receivedAt: String? = null, val memberId: Long? = null, val message: String? = null)

Snapshot of the most recent location-tracking heartbeat attempt.

The SDK fires a heartbeat from two places:

  • Inside AFCore.initialize after the init-time location ping.

  • On every app foreground transition (after a 30 s throttle).

Both triggers gate on the member being logged in and the host app having foreground location permission. When the heartbeat is not eligible, outcome reports the suppression reason and no POST is made; the existing snapshot remains the "last attempted" record.

Constructors

Link copied to clipboard
constructor(lastFireMillis: Long, trigger: AFHeartbeatTrigger, outcome: AFHeartbeatOutcome, httpCode: Int? = null, heartbeatId: String? = null, receivedAt: String? = null, memberId: Long? = null, message: String? = null)

Properties

Link copied to clipboard

Server-assigned echo of the request's heartbeatId.

Link copied to clipboard

HTTP status code returned by the server. null when the request was not sent (suppression) or the network never reached the server (NETWORK_ERROR).

Link copied to clipboard

Epoch milliseconds when this attempt was recorded.

Link copied to clipboard

Member id reported by the server.

Link copied to clipboard

Server-supplied diagnostic message, when present.

Link copied to clipboard

Result of the attempt.

Link copied to clipboard

Server timestamp (ISO-8601) acknowledging receipt.

Link copied to clipboard

What invoked this heartbeat attempt.