IQuorumProposals Interface

Interface for tracking proposals in the Quorum.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/driver-definitions/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IQuorumProposals

Properties

Property	Alerts	Type	Description
off	Beta	IQuorumProposals["on"]
once	Beta	IQuorumProposals["on"]

Methods

Method	Alerts	Return Type	Description
get(key)	Beta	unknown
has(key)	Beta	boolean
on(event, listener)	Beta	any
on(event, listener)	Beta	any
on(event, listener)	Beta	void
propose(key, value)	Beta	Promise<void>

Property Details

off

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

off: IQuorumProposals["on"];

Type: IQuorumProposals["on"]

once

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

once: IQuorumProposals["on"];

Type: IQuorumProposals["on"]

Method Details

get

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

get(key: string): unknown;

Parameters

Parameter	Type	Description
key	string

Returns

Return type: unknown

has

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

has(key: string): boolean;

Parameters

Parameter	Type	Description
key	string

Returns

Return type: boolean

on

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

on(event: "addProposal", listener: (proposal: ISequencedProposal) => void): any;

Parameters

Parameter	Type	Description
event	"addProposal"
listener	(proposal: ISequencedProposal) => void

Returns

Return type: any

on

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

on(event: "approveProposal", listener: (sequenceNumber: number, key: string, value: unknown, approvalSequenceNumber: number) => void): any;

Parameters

Parameter	Type	Description
event	"approveProposal"
listener	(sequenceNumber: number, key: string, value: unknown, approvalSequenceNumber: number) => void

Returns

Return type: any

on

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

on(event: "error", listener: (message: any) => void): void;

Parameters

Parameter	Type	Description
event	"error"
listener	(message: any) => void

propose

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

propose(key: string, value: unknown): Promise<void>;

Parameters

Parameter	Type	Description
key	string
value	unknown

Returns

Return type: Promise<void>