@univerjs-pro/collaboration-client v0.5.4

Class: CollaborationController

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration.controller.ts:17

Extends

RxDisposable

Constructors

new CollaborationController()

new CollaborationController(
   _injector, 
   _collabSessionService, 
   _univerInstanceService): CollaborationController

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration.controller.ts:22

Parameters

Parameter	Type
`_injector`	`Injector`
`_collabSessionService`	`CollaborationSessionService`
`_univerInstanceService`	`IUniverInstanceService`

Returns

CollaborationController

Overrides

RxDisposable.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`RxDisposable`.`_disposed`	submodules/univer/packages/core/src/shared/lifecycle.ts:96
`dispose$`	`protected`	`Subject`<`void`>	`undefined`	`RxDisposable`.`dispose$`	submodules/univer/packages/core/src/shared/lifecycle.ts:120
`entityInit$`	`readonly`	`Observable`<`CollaborationEntity`>	`undefined`	-	packages/collaboration-client/src/controllers/collaboration/collaboration.controller.ts:20

Methods

dispose()

dispose(): void

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration.controller.ts:32

Returns

void

Overrides

RxDisposable.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

Parameter	Type
`disposable`	`DisposableLike`

Returns

IDisposable

Inherited from

RxDisposable.disposeWithMe

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

RxDisposable.ensureNotDisposed

getCollabEntity()

getCollabEntity(id): Nullable<CollaborationEntity>

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration.controller.ts:38

Parameters

Parameter	Type
`id`	`string`

Returns

Nullable<CollaborationEntity>

getCollabEntity$()

getCollabEntity$(id): Observable<CollaborationEntity>

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration.controller.ts:42

Parameters

Parameter	Type
`id`	`string`

Returns

Observable<CollaborationEntity>

readyForCollab()

readyForCollab(id): Promise<void>

Defined in: packages/collaboration-client/src/controllers/collaboration/collaboration.controller.ts:51

Parameters

Parameter	Type
`id`	`string`

Returns

Promise<void>

Awaitingwithpendingstate Collaborationentity