SharedObjectSequenceFactory 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

export declare class SharedObjectSequenceFactory implements IChannelFactory

Implements: IChannelFactory

Static Properties

Property	Alerts	Type	Description
Attributes	Deprecated	IChannelAttributes
Type	Deprecated	string

Static Methods

Method	Alerts	Return Type	Description
segmentFromSpec(segSpec)	Deprecated	SubSequence<object>

Properties

Property	Alerts	Type	Description
attributes	Deprecated	IChannelAttributes
type	Deprecated	string

Methods

Method	Alerts	Return Type	Description
create(document, id)	Deprecated	ISharedObject
load(runtime, id, services, attributes)	Deprecated	Promise<ISharedObject>	Loads the given channel. This call is only ever invoked internally as the only thing that is ever directly loaded is the document itself. Load will then only be called on documents that were created and added to a channel.

Property Details

attributes

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

get attributes(): IChannelAttributes;

Type: IChannelAttributes

Attributes

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 readonly Attributes: IChannelAttributes;

Type: IChannelAttributes

type

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

get type(): string;

Type: string

Type

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 Type: string;

Type: string

Method Details

create

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

create(document: IFluidDataStoreRuntime, id: string): ISharedObject;

Parameters

Parameter	Type	Description
document	IFluidDataStoreRuntime
id	string

Returns

Return type: ISharedObject

load

Loads the given channel. This call is only ever invoked internally as the only thing that is ever directly loaded is the document itself. Load will then only be called on documents that were created and added to a channel.

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

load(runtime: IFluidDataStoreRuntime, id: string, services: IChannelServices, attributes: IChannelAttributes): Promise<ISharedObject>;

Parameters

Parameter	Type	Description
runtime	IFluidDataStoreRuntime	Data store runtime containing state/info/helper methods about the data store.
id	string	ID of the channel.
services	IChannelServices	Services to read objects at a given path using the delta connection.
attributes	IChannelAttributes

Returns

The loaded object

Return type: Promise<ISharedObject>

segmentFromSpec

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 segmentFromSpec(segSpec: IJSONSegment): SubSequence<object>;

Parameters

Parameter	Type	Description
segSpec	IJSONSegment

Returns

Return type: SubSequence<object>