ConsensusRegisterCollectionFactory Class

The factory that defines the consensus queue.

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

To use, import via @fluidframework/register-collection/legacy.

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

Signature

export declare class ConsensusRegisterCollectionFactory implements IChannelFactory<IConsensusRegisterCollection>

Implements: IChannelFactory<IConsensusRegisterCollection>

Static Properties

Property	Alerts	Modifiers	Type	Description
Attributes	Beta	readonly	IChannelAttributes
Type	Beta		string

Properties

Property	Alerts	Modifiers	Type	Description
attributes	Beta	readonly	IChannelAttributes
type	Beta	readonly	string

Methods

Method	Alerts	Return Type	Description
create(document, id)	Beta	IConsensusRegisterCollection
load(runtime, id, services, attributes)	Beta	Promise<IConsensusRegisterCollection>	Loads the given channel. This call is only ever invoked internally as the only thing that is ever directly loaded is the document itself. Load will then only be called on documents that were created and added to a channel.

Property Details

attributes

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 attributes(): IChannelAttributes;

Type: IChannelAttributes

Attributes

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

static readonly Attributes: IChannelAttributes;

Type: IChannelAttributes

type

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 type(): string;

Type: string

Type

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

static Type: string;

Type: string

Method Details

create

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

create(document: IFluidDataStoreRuntime, id: string): IConsensusRegisterCollection;

Parameters

Parameter	Type	Description
document	IFluidDataStoreRuntime
id	string

Returns

Return type: IConsensusRegisterCollection

load

Loads the given channel. This call is only ever invoked internally as the only thing that is ever directly loaded is the document itself. Load will then only be called on documents that were created and added to a channel.

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

load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;

Parameters

Parameter	Type	Description
runtime	IFluidDataStoreRuntime	Data store runtime containing state/info/helper methods about the data store.
id	string	ID of the channel.
services	IChannelServices	Services to read objects at a given path using the delta connection.
attributes	IChannelAttributes

Returns

The loaded object

Return type: Promise<IConsensusRegisterCollection>