Class HistoryService<C>

Type parameters

C: Controller = Controller

Hierarchy

Service<C>
- HistoryService

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new HistoryService<C>(): HistoryService<C>

Overrides Service.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:7
Type parameters
- C: Controller<C> = Controller
Returns HistoryService<C>

Properties

Readonly historyState

historyState: HistoryState

Optional Readonly observerType

observerType: Class<HistoryServiceObserver<C, HistoryService<C>>>

Readonly observers

observers: readonly HistoryServiceObserver<C, HistoryService<C>>[]

Readonly roots

roots: readonly C[]

Accessors

attached

get attached(): boolean

- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:16
Returns boolean

historyUri

get historyUri(): Uri

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:10
Returns Uri

Methods

Protected attachEvents

attachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:25
Returns void

attachRoot

attachRoot(root: C): void

Inherited from Service.attachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:8
Parameters
- root: C
Returns void

Protected detachEvents

detachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:26
Returns void

detachRoot

detachRoot(root: C): void

Inherited from Service.detachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:12
Parameters
- root: C
Returns void

Protected didAttach

didAttach(): void

Inherited from Service.didAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:19
Returns void

Protected didAttachRoot

didAttachRoot(root: C): void

Inherited from Service.didAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:11
Parameters
- root: C
Returns void

Protected didDetach

didDetach(): void

Inherited from Service.didDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:22
Returns void

Protected didDetachRoot

didDetachRoot(root: C): void

Inherited from Service.didDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:15
Parameters
- root: C
Returns void

Protected didObserve

didObserve(observer: HistoryServiceObserver<C, HistoryService<C>>): void

Inherited from Service.didObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:27
Parameters
- observer: HistoryServiceObserver<C, HistoryService<C>>
Returns void

Protected didPopHistory

didPopHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:22
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected didPushHistory

didPushHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:14
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected didReplaceHistory

didReplaceHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:18
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected didUnobserve

didUnobserve(observer: HistoryServiceObserver<C, HistoryService<C>>): void

Inherited from Service.didUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:31
Parameters
- observer: HistoryServiceObserver<C, HistoryService<C>>
Returns void

Protected forEachObserver

forEachObserver<T>(callback: (observer: HistoryServiceObserver<C, HistoryService<C>>) => void | T): undefined | T

Inherited from Service.forEachObserver
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:32
Type parameters
- T
Parameters
- callback: (observer: HistoryServiceObserver<C, HistoryService<C>>) => void | T
  - - (observer: HistoryServiceObserver<C, HistoryService<C>>): void | T
    - Parameters
      - observer: HistoryServiceObserver<C, HistoryService<C>>
      Returns void | T
Returns undefined | T

observe

observe(observer: HistoryServiceObserver<C, HistoryService<C>>): void

Inherited from Service.observe
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:24
Parameters
- observer: HistoryServiceObserver<C, HistoryService<C>>
Returns void

Protected onAttach

onAttach(): void

Overrides Service.onAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:23
Returns void

Protected onAttachRoot

onAttachRoot(root: C): void

Inherited from Service.onAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:10
Parameters
- root: C
Returns void

Protected onDetach

onDetach(): void

Overrides Service.onDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:24
Returns void

Protected onDetachRoot

onDetachRoot(root: C): void

Inherited from Service.onDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:14
Parameters
- root: C
Returns void

Protected onObserve

onObserve(observer: HistoryServiceObserver<C, HistoryService<C>>): void

Inherited from Service.onObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:26
Parameters
- observer: HistoryServiceObserver<C, HistoryService<C>>
Returns void

Protected onPopHistory

onPopHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:21
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected onPushHistory

onPushHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:13
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected onReplaceHistory

onReplaceHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:17
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected onUnobserve

onUnobserve(observer: HistoryServiceObserver<C, HistoryService<C>>): void

Inherited from Service.onUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:30
Parameters
- observer: HistoryServiceObserver<C, HistoryService<C>>
Returns void

popHistory

popHistory(event: PopStateEvent): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:19
Parameters
- event: PopStateEvent
Returns void

pushHistory

pushHistory(deltaState: HistoryStateInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:11
Parameters
- deltaState: HistoryStateInit
Returns void

replaceHistory

replaceHistory(deltaState: HistoryStateInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:15
Parameters
- deltaState: HistoryStateInit
Returns void

unobserve

unobserve(observer: HistoryServiceObserver<C, HistoryService<C>>): void

Inherited from Service.unobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:28
Parameters
- observer: HistoryServiceObserver<C, HistoryService<C>>
Returns void

Protected willAttach

willAttach(): void

Inherited from Service.willAttach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:17
Returns void

Protected willAttachRoot

willAttachRoot(root: C): void

Inherited from Service.willAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:9
Parameters
- root: C
Returns void

Protected willDetach

willDetach(): void

Inherited from Service.willDetach
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:20
Returns void

Protected willDetachRoot

willDetachRoot(root: C): void

Inherited from Service.willDetachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:13
Parameters
- root: C
Returns void

Protected willObserve

willObserve(observer: HistoryServiceObserver<C, HistoryService<C>>): void

Inherited from Service.willObserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:25
Parameters
- observer: HistoryServiceObserver<C, HistoryService<C>>
Returns void

Protected willPopHistory

willPopHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:20
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected willPushHistory

willPushHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:12
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected willReplaceHistory

willReplaceHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:16
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected willUnobserve

willUnobserve(observer: HistoryServiceObserver<C, HistoryService<C>>): void

Inherited from Service.willUnobserve
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:29
Parameters
- observer: HistoryServiceObserver<C, HistoryService<C>>
Returns void

Static global

global<C>(): HistoryService<C>

- Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryService.d.ts:27
Type parameters
- C: Controller<C>
Returns HistoryService<C>

Generated using TypeDoc