Class CollaborativeDocument

Constructors

constructor

new CollaborativeDocument(
initialState?: Uint8Array<ArrayBufferLike>,
): CollaborativeDocument
Parameters
- OptionalinitialState: Uint8Array<ArrayBufferLike>
Returns CollaborativeDocument
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:284

Methods

addAttachment

addAttachment(attachment: DocumentAttachment): DocumentChange[]
Parameters
- attachment: DocumentAttachment
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:458

addComment

addComment(comment: CreateDocumentComment): DocumentChange[]
Parameters
- comment: CreateDocumentComment
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:410

applyChanges

applyChanges(changes: readonly DocumentChange[]): boolean
Parameters
- changes: readonly DocumentChange[]
Returns boolean
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:485

clone

clone(): CollaborativeDocument
Returns CollaborativeDocument
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:515

editText

editText(nextText: string): DocumentChange[]
Parameters
- nextText: string
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:316

getHeads

getHeads(): Heads
Returns Heads
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:300

getStructuredView

getStructuredView(): StructuredDocumentView
Returns StructuredDocumentView
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:292

getText

getText(): string
Returns string
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:288

insertBlock

insertBlock(block: DocumentBlock, index?: number): DocumentChange[]
Parameters
- block: DocumentBlock
- index: number = ...
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:338

mergeSnapshot

mergeSnapshot(snapshot: Uint8Array): boolean
Parameters
- snapshot: Uint8Array
Returns boolean
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:499

moveBlock

moveBlock(blockId: string, toIndex: number): DocumentChange[]
Parameters
- blockId: string
- toIndex: number
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:372

removeAttachment

removeAttachment(attachmentId: string): DocumentChange[]
Parameters
- attachmentId: string
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:472

removeBlock

removeBlock(blockId: string): DocumentChange[]
Parameters
- blockId: string
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:392

removeComment

removeComment(commentId: string): DocumentChange[]
Parameters
- commentId: string
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:445

resolveComment

resolveComment(commentId: string, resolved?: boolean): DocumentChange[]
Parameters
- commentId: string
- resolved: boolean = true
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:430

save

save(): Uint8Array
Returns Uint8Array
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:511

spliceText

spliceText(edit: TextEdit): DocumentChange[]
Parameters
- edit: TextEdit
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:321

subscribe(listener: DocumentSubscriber): () => void
Parameters
- listener: DocumentSubscriber
Returns () => void
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:304

subscribeStructured

subscribeStructured(listener: StructuredDocumentSubscriber): () => void
Parameters
- listener: StructuredDocumentSubscriber
Returns () => void
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:310

updateBlock

updateBlock(blockId: string, update: DocumentBlockUpdate): DocumentChange[]
Parameters
- blockId: string
- update: DocumentBlockUpdate
Returns DocumentChange[]
- Defined in work/signalcd-modern-poc/signalcd-modern-poc/packages/core/src/collaborative-document.ts:355