Class CollaborationInstance

Implements

Disposable

Constructors

constructor

new CollaborationInstance(): CollaborationInstance
Returns CollaborationInstance

Properties

`Protected`_readonly

_readonly: boolean = false

`Protected` `Readonly`collaborationColorService

collaborationColorService: CollaborationColorService

`Protected`colorIndex

colorIndex: number = 0

`Protected`editorDecorations

editorDecorations: Map<EditorWidget, string[]> = ...

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Protected` `Readonly`fileService

fileService: FileService

`Protected` `Optional`fileSystem

fileSystem?: CollaborationFileSystemProvider

`Protected`identity

identity: Deferred<Peer> = ...

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`messageService

messageService: MessageService

`Protected` `Readonly`monacoModelService

monacoModelService: MonacoTextModelService

`Protected`onDidCloseEmitter

onDidCloseEmitter: Emitter<void> = ...

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`options

options: CollaborationInstanceOptions

`Protected`peers

peers: Map<string, DisposablePeer> = ...

`Protected`permissions

permissions: Permissions = ...

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected`toDispose

toDispose: DisposableCollection = ...

`Protected` `Readonly`utils

utils: CollaborationUtils

`Protected` `Readonly`workspaceService

workspaceService: CollaborationWorkspaceService

`Protected`yjs

yjs: Doc = ...

`Protected`yjsAwareness

yjsAwareness: Awareness = ...

`Protected` `Readonly`yjsMutex

yjsMutex: mutex = ...

`Protected`yjsProvider

yjsProvider: OpenCollaborationYjsProvider

Accessors

host

get host(): Peer
Returns Peer
- Defined in collaboration/src/browser/collaboration-instance.ts:151

isHost

get isHost(): boolean
Returns boolean
- Defined in collaboration/src/browser/collaboration-instance.ts:147

onDidClose

get onDidClose(): Event<void>
Returns Event<void>
- Defined in collaboration/src/browser/collaboration-instance.ts:119

readonly

get readonly(): boolean
Returns boolean
- Defined in collaboration/src/browser/collaboration-instance.ts:126
set readonly(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:130

Methods

`Protected`addPeer

addPeer(peer: Peer): void
Parameters
- peer: Peer
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:604

`Protected`createPeerStyleSheet

createPeerStyleSheet(peer: Peer): Disposable
Parameters
- peer: Peer
Returns Disposable
- Defined in collaboration/src/browser/collaboration-instance.ts:615

`Protected`createRelativeSelection

createRelativeSelection(
    selection: Selection,
    model: TextEditorDocument,
    ytext: YText,
): RelativeTextSelection
Parameters
- selection: Selection
- model: TextEditorDocument
- ytext: YText
Returns RelativeTextSelection
- Defined in collaboration/src/browser/collaboration-instance.ts:669

`Protected`createSelectionFromRelative

createSelectionFromRelative(
selection: RelativeTextSelection,
model: MonacoEditorModel,
): undefined | Selection
Parameters
- selection: RelativeTextSelection
- model: MonacoEditorModel
Returns undefined | Selection
- Defined in collaboration/src/browser/collaboration-instance.ts:656

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Disposable.dispose
- Defined in collaboration/src/browser/collaboration-instance.ts:815

`Protected`getModel

getModel(uri: URI): undefined | MonacoEditorModel
Parameters
- uri: URI
Returns undefined | MonacoEditorModel
- Defined in collaboration/src/browser/collaboration-instance.ts:777

`Protected`getOpenEditors

getOpenEditors(uri?: URI): EditorWidget[]
Parameters
- Optionaluri: URI
Returns EditorWidget[]
- Defined in collaboration/src/browser/collaboration-instance.ts:646

`Protected`init

init(): void
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:156

initialize

initialize(data: InitData): Promise<void>
Parameters
- data: InitData
Returns Promise<void>
- Defined in collaboration/src/browser/collaboration-instance.ts:591

`Protected`isSharedResource

isSharedResource(resource?: URI): boolean
Parameters
- Optionalresource: URI
Returns boolean
- Defined in collaboration/src/browser/collaboration-instance.ts:280

`Protected`openUri

openUri(uri: URI): Promise<void>
Parameters
- uri: URI
Returns Promise<void>
- Defined in collaboration/src/browser/collaboration-instance.ts:806

`Protected`pushChangesToModel

pushChangesToModel(
model: MonacoEditorModel,
changes: { forceMoveMarkers?: boolean; range: Range; text: string }[],
): void
Parameters
- model: MonacoEditorModel
- changes: { forceMoveMarkers?: boolean; range: Range; text: string }[]
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:786

`Protected`rangeEqual

rangeEqual(a: Range, b: Range): boolean
Parameters
- a: Range
- b: Range
Returns boolean
- Defined in collaboration/src/browser/collaboration-instance.ts:584

`Protected`registerEditorEvents

registerEditorEvents(connection: ProtocolBroadcastConnection): void
Parameters
- connection: ProtocolBroadcastConnection
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:238

`Protected`registerFileSystemChanges

registerFileSystemChanges(): void
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:475

`Protected`registerFileSystemEvents

registerFileSystemEvents(connection: ProtocolBroadcastConnection): void
Parameters
- connection: ProtocolBroadcastConnection
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:287

`Protected`registerModelUpdate

registerModelUpdate(model: MonacoEditorModel): void
Parameters
- model: MonacoEditorModel
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:683

`Protected`registerPresenceUpdate

registerPresenceUpdate(widget: EditorWidget): Promise<void>
Parameters
- widget: EditorWidget
Returns Promise<void>
- Defined in collaboration/src/browser/collaboration-instance.ts:522

`Protected`registerProtocolEvents

registerProtocolEvents(connection: ProtocolBroadcastConnection): void
Parameters
- connection: ProtocolBroadcastConnection
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:179

`Protected`rerenderPresence

rerenderPresence(...widgets: EditorWidget[]): void
Parameters
- ...widgets: EditorWidget[]
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:397

`Protected`rerenderPresenceDecorations

rerenderPresenceDecorations(
decorations: Map<string, EditorDecoration[]>,
...widgets: EditorWidget[],
): void
Parameters
- decorations: Map<string, EditorDecoration[]>
- ...widgets: EditorWidget[]
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:461

`Protected`resetYjsText

resetYjsText(yjsText: YText, text: string): void
Parameters
- yjsText: YText
- text: string
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:770

`Protected`setSharedSelection

setSharedSelection(selection?: ClientSelection): void
Parameters
- Optionalselection: ClientSelection
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:580

`Protected`softReplaceModel

softReplaceModel(model: MonacoEditorModel, text: string): void
Parameters
- model: MonacoEditorModel
- text: string
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:798

`Protected`updateEditorPresence

updateEditorPresence(widget: EditorWidget): void
Parameters
- widget: EditorWidget
Returns void
- Defined in collaboration/src/browser/collaboration-instance.ts:553