@univerjs-pro/live-share v0.5.0-beta.1 • Docs
Class: LiveShareCoordinator
This coordinator subscribe to collaboration session and call LiveShareFollowerController
or
LiveSharePresenterController
to execute live share.
Extends
Constructors
new LiveShareCoordinator()
new LiveShareCoordinator(
_unitID,
_collabSession,
_configService,
_liveShareService,
_commandService): LiveShareCoordinator
Parameters
Parameter | Type |
---|---|
_unitID | string |
_collabSession | CollaborationSession |
_configService | IConfigService |
_liveShareService | LiveShareService |
_commandService | ICommandService |
Returns
Overrides
Defined in
packages/live-share/src/controllers/live-share/live-share.controller.ts:112
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | RxDisposable ._disposed | submodules/univer/packages/core/src/shared/lifecycle.ts:93 |
dispose$ | protected | Subject <void > | undefined | RxDisposable .dispose$ | submodules/univer/packages/core/src/shared/lifecycle.ts:117 |
status$ | public | Observable <LiveShareStatus > | undefined | - | packages/live-share/src/controllers/live-share/live-share.controller.ts:102 |
Methods
dispose()
dispose(): void
Returns
void
Overrides
Defined in
packages/live-share/src/controllers/live-share/live-share.controller.ts:122
disposeWithMe()
disposeWithMe(disposable): IDisposable
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:96
ensureNotDisposed()
protected ensureNotDisposed(): void
Returns
void
Inherited from
RxDisposable
.ensureNotDisposed
Defined in
submodules/univer/packages/core/src/shared/lifecycle.ts:100
init()
init(): void
Returns
void
Defined in
packages/live-share/src/controllers/live-share/live-share.controller.ts:128
startFollowing()
startFollowing(): void
Returns
void
Defined in
packages/live-share/src/controllers/live-share/live-share.controller.ts:196
stopFollowing()
stopFollowing(): void
Returns
void
Defined in
packages/live-share/src/controllers/live-share/live-share.controller.ts:205
stopPresenting()
stopPresenting(): void
Returns
void
Defined in
packages/live-share/src/controllers/live-share/live-share.controller.ts:181
tryStartPresenting()
tryStartPresenting(): void
Returns
void
Defined in
packages/live-share/src/controllers/live-share/live-share.controller.ts:168