Skip to main content

@dialstack/sdk / index / DeviceReadiness

Interface: DeviceReadiness

Defined in: sdk/src/utils/device-readiness.ts:63

Properties​

assigned​

assigned: boolean;

Defined in: sdk/src/utils/device-readiness.ts:69

The device belongs to a user — the floating gate into readyToCall.

completedCount​

completedCount: number;

Defined in: sdk/src/utils/device-readiness.ts:79

How many of the four spine steps are satisfied (0–4).

currentStep​

currentStep: DeviceReadinessStep | null;

Defined in: sdk/src/utils/device-readiness.ts:77

First incomplete step on the spine, or null when all are satisfied.

firstCall​

firstCall: boolean;

Defined in: sdk/src/utils/device-readiness.ts:73

The device has carried a call (last_call_at non-null).

graduated​

graduated: boolean;

Defined in: sdk/src/utils/device-readiness.ts:75

Whether the device has left onboarding (=== firstCall).

missing​

missing: DeviceReadinessPrerequisite[];

Defined in: sdk/src/utils/device-readiness.ts:87

Configuration prerequisites the device is still missing, per device type: a user for the line (deskphones/handsets), an E911 location (deskphones/bases — handsets inherit their base's), and a paired base (handsets — their config flows through it). The single source of truth for "what must be filled in before this phone can place calls".

online​

online: boolean;

Defined in: sdk/src/utils/device-readiness.ts:67

The device is reachable right now (not the same as call-capable).

provisioned​

provisioned: boolean;

Defined in: sdk/src/utils/device-readiness.ts:65

The device has fetched its settings.

readyToCall​

readyToCall: boolean;

Defined in: sdk/src/utils/device-readiness.ts:71

Assigned and online: the device can make and receive calls.