Interface DeviceRepository<T>

Repository operations for a single device kind.

Remarks

Mirrors the native DeviceRepository<T> protocol (iOS) / interface (Android). Each DeviceClient property (oath, push, bound, profile, webAuthn) exposes a DeviceRepository instance parameterised with the appropriate device type.

Example

const repo: DeviceRepository<OathDevice> = client.oath;
const devices = await repo.get();

interface DeviceRepository<T> {
    delete(device: T): Promise<T>;
    get(): Promise<T[]>;
    update(device: T): Promise<T>;
}

Type Parameters

T
The concrete device type for this repository (e.g. OathDevice, BoundDevice).

Index

Methods

delete get update

Methods

delete

delete(device: T): Promise<T>
Deletes a device from the server.
Parameters
- device: T
  The device to delete. The id field is used for lookup.
Returns Promise<T>
A promise resolving to the deleted device.

Throws
DeviceClientError when the device does not exist.
- Defined in packages/device-client/src/types/client.types.ts:117

get

get(): Promise<T[]>
Fetches all devices of this kind for the active user.

Returns Promise<T[]>
A promise resolving to an array of devices. Returns an empty array when the user has no devices of this kind.

Throws
DeviceClientError on connectivity failures or expired tokens.
- Defined in packages/device-client/src/types/client.types.ts:98

update

update(device: T): Promise<T>
Updates a device on the server.
Parameters
- device: T
  The device with the updated field(s).
Returns Promise<T>
A promise resolving to the server's acknowledged copy of the device.

Remarks
Currently only the deviceName property is writable.

Throws
DeviceClientError on not-found or validation errors.
- Defined in packages/device-client/src/types/client.types.ts:109

Interface DeviceRepository<T>

Remarks

Example

Type Parameters

Index

Methods

Methods

delete

Parameters

Returns Promise<T>

Throws

get

Returns Promise<T[]>

Throws

update

Parameters

Returns Promise<T>

Remarks

Throws

Settings

On This Page