SharedObjectSequence Class

Packages > @fluidframework/sequence > SharedObjectSequence

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

Signature:

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

Extends: SharedSequence<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 string

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)

Constructs a new instance of the SharedObjectSequence class

Signature:

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

Parameters

List of parameters
Parameter Type Description
document IFluidDataStoreRuntime
id string
attributes IChannelAttributes

Properties

id

Signature:

id: string;

Methods

create

Create a new shared object sequence

Signature:

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

Parameters

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

Returns:

SharedObjectSequence<T>

newly create shared object sequence (but not attached yet)

getFactory

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

Signature:

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

Parameters

List of parameters
Parameter Type Description
start number
end number

Returns:

T[]