Class WebsocketUpdates

Index

Constructors

Methods

autoRelease getReleaseInterval has isEmpty isTimerRunning length onTimer push release remove reset startTimer stopTimer

Constructors

constructor

new WebsocketUpdates(): WebsocketUpdates
Returns WebsocketUpdates

Methods

autoRelease

autoRelease(): boolean
Returns boolean
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:95

getReleaseInterval

getReleaseInterval(): number
Read when needed rather than at construction: the buffer is created at boot, before the forum's attributes are loaded.

Returns number
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:40

has

has(discussion: Discussion): boolean
Parameters
- discussion: Discussion
Returns boolean
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:24

isEmpty

isEmpty(): boolean
Returns boolean
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:28

isTimerRunning

isTimerRunning(): boolean
Returns boolean
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:87

length

length(): number
Returns number
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:12

onTimer

onTimer(callback: (second: number) => void): void
Parameters
- callback: (second: number) => void
Returns void
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:91

push

push(discussion: Discussion): void
Parameters
- discussion: Discussion
Returns void
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:16

release

release(state: DiscussionListState): void
Releases new discussion updates to the discussion list.
Parameters
- state: DiscussionListState
Returns void
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:47

remove

remove(discussion: Discussion): void
Parameters
- discussion: Discussion
Returns void
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:20

reset

reset(): void
Returns void
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:32

startTimer

startTimer(): void
Starts the timer that will release new discussion updates to the discussion list.

Returns void
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:67

stopTimer

stopTimer(): void
Returns void
- Defined in extensions/realtime/js/src/forum/extend/DiscussionList/WebsocketUpdates.ts:82