Version: v2

ISharedObject Interface

Base interface for shared objects from which other interfaces extend.

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>

Parameter	Constraint	Default	Description
TEvent	ISharedObjectEvents	ISharedObjectEvents

This interface is not intended to be implemented outside this repository: implementers should migrate to using an existing implementation instead.

Method	Alerts	Return Type	Description
bindToContext()	`Beta`	void	Binds the given shared object to its containing data store runtime, causing it to attach once the runtime attaches.

Binds the given shared object to its containing data store runtime, causing it to attach once the runtime attaches.

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

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

bindToContext(): void;