Skip to main content

@dialstack/sdk-dev / js/src / DeviceReadiness

Interface: DeviceReadiness

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

Properties​

assigned​

TypeScript
assigned: boolean;

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

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


completedCount​

TypeScript
completedCount: number;

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

How many of steps are satisfied.


contacted​

TypeScript
contacted: boolean;

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

The phone has contacted the manufacturer's zero-touch service. Only meaningful when steps includes 'contacted'.


currentStep​

TypeScript
currentStep: DeviceReadinessStep | null;

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

First incomplete step in steps, or null when all are satisfied.


firstCall​

TypeScript
firstCall: boolean;

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

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


graduated​

TypeScript
graduated: boolean;

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

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


missing​

TypeScript
missing: DeviceReadinessPrerequisite[];

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

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​

TypeScript
online: boolean;

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

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


provisioned​

TypeScript
provisioned: boolean;

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

The device has fetched its settings. Only meaningful when steps includes 'provisioned'.


readyToCall​

TypeScript
readyToCall: boolean;

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

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


steps​

TypeScript
steps: DeviceReadinessStep[];

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

The spine steps that apply to this device, in order. DECT handsets skip 'provisioned' — their base fetches the settings for them.