SharedNumberSequence Class

The SharedNumberSequence holds a sequence of numbers. Each number 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.

SharedNumberSequence 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 SharedNumberSequence extends SharedSequence<number>

Extends: SharedSequence

Constructors

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

Static Methods

Method	Alerts	Return Type	Description
create(runtime, id)	Deprecated	SharedNumberSequence	Create a new shared number sequence
getFactory()	Deprecated	SharedNumberSequenceFactory	Get a factory for SharedNumberSequence to register with the data store.

Properties

Property	Type	Description
id	string

Methods

Method	Alerts	Return Type	Description
getRange(start, end)	Deprecated	number[]

Constructor Details

(constructor)

Constructs a new instance of the SharedNumberSequence class

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

SharedNumberSequence 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 number sequence

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

SharedNumberSequence 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(runtime: IFluidDataStoreRuntime, id?: string): SharedNumberSequence;

Parameters

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

Returns

newly create shared number sequence (but not attached yet)

Return type: SharedNumberSequence

getFactory

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

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

SharedNumberSequence 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(): SharedNumberSequenceFactory;

Returns

a factory that creates and load SharedNumberSequence

Return type: SharedNumberSequenceFactory

getRange

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

SharedNumberSequence 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): number[];

Parameters

Parameter	Modifiers	Type	Description
start		number
end	optional	number

Returns

Return type: number[]