Interface ISharedFactory

A factory interface for creating ISharedDocument objects.

interface ISharedFactory {
    collaborative?: boolean;
    createNew(options: ISharedFactoryOptions): undefined | ISharedDocument;
    registerDocumentFactory(type: string, factory: SharedDocumentFactory): void;
}

Index

Properties

Methods

createNew registerDocumentFactory?

Properties

`Optional` `Readonly`collaborative

collaborative?: boolean

Whether the IDrive supports real-time collaboration or not. Note: If it is not provided, it is false by default.

Methods

createNew

createNew(options: ISharedFactoryOptions): undefined | ISharedDocument
Create a new ISharedDocument instance.

It should return undefined if the factory is not able to create a ISharedDocument.
Parameters
- options: ISharedFactoryOptions
Returns undefined | ISharedDocument
- Defined in packages/services/src/contents/index.ts:279

`Optional`registerDocumentFactory

registerDocumentFactory(type: string, factory: SharedDocumentFactory): void
Register a SharedDocumentFactory.
Parameters
- type: string
  Document type
- factory: SharedDocumentFactory
  Document factory
Returns void
- Defined in packages/services/src/contents/index.ts:287