SharedObjectSequence Class
Packages > @fluidframework/sequence > SharedObjectSequence
Signature:
export declare class SharedObjectSequence<T> extends SharedSequence<T>
Extends: SharedSequence<T>
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(document, id, attributes) | Constructs a new instance of the SharedObjectSequence class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
id | string |
Methods
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
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
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:
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:
a factory that creates and load SharedObjectSequence
getRange
Signature:
getRange(start: number, end?: number): T[];
Parameters
Parameter | Type | Description |
---|---|---|
start | number | |
end | number |
Returns:
T[]