Interface: UseAgentApprovalsResult
@roomful/react / UseAgentApprovalsResult
Interface: UseAgentApprovalsResult
Section titled “Interface: UseAgentApprovalsResult”Defined in: react/src/index.ts:378
Describes the return value of useAgentApprovals.
Properties
Section titled “Properties”approve()
Section titled “approve()”approve: (
id) =>void
Defined in: react/src/index.ts:392
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:
AgentProposal[]
Defined in: react/src/index.ts:387
The proposals still awaiting a decision, newest first.
proposals
Section titled “proposals”proposals:
AgentProposal[]
Defined in: react/src/index.ts:382
Every proposal, newest first. Reactive: re-renders on any local or remote change.
propose()
Section titled “propose()”propose: (
input) =>AgentProposal
Defined in: react/src/index.ts:402
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: react/src/index.ts:397
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