SharedObjectSequence Class

Packages > fluid-framework > SharedObjectSequence

Deprecated

SharedObjectSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

The SharedObjectSequence holds a sequence of serializable objects. Each object will be stored at a position within the sequence. See the sequence documentation for details on working with sequences.

Signature:

export declare class SharedObjectSequence<T> extends SharedSequence<T> 

Extends: SharedSequence

Type parameters:

T

Constructors

List of constructors for this class
Constructor Modifiers Description
(constructor)(document, id, attributes) Constructs a new instance of the SharedObjectSequence class

Properties

List of properties for this class
Property Modifiers Type Description
id

Methods

List of methods on this class
Method Modifiers Description
create(runtime, id) static Create a new shared object sequence
getFactory() static Get a factory for SharedObjectSequence to register with the data store.
getRange(start, end)

Constructors

SharedObjectSequence.(constructor)

Deprecated

SharedObjectSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

Constructs a new instance of the SharedObjectSequence class

Signature:

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

Parameters

List of parameters
Parameter Type Description
document
id
attributes

Properties

id

Signature:

id: string;

Methods

create

Deprecated

SharedObjectSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

Create a new shared object sequence

Signature:

static create<T>(runtime: IFluidDataStoreRuntime, id?: string): SharedObjectSequence<T>;

Parameters

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

Returns:

SharedObjectSequence

newly create shared object sequence (but not attached yet)

getFactory

Deprecated

SharedObjectSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

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

Signature:

static getFactory(): SharedObjectSequenceFactory;

Returns:

SharedObjectSequenceFactory

a factory that creates and load SharedObjectSequence

getRange

Deprecated

SharedObjectSequence is not recommended for use and will be removed in an upcoming release. For more info, please see [Github issue 8526](https://github.com/microsoft/FluidFramework/issues/8526)

Signature:

getRange(start: number, end?: number): Serializable<T>[];

Parameters

List of parameters
Parameter Type Description
start
end

Returns: