Aller au contenu principal
Version: Next

Model Reference

Reference for all return types that partner apps most often inspect.

SdkOperationalDiagnostics

Snapshot of operational runtime health after bootstrap and session setup.

FieldDescription
connectionStateMQTT/realtime transport state
sessionCurrent signed session, when present
telemetryPublishTopicOperational telemetry topic the SDK is using
sosEventTopicsSOS event topics currently bound for the signed user
sosRehydrationNoteExplains fallback or rehydration behavior after startup
bridge.lastDecisionLatest bridge/runtime decision worth surfacing in diagnostics
bridge.pendingSosQueued SOS handoff details when an SOS is buffered
bridge.pendingTelemetryQueued telemetry payload details when telemetry is buffered

DeviceStatus

High-level runtime view of the connected or remembered Eixam device.

FieldDescription
deviceIdStable device identifier used by the SDK
lifecycleStateunpaired, paired, activating, ready, or error
pairedWhether a device is paired
activatedWhether the device is activated
connectedWhether the device is currently connected
isReadyForSafetyMost useful single readiness flag for host UI
approximateBatteryPercentageApproximate battery level
signalQualityBLE signal quality
firmwareVersionDevice firmware version
provisioningErrorError during provisioning, if any

DeviceSosStatus

Device-side SOS state maintained by the runtime.

FieldDescription
stateinactive, preConfirm, active, acknowledged, or resolved
lastEventMost recent runtime explanation
transitionSourceWhere the current state came from
updatedAtTimestamp of last state update
countdownRemainingSecondsUseful during pre-confirm countdowns
lastPacketAtLast BLE SOS packet time, when relevant
decoderNoteRuntime note when packet interpretation matters

EmergencyContact

Backend-synced emergency contact record.

FieldDescription
idContact record ID
nameContact name
phoneContact phone number
emailContact email
priorityPriority order
updatedAtLast update timestamp

SosIncident

App-originated SOS incident tracked by the SDK runtime.

FieldDescription
idIncident ID
stateCurrent SOS lifecycle state
createdAtIncident creation timestamp
triggerSourceWhat triggered the SOS
messageSOS message
positionSnapshotPosition at the time of the SOS, when available

PermissionState

Aggregated permission snapshot for partner UI and gating logic.

FieldDescription
locationLocation permission status
notificationsNotification permission status
bluetoothBluetooth permission status
bluetoothEnabledWhether Bluetooth is enabled on the device
hasLocationAccessComputed: location permission granted
hasNotificationAccessComputed: notification permission granted
canUseBluetoothComputed: Bluetooth is permitted and enabled

ProtectionStatus

Current Protection Mode runtime status, especially when native ownership is active.

FieldDescription
modeStateWhether Protection Mode is armed, off, or degraded
coverageLevelLevel of coverage provided
runtimeStateCurrent runtime execution state
bleOwnerWho owns BLE (Flutter or native service)
protectedDeviceIdDevice ID currently under protection
serviceBleConnectedWhether native service BLE is connected
serviceBleReadyWhether native service BLE is ready
restorationConfiguredWhether restoration is configured
reconnectAttemptCountNumber of reconnect attempts
lastReconnectAttemptAtTimestamp of last reconnect attempt
degradationReasonReason for degradation, if any
lastCommandRouteRoute taken for the last command
lastCommandResultResult of the last command
lastCommandErrorError from the last command, if any

ProtectionDiagnostics

Detailed diagnostics for wake events, reconnects, queueing, and native command routing.

FieldDescription
lastWakeReasonReason for the last native wake event
lastFailureReasonMost recent failure reason
lastPlatformEventLast platform-level event
lastRestorationEventLast state restoration event
reconnectAttemptCountNumber of reconnect attempts
lastReconnectAttemptAtTimestamp of last reconnect attempt
protectedDeviceIdDevice ID under protection
lastCommandRouteRoute taken for the last command
lastCommandResultResult of the last command
lastCommandErrorError from the last command, if any
pendingSosCountNumber of SOS events pending in the native queue
pendingTelemetryCountNumber of telemetry events pending in the native queue

BackendRegisteredDevice

Backend registry record for a device associated with the signed user.

FieldDescription
idBackend device record ID
hardwareIdCanonical device hardware identifier
firmwareVersionDevice firmware version
hardwareModelDevice hardware model
pairedAtPairing timestamp
updatedAtLast update timestamp