IDebuggerUI Interface

Signature

export interface IDebuggerUI

Methods

Method	Return Type	Description
addVersions(version)	void	Version information is provided. Expect updates (information about seq#, timestamp) through updateVersion() calls
disableNextOpButton(disable)	void	Called by controller in response to new ops being downloaded Called with disable = true if there are no (currently) ops to play
updateLastOpText(lastKnownOp, stillLoading)	void	Called periodically to notify about last known op
updateNextOpText(ops)	void	Called by controller when new ops arrive (or we are done playing previous batch) Indicates next batch of ops that would be played when UI calls controller's onOpButtonClick() Called with ops=[] when there are no ops to play.
updateVersion(index, version, seqNumber)	void	Call when new version is downloaded from storage Expect multiple callbacks.
updateVersionText(versionsLeft)	void	Called periodically when new versions are downloaded from server
versionSelected(seqNumber, version)	void	Called in response to successful onVersionSelection() or onSnapshotFileSelection() call and provides extra information about selection. It expected that UI layer would change its mode as result of this call, i.e. switch to displaying op playback controls (if this is supported) Note: There maybe no call to versionSelected() in response to onSnapshotFileSelection() call if file does not exist, has wrong name of wrong format.

Method Details

addVersions

Version information is provided. Expect updates (information about seq#, timestamp) through updateVersion() calls

Signature

addVersions(version: IVersion[]): void;

Parameters

Parameter	Type	Description
version	IVersion[]

disableNextOpButton

Called by controller in response to new ops being downloaded Called with disable = true if there are no (currently) ops to play

Signature

disableNextOpButton(disable: boolean): void;

Parameters

Parameter	Type	Description
disable	boolean

updateLastOpText

Called periodically to notify about last known op

Signature

updateLastOpText(lastKnownOp: number, stillLoading: boolean): void;

Parameters

Parameter	Type	Description
lastKnownOp	number	seq number of last known op. -1 if can't play ops in this mode (load from file)
stillLoading	boolean	true if we did not reach yet the end of the stream

updateNextOpText

Called by controller when new ops arrive (or we are done playing previous batch) Indicates next batch of ops that would be played when UI calls controller's onOpButtonClick() Called with ops=[] when there are no ops to play.

Signature

updateNextOpText(ops: ISequencedDocumentMessage[]): void;

Parameters

Parameter	Type	Description
ops	ISequencedDocumentMessage[]

updateVersion

Call when new version is downloaded from storage Expect multiple callbacks.

Signature

updateVersion(index: number, version: IVersion, seqNumber: number): void;

Parameters

Parameter	Type	Description
index	number
version	IVersion
seqNumber	number

updateVersionText

Called periodically when new versions are downloaded from server

Signature

updateVersionText(versionsLeft: number): void;

Parameters

Parameter	Type	Description
versionsLeft	number

versionSelected

Called in response to successful onVersionSelection() or onSnapshotFileSelection() call and provides extra information about selection. It expected that UI layer would change its mode as result of this call, i.e. switch to displaying op playback controls (if this is supported) Note: There maybe no call to versionSelected() in response to onSnapshotFileSelection() call if file does not exist, has wrong name of wrong format.

Signature

versionSelected(seqNumber: number, version: IVersion | string): void;

Parameters

Parameter	Type	Description
seqNumber	number
version	IVersion | string	version, file name, or undefined if playing ops.