Skip to content
This repository has been archived by the owner on Sep 12, 2024. It is now read-only.
github-actions[bot] edited this page Aug 11, 2023 · 51 revisions

Class: Device

Hierarchy

  • ArcheTypeResource<Device>

    Device

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Device(bridge, data)

Parameters

Name Type
bridge Hue
data DeviceGet & { metadata: { archetype: ArcheType ; name: string } }

Inherited from

ArcheTypeResource<ResourceType.Device>.constructor

Defined in

src/structures/ArcheTypeResource.ts:15

Properties

data

data: DeviceGet & { metadata: { archetype: ArcheType ; name: string } }

Inherited from

ArcheTypeResource.data

Defined in

src/structures/ArcheTypeResource.ts:13


hue

Readonly hue: Hue

Inherited from

ArcheTypeResource.hue

Defined in

src/structures/Resource.ts:51


type

type: ResourceType = ResourceType.Device

Overrides

ArcheTypeResource.type

Defined in

src/structures/Device.ts:8

Accessors

archeType

get archeType(): ArcheType

Returns

ArcheType

Inherited from

ArcheTypeResource.archeType

Defined in

src/structures/ArcheTypeResource.ts:20


certified

get certified(): boolean

Returns

boolean

Defined in

src/structures/Device.ts:26


hardwarePlatformType

get hardwarePlatformType(): undefined | string

Returns

undefined | string

Defined in

src/structures/Device.ts:34


id

get id(): string

Returns

string

Inherited from

ArcheTypeResource.id

Defined in

src/structures/Resource.ts:56


identifier

get identifier(): ResourceIdentifier<ResourceType>

Returns

ResourceIdentifier<ResourceType>

Inherited from

ArcheTypeResource.identifier

Defined in

src/structures/Resource.ts:60


manager

get manager(): DeviceManager

Returns

DeviceManager

Overrides

ArcheTypeResource.manager

Defined in

src/structures/Device.ts:10


manufacturerName

get manufacturerName(): string

Returns

string

Defined in

src/structures/Device.ts:18


modelId

get modelId(): string

Returns

string

Defined in

src/structures/Device.ts:14


name

get name(): string

Returns

string

Inherited from

ArcheTypeResource.name

Defined in

src/structures/NamedResource.ts:20


productName

get productName(): string

Returns

string

Defined in

src/structures/Device.ts:22


serviceIds

get serviceIds(): string[]

Returns

string[]

Defined in

src/structures/Device.ts:38


softwareVersion

get softwareVersion(): string

Returns

string

Defined in

src/structures/Device.ts:30

Methods

_clone

_clone(): Device

Returns

Device

Inherited from

ArcheTypeResource._clone

Defined in

src/structures/Resource.ts:77


_patch

_patch(data): void

Parameters

Name Type
data Partial<DeviceGet>

Returns

void

Inherited from

ArcheTypeResource._patch

Defined in

src/structures/Resource.ts:73


_update

_update(data): Device

Parameters

Name Type
data Partial<DeviceGet>

Returns

Device

Inherited from

ArcheTypeResource._update

Defined in

src/structures/Resource.ts:81


delete

delete(): Promise<void>

Returns

Promise<void>

Defined in

src/structures/Device.ts:50


edit

edit(options): Promise<void>

Parameters

Name Type
options ArcheTypeResourceEditOptions

Returns

Promise<void>

Overrides

ArcheTypeResource.edit

Defined in

src/structures/Device.ts:46


identify

identify(): Promise<void>

Returns

Promise<void>

Defined in

src/structures/Device.ts:42


isType

isType<T>(type): this is NarrowResource<T>

Type parameters

Name Type
T extends ResourceType

Parameters

Name Type
type T

Returns

this is NarrowResource<T>

Inherited from

ArcheTypeResource.isType

Defined in

src/structures/Resource.ts:69


setArcheType

setArcheType(archeType): Promise<void>

Parameters

Name Type
archeType ArcheType

Returns

Promise<void>

Inherited from

ArcheTypeResource.setArcheType

Defined in

src/structures/ArcheTypeResource.ts:24


setName

setName(name): Promise<void>

Parameters

Name Type
name string

Returns

Promise<void>

Inherited from

ArcheTypeResource.setName

Defined in

src/structures/NamedResource.ts:28

hue.ts

Clone this wiki locally