Class RefreshService<M>

Type parameters

M: Model = Model

Hierarchy

Service<M>
- RefreshService

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new RefreshService<M>(): RefreshService<M>

Overrides Service.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:6
Type parameters
- M: Model<M> = Model
Returns RefreshService<M>

Properties

analyzeTimer

analyzeTimer: number

Readonly flags

flags: number

Readonly modelContext

modelContext: ModelContext

Optional Readonly observerType

observerType: Class<RefreshServiceObserver<M, RefreshService<M>>>

Readonly observers

observers: readonly RefreshServiceObserver<M, RefreshService<M>>[]

refreshTimer

refreshTimer: number

Readonly roots

roots: readonly M[]

updateDelay

updateDelay: number

Static MaxAnalyzeInterval

MaxAnalyzeInterval: number

Static MaxRefreshInterval

MaxRefreshInterval: number

Static MaxUpdateDelay

MaxUpdateDelay: number

Static MinAnalyzeInterval

MinAnalyzeInterval: number

Static MinRefreshInterval

MinRefreshInterval: number

Static MinUpdateDelay

MinUpdateDelay: number

Accessors

attached

get attached(): boolean

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

powerFlags

get powerFlags(): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:26
Returns number

Methods

Protected attachEvents

attachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:32
Returns void

attachRoot

attachRoot(root: M): void

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

Protected cancelAnalyzePass

cancelAnalyzePass(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:20
Returns void

Protected cancelRefreshPass

cancelRefreshPass(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:24
Returns void

Protected cancelUpdate

cancelUpdate(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:16
Returns void

Protected detachEvents

detachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:33
Returns void

detachRoot

detachRoot(root: M): void

Inherited from Service.detachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:12
Parameters
- root: M
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: M): void

Inherited from Service.didAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:11
Parameters
- root: M
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: M): void

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

Protected didObserve

didObserve(observer: RefreshServiceObserver<M, RefreshService<M>>): void

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

Protected didUnobserve

didUnobserve(observer: RefreshServiceObserver<M, RefreshService<M>>): void

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

Protected forEachObserver

forEachObserver<T>(callback: (observer: RefreshServiceObserver<M, RefreshService<M>>) => 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: RefreshServiceObserver<M, RefreshService<M>>) => void | T
  - - (observer: RefreshServiceObserver<M, RefreshService<M>>): void | T
    - Parameters
      - observer: RefreshServiceObserver<M, RefreshService<M>>
      Returns void | T
Returns undefined | T

Protected needsUpdate

needsUpdate(updateFlags: number, immediate: boolean): number

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:13
Parameters
- updateFlags: number
- immediate: boolean
Returns number

observe

observe(observer: RefreshServiceObserver<M, RefreshService<M>>): void

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

Protected onAttach

onAttach(): void

Overrides Service.onAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:30
Returns void

Protected onAttachRoot

onAttachRoot(root: M): void

Overrides Service.onAttachRoot
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:29
Parameters
- root: M
Returns void

Protected onDetach

onDetach(): void

Overrides Service.onDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:31
Returns void

Protected onDetachRoot

onDetachRoot(root: M): void

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

Protected onObserve

onObserve(observer: RefreshServiceObserver<M, RefreshService<M>>): void

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

Protected onUnobserve

onUnobserve(observer: RefreshServiceObserver<M, RefreshService<M>>): void

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

Protected onVisibilityChange

onVisibilityChange(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:34
Returns void

power

power(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:27
Returns void

requestUpdate

requestUpdate(target: Model, updateFlags: number, immediate: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:14
Parameters
- target: Model
- updateFlags: number
- immediate: boolean
Returns void

Protected runAnalyzePass

runAnalyzePass(immediate?: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:21
Parameters
- Optional immediate: boolean
Returns void

Protected runImmediatePass

runImmediatePass(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:17
Returns void

Protected runRefreshPass

runRefreshPass(immediate?: boolean): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:25
Parameters
- Optional immediate: boolean
Returns void

Protected scheduleAnalyzePass

scheduleAnalyzePass(updateDelay: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:19
Parameters
- updateDelay: number
Returns void

Protected scheduleRefreshPass

scheduleRefreshPass(updateDelay: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:23
Parameters
- updateDelay: number
Returns void

Protected scheduleUpdate

scheduleUpdate(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:15
Returns void

setFlags

setFlags(flags: number): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:9
Parameters
- flags: number
Returns void

unobserve

unobserve(observer: RefreshServiceObserver<M, RefreshService<M>>): void

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

unpower

unpower(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:28
Returns void

updatedModelContext

updatedModelContext(): ModelContext

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:11
Returns ModelContext

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: M): void

Inherited from Service.willAttachRoot
- Defined in swim-runtime-js/swim-core-js/@swim/util/lib/main/service/Service.d.ts:9
Parameters
- root: M
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: M): void

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

Protected willObserve

willObserve(observer: RefreshServiceObserver<M, RefreshService<M>>): void

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

Protected willUnobserve

willUnobserve(observer: RefreshServiceObserver<M, RefreshService<M>>): void

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

Static global

global<M>(): RefreshService<M>

- Defined in swim-toolkit-js/swim-ui-js/@swim/model/lib/main/refresh/RefreshService.d.ts:35
Type parameters
- M: Model<M>
Returns RefreshService<M>

Generated using TypeDoc