Class Roles

Role is the interface for working with Roles over the AppDaemon query RPC.

Generated

From ts-rpcdb.ts.tmpl

Hierarchy

Roles

Index

Constructors

Properties

Methods

delete get list listByNodeID put query

Constructors

constructor

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

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 Role with the given ID.
Parameters
- id: string
  The name of the role.
Returns Promise<void>
- Defined in utils/rpcdb.ts:412

get

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

list

list(): Promise<Role[]>
Returns all Roles.

Returns Promise<Role[]>
All Roles known to the AppDaemon.
- Defined in utils/rpcdb.ts:435

listByNodeID

listByNodeID(nodeid): Promise<Role[]>
Returns the Roles with the given nodeid.
Parameters
- nodeid: string
  The ID of the node
Returns Promise<Role[]>
Any Roles found with the given nodeid.
- Defined in utils/rpcdb.ts:458

put

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

`Private` query

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

Generated using TypeDoc