Interface WaitForDeviceActiveOptions

Options for waitForDeviceActive.

interface WaitForDeviceActiveOptions {
    deviceName: string;
    hooks?: ProvisionHooks;
    logger?: Logger;
    onProgress?: (event: ProvisionProgressEvent) => void;
    organizationId: string;
    organizations: Pick<OrganizationsClient, "listDevices">;
    pollIntervalMs?: number;
    timeoutMs?: number;
}

Index

Properties

deviceName hooks? logger? onProgress? organizationId organizations pollIntervalMs? timeoutMs?

Properties

deviceName

deviceName: string

`Optional`hooks

hooks?: ProvisionHooks

`Optional`logger

logger?: Logger

`Optional`onProgress

onProgress?: (event: ProvisionProgressEvent) => void

Receives a 'wait-device' event with the device's current status after every poll.

organizationId

organizationId: string

organizations

organizations: Pick<OrganizationsClient, "listDevices">

`Optional`pollIntervalMs

pollIntervalMs?: number

Default 6000.

`Optional`timeoutMs

timeoutMs?: number

Default 120000.