DataObjectFactoryProps Interface

Represents the properties required to create a DataObjectFactory. This includes the type identifier, constructor, shared objects, optional providers, registry entries, and the runtime class to use for the data object.

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/aqueduct/legacy.

For more information about our API support guarantees, see here.

Signature

export interface DataObjectFactoryProps<TObj extends PureDataObject<I>, I extends DataObjectTypes = DataObjectTypes>

Type Parameters

Parameter	Constraint	Default	Description
TObj	PureDataObject<I>		DataObject (concrete type)
I	DataObjectTypes	DataObjectTypes	The input types for the DataObject

Properties

Property	Alerts	Modifiers	Type	Description
ctor	Alpha	readonly	new (props: IDataObjectProps<I>) => TObj	The constructor for the data object.
optionalProviders	Alpha	optional, readonly	FluidObjectSymbolProvider<I["OptionalProviders"]>	Optional providers for dependency injection.
policies	Alpha	optional, readonly	Partial<IFluidDataStorePolicies>	Optional policies that can be applied to the DataObject. These policies define specific behaviors or constraints for the data object.
registryEntries	Alpha	optional, readonly	NamedFluidDataStoreRegistryEntries	Registry entries for named data stores.
runtimeClass	Alpha	optional, readonly	typeof FluidDataStoreRuntime	The runtime class to use for the data object.
sharedObjects	Alpha	optional, readonly	readonly IChannelFactory[]	The shared objects (DDSes) to be registered with the data object.
type	Alpha	readonly	string	The type identifier for the data object factory.

Property Details

ctor

The constructor for the data object.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly ctor: new (props: IDataObjectProps<I>) => TObj;

Type: new (props: IDataObjectProps<I>) => TObj

optionalProviders

Optional providers for dependency injection.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly optionalProviders?: FluidObjectSymbolProvider<I["OptionalProviders"]>;

Type: FluidObjectSymbolProvider<I["OptionalProviders"]>

policies

Optional policies that can be applied to the DataObject. These policies define specific behaviors or constraints for the data object.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly policies?: Partial<IFluidDataStorePolicies>;

Type: Partial<IFluidDataStorePolicies>

registryEntries

Registry entries for named data stores.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly registryEntries?: NamedFluidDataStoreRegistryEntries;

Type: NamedFluidDataStoreRegistryEntries

runtimeClass

The runtime class to use for the data object.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly runtimeClass?: typeof FluidDataStoreRuntime;

Type: typeof FluidDataStoreRuntime

sharedObjects

The shared objects (DDSes) to be registered with the data object.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly sharedObjects?: readonly IChannelFactory[];

Type: readonly IChannelFactory[]

type

The type identifier for the data object factory.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

readonly type: string;

Type: string