_controller_model_group_.group.md

zigbee-herdsman › "controller/model/group" › Group

Class: Group

Hierarchy

• Entity

  ↳ Group

Index

Properties

• groupID
• meta

Accessors

• members

Methods

• addMember
• command
• hasMember
• removeFromDatabase
• removeMember
• save
• all
• byGroupID
• create
• injectAdapter
• injectDatabase

Properties

groupID

• groupID: number

Defined in controller/model/group.ts:11

---

meta

• meta: KeyValue

Defined in controller/model/group.ts:15

Accessors

members

• get members(): Endpoint[]

Defined in controller/model/group.ts:13

Returns: Endpoint[]

Methods

addMember

▸ addMember(endpoint: Endpoint): void

Defined in controller/model/group.ts:100

Parameters:

Name	Type
endpoint	Endpoint

Returns: void

---

command

▸ command(clusterKey: number | string, commandKey: number | string, payload: KeyValue): Promise‹void›

Defined in controller/model/group.ts:118

Parameters:

Name	Type
clusterKey	number | string
commandKey	number | string
payload	KeyValue

Returns: Promise‹void›

---

hasMember

▸ hasMember(endpoint: Endpoint): boolean

Defined in controller/model/group.ts:110

Parameters:

Name	Type
endpoint	Endpoint

Returns: boolean

---

removeFromDatabase

▸ removeFromDatabase(): void

Defined in controller/model/group.ts:90

Returns: void

---

removeMember

▸ removeMember(endpoint: Endpoint): void

Defined in controller/model/group.ts:105

Parameters:

Name	Type
endpoint	Endpoint

Returns: void

---

save

▸ save(): void

Defined in controller/model/group.ts:96

Returns: void

---

Static all

▸ all(): Group[]

Defined in controller/model/group.ts:70

Returns: Group[]

---

Static byGroupID

▸ byGroupID(groupID: number): Group

Defined in controller/model/group.ts:65

Parameters:

Name	Type
groupID	number

Returns: Group

---

Static create

▸ create(groupID: number): Group

Defined in controller/model/group.ts:75

Parameters:

Name	Type
groupID	number

Returns: Group

---

Static injectAdapter

▸ injectAdapter(adapter: Adapter): void

Inherited from void

Defined in controller/model/entity.ts:12

Parameters:

Name	Type
adapter	Adapter

Returns: void

---

Static injectDatabase

▸ injectDatabase(database: Database): void

Inherited from void

Defined in controller/model/entity.ts:8

Parameters:

Name	Type
database	Database

Returns: void