Skip to main content
Version: v1

SharedObjectSequence Class

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.

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

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​

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

Extends: SharedSequence

Type Parameters​

Parameter Description
T

Constructors​

Constructor Alerts Description
(constructor)(document, id, attributes) Deprecated Constructs a new instance of the SharedObjectSequence class

Static Methods​

Method Alerts Return Type Description
create(runtime, id) Deprecated SharedObjectSequence<T> Create a new shared object sequence
getFactory() Deprecated SharedObjectSequenceFactory Get a factory for SharedObjectSequence to register with the data store.

Properties​

Property Type Description
id string

Methods​

Method Alerts Return Type Description
getRange(start, end) Deprecated Serializable<T>[]

Constructor Details​

(constructor)​

Constructs a new instance of the SharedObjectSequence class

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

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​

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

Parameters​

Parameter Type Description
document IFluidDataStoreRuntime
id string
attributes IChannelAttributes

Property Details​

id​

Signature​

id: string;

Type: string

Method Details​

create​

Create a new shared object sequence

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

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​

static create<T>(runtime: IFluidDataStoreRuntime, id?: string): SharedObjectSequence<T>;
Type Parameters​
Parameter Description
T

Parameters​

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

Returns​

newly create shared object sequence (but not attached yet)

Return type: SharedObjectSequence<T>

getFactory​

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

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

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​

static getFactory(): SharedObjectSequenceFactory;

Returns​

a factory that creates and load SharedObjectSequence

Return type: SharedObjectSequenceFactory

getRange​

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

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​

Parameter Modifiers Type Description
start number
end optional number

Returns​

Return type: Serializable<T>[]