Class TimelineController`Beta`

The controller is responsible for fetching information about a document and maintaining a Timeline.

Deprecated

Use the events API instead. The legacy document timeline will be removed in the next major version.

Hidden

Constructors

constructor

new TimelineController(options: TimelineControllerOptions): TimelineController
Beta
Parameters
- options: TimelineControllerOptions
Returns TimelineController
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:58

Properties

`Beta`client

client: SanityClient$1

`Beta`handler

handler: (err: Error, controller: TimelineController) => void

`Beta`selectionState

selectionState: SelectionState = 'inactive'

The selection state represents the different states of the current selection:

inactive: No selection is active.
rev: A selection is active for a single revision.
range: A selection is active for a range and we have all the data needed to render it.
loading: A selection is active, but we don't have the entries yet.
invalid: The selection picked is invalid.

`Beta`timeline

timeline: Timeline

`Beta`version

version: number = 0

Accessors

isLoading

get isLoading(): boolean
Beta
Returns boolean
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:137

realRevChunk

get realRevChunk(): Chunk
Beta
Returns Chunk
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:141

revTime

get revTime(): Chunk
Beta
Returns Chunk
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:133

sinceTime

get sinceTime(): Chunk
Beta
Returns Chunk
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:129

Methods

clearRange

clearRange(): void
Beta
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:86

currentDiff

currentDiff(): Diff<AnnotationDetails>
Beta
Returns Diff<AnnotationDetails>
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:221

currentObjectDiff

currentObjectDiff(): ObjectDiff<AnnotationDetails>
Beta
Returns ObjectDiff<AnnotationDetails>
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:225

displayed

displayed(): Record<string, unknown>
Beta
Returns Record<string, unknown>
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:207

findRangeForNewRev

findRangeForNewRev(rev: Chunk): [string, string]
Beta
Parameters
- rev: Chunk
Returns [string, string]
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:150

findRangeForNewSince

findRangeForNewSince(since: Chunk): [string, string]
Beta
Parameters
- since: Chunk
Returns [string, string]
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:165

handleRemoteMutation

handleRemoteMutation(ev: RemoteSnapshotVersionEvent): void
Beta
Parameters
- ev: RemoteSnapshotVersionEvent
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:235

onOlderRevision

onOlderRevision(): boolean
Beta
Returns true when there's an older revision we want to render.

Returns boolean
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:146

resume

resume(): void
Beta
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:255

setHandler

setHandler(handler: (err: Error, controller: TimelineController) => void): void
Beta
Parameters
- handler: (err: Error, controller: TimelineController) => void
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:82

setLoadMore

setLoadMore(flag: boolean): void
Beta
Parameters
- flag: boolean
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:124

setRange

setRange(since: string, rev: string): void
Beta
Parameters
- since: string
- rev: string
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:90

setReconstruction

setReconstruction(since: Chunk, rev: Chunk): void
Beta
Parameters
- since: Chunk
- rev: Chunk
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:211

setRevTime

setRevTime(rev: string): void
Beta
Parameters
- rev: string
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:178

setSinceTime

setSinceTime(since: string): void
Beta
Parameters
- since: string
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:189

sinceAttributes

sinceAttributes(): Record<string, unknown>
Beta
Returns Record<string, unknown>
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:203

start

start(): void
Beta
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:243

suspend

suspend(): void
Beta
Returns void
- Defined in packages/sanity/src/core/store/history/history/TimelineController.ts:259