-
Notifications
You must be signed in to change notification settings - Fork 1
Device
-
ArcheTypeResource
<Device
>↳
Device
- archeType
- certified
- hardwarePlatformType
- id
- identifier
- manager
- manufacturerName
- modelId
- name
- productName
- serviceIds
- softwareVersion
• new Device(bridge
, data
)
Name | Type |
---|---|
bridge |
Hue |
data |
DeviceGet & { metadata : { archetype : ArcheType ; name : string } } |
ArcheTypeResource<ResourceType.Device>.constructor
src/structures/ArcheTypeResource.ts:15
• data: DeviceGet
& { metadata
: { archetype
: ArcheType
; name
: string
} }
ArcheTypeResource.data
src/structures/ArcheTypeResource.ts:13
• Readonly
hue: Hue
ArcheTypeResource.hue
• type: ResourceType
= ResourceType.Device
ArcheTypeResource.type
• get
archeType(): ArcheType
ArcheTypeResource.archeType
src/structures/ArcheTypeResource.ts:20
• get
certified(): boolean
boolean
• get
hardwarePlatformType(): undefined
| string
undefined
| string
• get
id(): string
string
ArcheTypeResource.id
• get
identifier(): ResourceIdentifier
<ResourceType
>
ResourceIdentifier
<ResourceType
>
ArcheTypeResource.identifier
• get
manager(): DeviceManager
ArcheTypeResource.manager
• get
manufacturerName(): string
string
• get
modelId(): string
string
• get
name(): string
string
ArcheTypeResource.name
src/structures/NamedResource.ts:20
• get
productName(): string
string
• get
serviceIds(): string
[]
string
[]
• get
softwareVersion(): string
string
▸ _clone(): Device
ArcheTypeResource._clone
▸ _patch(data
): void
Name | Type |
---|---|
data |
Partial <DeviceGet > |
void
ArcheTypeResource._patch
▸ _update(data
): Device
Name | Type |
---|---|
data |
Partial <DeviceGet > |
ArcheTypeResource._update
▸ delete(): Promise
<void
>
Promise
<void
>
▸ edit(options
): Promise
<void
>
Name | Type |
---|---|
options |
ArcheTypeResourceEditOptions |
Promise
<void
>
ArcheTypeResource.edit
▸ identify(): Promise
<void
>
Promise
<void
>
▸ isType<T
>(type
): this is NarrowResource<T>
Name | Type |
---|---|
T |
extends ResourceType
|
Name | Type |
---|---|
type |
T |
this is NarrowResource<T>
ArcheTypeResource.isType
▸ setArcheType(archeType
): Promise
<void
>
Name | Type |
---|---|
archeType |
ArcheType |
Promise
<void
>
ArcheTypeResource.setArcheType
src/structures/ArcheTypeResource.ts:24
▸ setName(name
): Promise
<void
>
Name | Type |
---|---|
name |
string |
Promise
<void
>
ArcheTypeResource.setName