Class Poll

Typed Event Emitter class which can act as a Base Model for all our model and communication events. This makes it much easier for us to distinguish between events, as we now need to properly type this, so that our events are not stringly-based and prone to silly typos.

Hierarchy

TypedEventEmitter<Exclude<PollEvent, New>, PollEventHandlerMap>
- Poll

Constructors

constructor

new Poll(rootEvent: MatrixEvent, matrixClient: MatrixClient, room: Room): Poll
Parameters
- rootEvent: MatrixEvent
- matrixClient: MatrixClient
- room: Room
Returns Poll
Overrides TypedEventEmitter.constructor
- Defined in src/models/poll.ts:70

Properties

`Private` _isFetchingResponses

_isFetchingResponses: boolean = false

`Private` endEvent

endEvent: undefined | MatrixEvent

`Private` matrixClient

matrixClient: MatrixClient

`Readonly` pollEvent

pollEvent: PollStartEvent

`Private` relationsNextBatch

relationsNextBatch: undefined | string

`Private` responses

responses: null | Relations = null

`Private` room

room: Room

`Readonly` roomId

roomId: string

`Readonly` rootEvent

rootEvent: MatrixEvent

Accessors

isEnded

get isEnded(): boolean
Returns boolean
- Defined in src/models/poll.ts:83

isFetchingResponses

get isFetchingResponses(): boolean
Returns boolean
- Defined in src/models/poll.ts:87

pollId

get pollId(): string
Returns string
- Defined in src/models/poll.ts:79

Methods

addListener

addListener<T>(event: T, listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>): Poll
Type Parameters
- T extends EventEmitterEvents | End | Update | Responses | Destroy
Parameters
- event: T
- listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>
Returns Poll
Inherited from TypedEventEmitter.addListener
- Defined in src/models/typed-event-emitter.ts:49

emit

emit<T>(event: T, ...args: Parameters<PollEventHandlerMap[T]>): boolean
Type Parameters
- T extends End | Update | Responses | Destroy
Parameters
- event: T
- Rest ...args: Parameters<PollEventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:56
emit<T>(event: T, ...args: Parameters<PollEventHandlerMap[T]>): boolean
Type Parameters
- T extends End | Update | Responses | Destroy
Parameters
- event: T
- Rest ...args: Parameters<PollEventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:57

eventNames

eventNames(): (EventEmitterEvents | End | Update | Responses | Destroy)[]
Returns (EventEmitterEvents | End | Update | Responses | Destroy)[]
Inherited from TypedEventEmitter.eventNames
- Defined in src/models/typed-event-emitter.ts:62

`Private` fetchResponses

fetchResponses(): Promise<void>
Returns Promise<void>
- Defined in src/models/poll.ts:135

getResponses

getResponses(): Promise<Relations>
Returns Promise<Relations>
- Defined in src/models/poll.ts:91

onNewRelation

onNewRelation(event: MatrixEvent): void
Returns
void
Parameters
- event: MatrixEvent
  
  event with a relation to the rootEvent
Returns void
- Defined in src/models/poll.ts:112

once

once<T>(event: T, listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>): Poll
Type Parameters
- T extends EventEmitterEvents | End | Update | Responses | Destroy
Parameters
- event: T
- listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>
Returns Poll
Inherited from TypedEventEmitter.once
- Defined in src/models/typed-event-emitter.ts:82

prependListener

prependListener<T>(event: T, listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>): Poll
Type Parameters
- T extends EventEmitterEvents | End | Update | Responses | Destroy
Parameters
- event: T
- listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>
Returns Poll
Inherited from TypedEventEmitter.prependListener
- Defined in src/models/typed-event-emitter.ts:86

prependOnceListener

prependOnceListener<T>(event: T, listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>): Poll
Type Parameters
- T extends EventEmitterEvents | End | Update | Responses | Destroy
Parameters
- event: T
- listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>
Returns Poll
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/models/typed-event-emitter.ts:93

rawListeners

rawListeners(event: EventEmitterEvents | End | Update | Responses | Destroy): Function[]
Parameters
- event: EventEmitterEvents | End | Update | Responses | Destroy
Returns Function[]
Inherited from TypedEventEmitter.rawListeners
- Defined in src/models/typed-event-emitter.ts:111

`Private` refilterResponsesOnEnd

refilterResponsesOnEnd(): void
Only responses made before the poll ended are valid Refilter after an end event is recieved To ensure responses are valid

Returns void
- Defined in src/models/poll.ts:194

removeAllListeners

removeAllListeners(event?: EventEmitterEvents | End | Update | Responses | Destroy): Poll
Parameters
- Optional event: EventEmitterEvents | End | Update | Responses | Destroy
Returns Poll
Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/models/typed-event-emitter.ts:100

removeListener

removeListener<T>(event: T, listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>): Poll
Type Parameters
- T extends EventEmitterEvents | End | Update | Responses | Destroy
Parameters
- event: T
- listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>
Returns Poll
Inherited from TypedEventEmitter.removeListener
- Defined in src/models/typed-event-emitter.ts:104

`Private` validateEndEvent

validateEndEvent(endEvent?: MatrixEvent): boolean
Parameters
- Optional endEvent: MatrixEvent
Returns boolean
- Defined in src/models/poll.ts:209

Class Poll

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

rootEvent: MatrixEvent

matrixClient: MatrixClient

room: Room

Returns Poll

Properties

Private _isFetchingResponses

Private endEvent

Private matrixClient

Readonly pollEvent

Private relationsNextBatch

Private responses

Private room

Readonly roomId

Readonly rootEvent

Accessors

isEnded

Returns boolean

isFetchingResponses

Returns boolean

pollId

Returns string

Methods

addListener

Type Parameters

T extends EventEmitterEvents | End | Update | Responses | Destroy

Parameters

event: T

listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>

Returns Poll

emit

Type Parameters

T extends End | Update | Responses | Destroy

Parameters

event: T

Rest ...args: Parameters<PollEventHandlerMap[T]>

Returns boolean

Type Parameters

T extends End | Update | Responses | Destroy

Parameters

event: T

Rest ...args: Parameters<PollEventHandlerMap[T]>

Returns boolean

eventNames

Returns (EventEmitterEvents | End | Update | Responses | Destroy)[]

Private fetchResponses

Returns Promise<void>

getResponses

Returns Promise<Relations>

listenerCount

Parameters

event: EventEmitterEvents | End | Update | Responses | Destroy

Returns number

listeners

Parameters

event: EventEmitterEvents | End | Update | Responses | Destroy

Returns Function[]

off

Type Parameters

T extends EventEmitterEvents | End | Update | Responses | Destroy

Parameters

event: T

listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>

Returns Poll

on

Type Parameters

T extends EventEmitterEvents | End | Update | Responses | Destroy

Parameters

event: T

listener: Listener<End | Update | Responses | Destroy, PollEventHandlerMap, T>

Returns Poll

`Private` _isFetchingResponses

`Private` endEvent

`Private` matrixClient

`Readonly` pollEvent

`Private` relationsNextBatch

`Private` responses

`Private` room

`Readonly` roomId

`Readonly` rootEvent

`Rest` ...args: Parameters<PollEventHandlerMap[T]>

`Rest` ...args: Parameters<PollEventHandlerMap[T]>

`Private` fetchResponses

`Private` refilterResponsesOnEnd

`Optional` event: EventEmitterEvents | End | Update | Responses | Destroy

`Private` validateEndEvent

`Optional` endEvent: MatrixEvent