SharedIntervalCollection Class

Packages > fluid-framework > SharedIntervalCollection

Deprecated

  • SharedIntervalCollection is not maintained and is planned to be removed.

Signature:

export declare class SharedIntervalCollection extends SharedObject implements ISharedIntervalCollection<Interval> 

Extends:

Implements: ISharedIntervalCollectionInterval

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(id, runtime, attributes) Constructs a new shared SharedIntervalCollection. If the object is non-local an id and service interfaces will be provided

Properties

List of properties for this class
Property Modifiers Type Description
[Symbol.toStringTag]

Methods

List of methods on this class
Method Modifiers Description
applyStashedOp()
create(runtime, id) static Create a SharedIntervalCollection
getFactory() static Get a factory for SharedIntervalCollection to register with the data store.
getIntervalCollection(label)
getIntervalCollectionPath(label) Creates the full path of the intervalCollection label
loadCore(storage)
onDisconnect()
processCore(message, local, localOpMetadata)
reSubmitCore(content, localOpMetadata)
summarizeCore(serializer)
waitIntervalCollection(label)

Constructors

SharedIntervalCollection.(constructor)

Constructs a new shared SharedIntervalCollection. If the object is non-local an id and service interfaces will be provided

Signature:

constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);

Parameters

List of parameters
Parameter Type Description
id
runtime
attributes

Properties

[Symbol.toStringTag]

Signature:

readonly [Symbol.toStringTag]: string;

Methods

applyStashedOp

Signature:

protected applyStashedOp(): void;

Returns:

create

Create a SharedIntervalCollection

Signature:

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

Parameters

List of parameters
Parameter Type Description
runtime data store runtime the new shared map belongs to
id optional name of the shared map

Returns:

SharedIntervalCollection

newly create shared map (but not attached yet)

getFactory

Get a factory for SharedIntervalCollection to register with the data store.

Signature:

static getFactory(): IChannelFactory;

Returns:

a factory that creates and load SharedIntervalCollection

getIntervalCollection

Signature:

getIntervalCollection(label: string): IntervalCollection<Interval>;

Parameters

List of parameters
Parameter Type Description
label

Returns:

IntervalCollectionInterval

getIntervalCollectionPath

Creates the full path of the intervalCollection label

Signature:

protected getIntervalCollectionPath(label: string): string;

Parameters

List of parameters
Parameter Type Description
label the incoming label

Returns:

loadCore

Signature:

protected loadCore(storage: IChannelStorageService): Promise<void>;

Parameters

List of parameters
Parameter Type Description
storage

Returns:

onDisconnect

Signature:

protected onDisconnect(): void;

Returns:

processCore

Signature:

protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;

Parameters

List of parameters
Parameter Type Description
message
local
localOpMetadata

Returns:

reSubmitCore

Signature:

protected reSubmitCore(content: any, localOpMetadata: unknown): void;

Parameters

List of parameters
Parameter Type Description
content
localOpMetadata

Returns:

summarizeCore

Signature:

protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;

Parameters

List of parameters
Parameter Type Description
serializer

Returns:

waitIntervalCollection

Deprecated

  • IntervalCollections are created on a first-write wins basis, and concurrent creates are supported. Use getIntervalCollection instead.

Signature:

waitIntervalCollection(label: string): Promise<IntervalCollection<Interval>>;

Parameters

List of parameters
Parameter Type Description
label

Returns:

IntervalCollectionInterval