Model Reference
This page summarizes the return types partner apps most often inspect.
SdkOperationalDiagnostics
Purpose:
- snapshot of operational runtime health after bootstrap and session setup
Common fields:
connectionState: MQTT/realtime transport statesession: current signed session when presenttelemetryPublishTopic: operational telemetry topic the SDK is usingsosEventTopics: SOS event topics currently bound for the signed usersosRehydrationNote: explains fallback or rehydration behavior after startupbridge.lastDecision: latest bridge/runtime decision worth surfacing in diagnosticsbridge.pendingSos: queued SOS handoff details when an SOS is bufferedbridge.pendingTelemetry: queued telemetry payload details when telemetry is buffered
DeviceStatus
Purpose:
- high-level runtime view of the connected or remembered EIXAM device
Common fields:
deviceId: stable device identifier used by the SDKlifecycleState:unpaired,paired,activating,ready, orerrorpairedactivatedconnectedisReadyForSafety: most useful single readiness flag for host UIapproximateBatteryPercentagesignalQualityfirmwareVersionprovisioningError
DeviceSosStatus
Purpose:
- device-side SOS state maintained by the runtime
Common fields:
state:inactive,preConfirm,active,acknowledged, orresolvedlastEvent: most recent runtime explanationtransitionSource: where the current state came fromupdatedAtcountdownRemainingSeconds: useful during pre-confirm countdownslastPacketAt: last BLE SOS packet time when relevantdecoderNote: runtime note when packet interpretation matters
EmergencyContact
Purpose:
- backend-synced emergency contact record
Common fields:
idnamephoneemailpriorityupdatedAt
SosIncident
Purpose:
- app-originated SOS incident tracked by the SDK runtime
Common fields:
idstatecreatedAttriggerSourcemessagepositionSnapshot
PermissionState
Purpose:
- aggregated permission snapshot for partner UI and gating logic
Common fields:
locationnotificationsbluetoothbluetoothEnabledhasLocationAccesshasNotificationAccesscanUseBluetooth
ProtectionStatus
Purpose:
- current protection-mode runtime status, especially when native ownership is active
Common fields:
modeStatecoverageLevelruntimeStatebleOwnerprotectedDeviceIdserviceBleConnectedserviceBleReadyrestorationConfiguredreconnectAttemptCountlastReconnectAttemptAtdegradationReasonlastCommandRoutelastCommandResultlastCommandError
ProtectionDiagnostics
Purpose:
- detailed diagnostics for wake events, reconnects, queueing, and native command routing
Common fields:
lastWakeReasonlastFailureReasonlastPlatformEventlastRestorationEventreconnectAttemptCountlastReconnectAttemptAtprotectedDeviceIdlastCommandRoutelastCommandResultlastCommandErrorpendingSosCountpendingTelemetryCount
BackendRegisteredDevice
Purpose:
- backend registry record for a device associated with the signed user
Common fields:
idhardwareIdfirmwareVersionhardwareModelpairedAtupdatedAt