Interface: UseAgentApprovalsResult
@roomful/vue / UseAgentApprovalsResult
Interface: UseAgentApprovalsResult
Section titled “Interface: UseAgentApprovalsResult”Defined in: vue/src/index.ts:415
Describes the return value of useAgentApprovals.
Properties
Section titled “Properties”approve()
Section titled “approve()”approve: (
id) =>void
Defined in: vue/src/index.ts:431
Approves a pending proposal (if permitted) and broadcasts the decision.
Approves a pending proposal (if permitted) and broadcasts the decision.
Parameters
Section titled “Parameters”string
The proposal id.
Returns
Section titled “Returns”void
pending
Section titled “pending”pending:
ComputedRef<AgentProposal[]>
Defined in: vue/src/index.ts:426
Exposes the proposals still awaiting a decision, newest first. Reactive:
derived from proposals.
proposals
Section titled “proposals”proposals:
ReadonlyRef<AgentProposal[]>
Defined in: vue/src/index.ts:420
Exposes every proposal, newest first. Reactive: updates on any local or remote change.
propose()
Section titled “propose()”propose: (
input) =>AgentProposal
Defined in: vue/src/index.ts:441
Proposes an action for approval and broadcasts it as pending.
Proposes an action for approval and broadcasts it to peers as pending.
Parameters
Section titled “Parameters”The action type and optional payload.
payload?
Section titled “payload?”unknown
string
Returns
Section titled “Returns”AgentProposal
The created proposal.
reject()
Section titled “reject()”reject: (
id) =>void
Defined in: vue/src/index.ts:436
Rejects a pending proposal (if permitted) and broadcasts the decision.
Rejects a pending proposal (if permitted) and broadcasts the decision.
Parameters
Section titled “Parameters”string
The proposal id.
Returns
Section titled “Returns”void