SharedObject Class
SharedObject with simplified, synchronous summarization and GC. DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
This API is provided for existing users, but is not recommended for new users.
To use, import via @fluidframework/shared-object-base/legacy.
For more information about our API support guarantees, see here.
Signature
export declare abstract class SharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends SharedObjectCore<TEvent>
Extends: SharedObjectCore<TEvent>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TEvent | ISharedObjectEvents | ISharedObjectEvents |
Constructors
| Constructor | Alerts | Description |
|---|---|---|
| (constructor)(id, runtime, attributes, telemetryContextPrefix) | Alpha |
Constructs a new instance of the SharedObject class |
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| serializer | Alpha |
readonly |
IFluidSerializer |
Constructor Details
(constructor)
Constructs a new instance of the SharedObject class
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/shared-object-base/alpha.
For more information about our API support guarantees, see here.
Signature
constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, telemetryContextPrefix: string);
Parameters
| Parameter | Type | Description |
|---|---|---|
| id | string | The id of the shared object |
| runtime | IFluidDataStoreRuntime | The IFluidDataStoreRuntime which contains the shared object |
| attributes | IChannelAttributes | Attributes of the shared object |
| telemetryContextPrefix | string |
Property Details
serializer
This API is provided as an alpha preview and may change without notice.
To use, import via @fluidframework/shared-object-base/alpha.
For more information about our API support guarantees, see here.
Signature
protected get serializer(): IFluidSerializer;
Type: IFluidSerializer