ISharedObject Interface
Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
This API is provided for existing users, but is not recommended for new users.
To use, import via fluid-framework/legacy.
For more information about our API support guarantees, see here.
Signature
export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends IChannel, IEventProvider<TEvent>
Extends: IChannel, IEventProvider<TEvent>
Type Parameters
| Parameter | Constraint | Default | Description |
|---|---|---|---|
| TEvent | ISharedObjectEvents | ISharedObjectEvents |
Methods
| Method | Alerts | Return Type | Description |
|---|---|---|---|
| bindToContext() | Alpha |
void | Binds the given shared object to its containing data store runtime, causing it to attach once the runtime attaches. |
| getGCData(fullGC) | Alpha |
IGarbageCollectionData | Returns the GC data for this shared object. It contains a list of GC nodes that contains references to other GC nodes. |
Method Details
bindToContext
Binds the given shared object to its containing data store runtime, causing it to attach once the runtime attaches.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
Signature
bindToContext(): void;
getGCData
Returns the GC data for this shared object. It contains a list of GC nodes that contains references to other GC nodes.
This API is provided as an alpha preview and may change without notice.
To use, import via fluid-framework/alpha.
For more information about our API support guarantees, see here.
Signature
getGCData(fullGC?: boolean): IGarbageCollectionData;
Parameters
| Parameter | Modifiers | Type | Description |
|---|---|---|---|
| fullGC | optional | boolean | true to bypass optimizations and force full generation of GC data. |
Returns
Return type: IGarbageCollectionData