Skip to content

GroupedLight

github-actions[bot] edited this page Aug 11, 2023 · 51 revisions

Class: GroupedLight

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new GroupedLight(hue, data)

Parameters

Name Type
hue Hue
data GroupedLightGet

Inherited from

Resource.constructor

Defined in

src/structures/Resource.ts:64

Properties

data

data: GroupedLightGet

Inherited from

Resource.data

Defined in

src/structures/Resource.ts:54


hue

Readonly hue: Hue

Inherited from

Resource.hue

Defined in

src/structures/Resource.ts:51


type

type: ResourceType = ResourceType.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:56


identifier

get identifier(): ResourceIdentifier<ResourceType>

Returns

ResourceIdentifier<ResourceType>

Inherited from

Resource.identifier

Defined in

src/structures/Resource.ts:60


manager

get manager(): GroupedLightManager

Returns

GroupedLightManager

Overrides

Resource.manager

Defined in

src/structures/GroupedLight.ts:16


ownerId

get ownerId(): string

Returns

string

Defined in

src/structures/GroupedLight.ts:20

Methods

_clone

_clone(): GroupedLight

Returns

GroupedLight

Inherited from

Resource._clone

Defined in

src/structures/Resource.ts:77


_patch

_patch(data): void

Parameters

Name Type
data Partial<GroupedLightGet>

Returns

void

Inherited from

Resource._patch

Defined in

src/structures/Resource.ts:73


_update

_update(data): GroupedLight

Parameters

Name Type
data Partial<GroupedLightGet>

Returns

GroupedLight

Inherited from

Resource._update

Defined in

src/structures/Resource.ts:81


edit

edit(options): Promise<void>

Parameters

Name Type
options GroupedLightEditOptions

Returns

Promise<void>

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 ResourceType

Parameters

Name Type
type T

Returns

this is NarrowResource<T>

Inherited from

Resource.isType

Defined in

src/structures/Resource.ts:69


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


setColor

setColor(color): Promise<void>

Parameters

Name Type
color undefined | XyPoint

Returns

Promise<void>

Defined in

src/structures/GroupedLight.ts:52


setMirek

setMirek(mirek): Promise<void>

Parameters

Name Type
mirek undefined | number

Returns

Promise<void>

Defined in

src/structures/GroupedLight.ts:48


toggle

toggle(): Promise<void>

Returns

Promise<void>

Defined in

src/structures/GroupedLight.ts:40

hue.ts

Clone this wiki locally