SharedIntervalCollection Class

This API is deprecated and will be removed in a future release.

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

Signature

export declare class SharedIntervalCollection extends SharedObject implements ISharedIntervalCollection<Interval>

Extends: SharedObject

Implements: ISharedIntervalCollection<Interval

Constructors

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

Static Methods

Method	Return Type	Description
create(runtime, id)	SharedIntervalCollection	Create a SharedIntervalCollection
getFactory()	IChannelFactory	Get a factory for SharedIntervalCollection to register with the data store.

Properties

Property	Type	Description
[Symbol.toStringTag]	string

Methods

Method	Alerts	Return Type	Description
applyStashedOp()		void
getIntervalCollection(label)		IntervalCollection<Interval>
getIntervalCollectionPath(label)		string	Creates the full path of the intervalCollection label
loadCore(storage)		Promise<void>
onDisconnect()		void
processCore(message, local, localOpMetadata)		void
reSubmitCore(content, localOpMetadata)		void
summarizeCore(serializer)		ISummaryTreeWithStats
waitIntervalCollection(label)	Deprecated	Promise<IntervalCollection<Interval>>

Constructor Details

(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

Parameter	Type	Description
id	string
runtime	IFluidDataStoreRuntime
attributes	IChannelAttributes

Property Details

[Symbol.toStringTag]

Signature

readonly [Symbol.toStringTag]: string;

Type: string

Method Details

applyStashedOp

Signature

protected applyStashedOp(): void;

create

Create a SharedIntervalCollection

Signature

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

Parameters

Parameter	Modifiers	Type	Description
runtime		IFluidDataStoreRuntime	data store runtime the new shared map belongs to
id	optional	string	optional name of the shared map

Returns

newly create shared map (but not attached yet)

Return type: SharedIntervalCollection

getFactory

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

Signature

static getFactory(): IChannelFactory;

Returns

a factory that creates and load SharedIntervalCollection

Return type: IChannelFactory

getIntervalCollection

Signature

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

Parameters

Parameter	Type	Description
label	string

Returns

Return type: IntervalCollection<Interval>

getIntervalCollectionPath

Creates the full path of the intervalCollection label

Signature

protected getIntervalCollectionPath(label: string): string;

Parameters

Parameter	Type	Description
label	string	the incoming label

Returns

Return type: string

loadCore

Signature

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

Parameters

Parameter	Type	Description
storage	IChannelStorageService

Returns

Return type: Promise<void>

onDisconnect

Signature

protected onDisconnect(): void;

processCore

Signature

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

Parameters

Parameter	Type	Description
message	ISequencedDocumentMessage
local	boolean
localOpMetadata	unknown

reSubmitCore

Signature

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

Parameters

Parameter	Type	Description
content	any
localOpMetadata	unknown

summarizeCore

Signature

protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;

Parameters

Parameter	Type	Description
serializer	IFluidSerializer

Returns

Return type: ISummaryTreeWithStats

waitIntervalCollection

This API is deprecated and will be removed in a future release.

• 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

Parameter	Type	Description
label	string

Returns

Return type: Promise<IntervalCollection<Interval>>