IConsensusRegisterCollectionFactory Interface
Consensus Register Collection channel factory interface
Extends the base IChannelFactory to return a more definite type of IConsensusRegisterCollection Use for the runtime to create and load distributed data structure by type name of each channel
Signature
export interface IConsensusRegisterCollectionFactory extends IChannelFactory
Extends: IChannelFactory
Methods
| Method | Return Type | Description |
|---|---|---|
| create(document, id) | IConsensusRegisterCollection | |
| load(document, id, services, attributes) | 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. |
Method Details
create
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.
Signature
load(document: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<IConsensusRegisterCollection>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| document | IFluidDataStoreRuntime | |
| 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>