Class Groups

Group is the interface for working with Groups over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

Hierarchy

Groups

Index

Constructors

Properties

Methods

delete get list put query

Constructors

constructor

new Groups(client, connID): Groups
Parameters
- client: AppDaemonQuerier
  The client to use for RPC calls.
- connID: string
  The connection ID to use for RPC calls.
Returns Groups
- Defined in utils/rpcdb.ts:641

Properties

`Private` `Readonly` client

client: AppDaemonQuerier

The client to use for RPC calls.

`Private` `Readonly` connID

connID: string

The connection ID to use for RPC calls.

Methods

delete

delete(id): Promise<void>
Deletes the Group with the given ID.
Parameters
- id: string
  The name of the group.
Returns Promise<void>
- Defined in utils/rpcdb.ts:698

get

get(id): Promise<Group>
Returns the Group with the given ID.
Parameters
- id: string
  The name of the group.
Returns Promise<Group>
The Group with the given ID.
- Defined in utils/rpcdb.ts:675

list

list(): Promise<Group[]>
Returns all Groups.

Returns Promise<Group[]>
All Groups known to the AppDaemon.
- Defined in utils/rpcdb.ts:721

put

put(obj): Promise<void>
Puts the given Group.
Parameters
- obj: Group
  The Group to put into the mesh storage.
Returns Promise<void>
- Defined in utils/rpcdb.ts:743

`Private` query

query(query): Promise<QueryResponse>
Queries the AppDaemon for Groups.
Parameters
- query: QueryRequest
  The query to run.
Returns Promise<QueryResponse>
The results of the query.
- Defined in utils/rpcdb.ts:652

Generated using TypeDoc