SharedIntervalCollectionFactory Class

Packages > @fluidframework/sequence > SharedIntervalCollectionFactory

The factory that defines the SharedIntervalCollection

Signature:

export declare class SharedIntervalCollectionFactory implements IChannelFactory 

Implements: IChannelFactory

Properties

List of properties for this class
Property Modifiers Type Description
attributes IChannelAttributes
Attributes static IChannelAttributes
type string
Type static (not declared)

Methods

List of methods on this class
Method Modifiers Description
create(runtime, id)
load(runtime, id, services, attributes) 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.

Properties

attributes

Signature:

get attributes(): IChannelAttributes;

Attributes

Signature:

static readonly Attributes: IChannelAttributes;

type

Signature:

get type(): string;

Type

Signature:

static readonly Type = "https://graph.microsoft.com/types/sharedIntervalCollection";

Methods

create

Signature:

create(runtime: IFluidDataStoreRuntime, id: string): SharedIntervalCollection;

Parameters

List of parameters
Parameter Type Description
runtime IFluidDataStoreRuntime
id string

Returns:

SharedIntervalCollection

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(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<SharedIntervalCollection>;

Parameters

List of 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:

Promise<SharedIntervalCollection>

The loaded object