Skip to main content
Version: v1

IConsensusOrderedCollectionFactory Interface

Consensus Ordered Collection channel factory interface

Extends the base IChannelFactory to return a more definite type of IConsensusOrderedCollection Use for the runtime to create and load distributed data structure by type name of each channel

Signature

export interface IConsensusOrderedCollectionFactory extends IChannelFactory

Extends: IChannelFactory

Methods

MethodReturn TypeDescription
create(document, id)IConsensusOrderedCollection
load(document, id, services, attributes)Promise<IConsensusOrderedCollection>

Method Details

create

Signature

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

Parameters

ParameterTypeDescription
documentIFluidDataStoreRuntime
idstring

Returns

Return type: IConsensusOrderedCollection

load

Signature

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

Parameters

ParameterTypeDescription
documentIFluidDataStoreRuntime
idstring
servicesIChannelServices
attributesIChannelAttributes

Returns

Return type: Promise<IConsensusOrderedCollection>