Class QuantumDevicesClientV1

Base qBraid client for interacting with qBraid Cloud Services (V1 API). This client requires a QbraidSessionV1 to be provided.

Hierarchy (View Summary)

QbraidClientV1
- QuantumDevicesClientV1

Index

Constructors

Properties

Methods

Constructors

constructor

new QuantumDevicesClientV1(session: QbraidSessionV1): QuantumDevicesClientV1
Parameters
- session: QbraidSessionV1
Returns QuantumDevicesClientV1
Overrides QbraidClientV1.constructor
- Defined in devices/src/client.ts:21

Properties

`Protected`session

session: QbraidSessionV1

The QbraidSessionV1 instance used by this client.

Methods

getDevices

getDevices(params?: DeviceQueryParamsV1): Promise<PlatformDevice[]>
Get devices from the V1 API.
Parameters
- Optionalparams: DeviceQueryParamsV1
  Optional query parameters to filter devices
Returns Promise<PlatformDevice[]>
Array of PlatformDevice objects
- Defined in devices/src/client.ts:30