Skip to main content
Version: v2

IDataObjectProps Interface

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 IDataObjectProps<I extends DataObjectTypes = DataObjectTypes>

Type Parameters​

ParameterConstraintDefaultDescription
IDataObjectTypesDataObjectTypes

Properties​

PropertyAlertsModifiersTypeDescription
contextBetareadonlyIFluidDataStoreContext
initPropsBetaoptional, readonlyI["InitialState"]
providersBetareadonlyAsyncFluidObjectProvider<I["OptionalProviders"]>
runtimeBetareadonlyIFluidDataStoreRuntime

Property Details​

context​

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 context: IFluidDataStoreContext;

Type: IFluidDataStoreContext

initProps​

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 initProps?: I["InitialState"];

Type: I["InitialState"]

providers​

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 providers: AsyncFluidObjectProvider<I["OptionalProviders"]>;

Type: AsyncFluidObjectProvider<I["OptionalProviders"]>

runtime​

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 runtime: IFluidDataStoreRuntime;

Type: IFluidDataStoreRuntime