GroupedLight

Class: GroupedLight

Hierarchy

• Resource<GroupedLight>

  ↳ GroupedLight

Table of contents

Constructors

• constructor

Properties

• bridge
• data
• type

Accessors

• brightness
• id
• identifier
• owner
• ownerIdentifier

Methods

• _clone
• _patch
• _put
• _update
• edit
• isOn
• isType
• off
• on
• setBrightness
• setMirek
• setXy
• toggle

Constructors

constructor

• new GroupedLight(bridge, data)

Parameters

Name	Type
bridge	Bridge
data	ApiGroupedLightGet

Inherited from

Resource.constructor

Defined in

src/structures/Resource.ts:60

Properties

bridge

• Readonly bridge: Bridge

Inherited from

Resource.bridge

Defined in

src/structures/Resource.ts:48

---

data

• data: ApiGroupedLightGet

Inherited from

Resource.data

Defined in

src/structures/Resource.ts:50

---

type

• type: ApiResourceType = ApiResourceType.GroupedLight

Overrides

Resource.type

Defined in

src/structures/GroupedLight.ts:14

Accessors

brightness

• get brightness(): undefined | number

Returns

undefined | number

Defined in

src/structures/GroupedLight.ts:28

---

id

• get id(): string

Returns

string

Inherited from

Resource.id

Defined in

src/structures/Resource.ts:52

---

identifier

• get identifier(): ResourceIdentifier<ApiResourceType>

Returns

ResourceIdentifier<ApiResourceType>

Inherited from

Resource.identifier

Defined in

src/structures/Resource.ts:56

---

owner

• get owner(): NarrowResource<ApiResourceType>

Returns

NarrowResource<ApiResourceType>

Defined in

src/structures/GroupedLight.ts:16

---

ownerIdentifier

• get ownerIdentifier(): ResourceIdentifier<ApiResourceType>

Returns

ResourceIdentifier<ApiResourceType>

Defined in

src/structures/GroupedLight.ts:20

Methods

_clone

▸ _clone(): GroupedLight

Returns

GroupedLight

Inherited from

Resource._clone

Defined in

src/structures/Resource.ts:73

---

_patch

▸ _patch(data): void

Parameters

Name	Type
data	Partial<ApiGroupedLightGet>

Returns

void

Inherited from

Resource._patch

Defined in

src/structures/Resource.ts:69

---

_put

▸ Protected _put(data): Promise<void>

Parameters

Name	Type
data	ApiGroupedLightPut

Returns

Promise<void>

Inherited from

Resource._put

Defined in

src/structures/Resource.ts:83

---

_update

▸ _update(data): GroupedLight

Parameters

Name	Type
data	Partial<ApiGroupedLightGet>

Returns

GroupedLight

Inherited from

Resource._update

Defined in

src/structures/Resource.ts:77

---

edit

▸ edit(options): Promise<void>

Parameters

Name	Type
options	GroupedLightEditOptions

Returns

Promise<void>

Overrides

Resource.edit

Defined in

src/structures/GroupedLight.ts:56

---

isOn

▸ isOn(): undefined | boolean

Returns

undefined | boolean

Defined in

src/structures/GroupedLight.ts:24

---

isType

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

Type parameters

Name	Type
T	extends ApiResourceType

Parameters

Name	Type
type	T

Returns

this is NarrowResource<T>

Inherited from

Resource.isType

Defined in

src/structures/Resource.ts:65

---

off

▸ off(): Promise<void>

Returns

Promise<void>

Defined in

src/structures/GroupedLight.ts:36

---

on

▸ on(): Promise<void>

Returns

Promise<void>

Defined in

src/structures/GroupedLight.ts:32

---

setBrightness

▸ setBrightness(brightness): Promise<void>

Parameters

Name	Type
brightness	undefined | number

Returns

Promise<void>

Defined in

src/structures/GroupedLight.ts:44

---

setMirek

▸ setMirek(mirek): Promise<void>

Parameters

Name	Type
mirek	undefined | number

Returns

Promise<void>

Defined in

src/structures/GroupedLight.ts:48

---

setXy

▸ setXy(xy): Promise<void>

Parameters

Name	Type
xy	undefined | XyPoint

Returns

Promise<void>

Defined in

src/structures/GroupedLight.ts:52

---

toggle

▸ toggle(): Promise<void>

Returns

Promise<void>

Defined in

src/structures/GroupedLight.ts:40