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

Index

Constructors

constructor

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

Properties

`Private` endEvent

endEvent: undefined | MatrixEvent

`Private` fetchingResponsesPromise

fetchingResponsesPromise: null | Promise<void> = null

`Private` matrixClient

matrixClient: MatrixClient

`Readonly` pollEvent

pollEvent: PollStartEvent

`Private` responses

responses: null | Relations = null

`Readonly` roomId

roomId: string

`Private` rootEvent

rootEvent: MatrixEvent

Accessors

isEnded

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

pollId

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

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:126

getResponses

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

listenerCount

listenerCount(event: EventEmitterEvents | End | Update | Responses | Destroy): number
Parameters
- event: EventEmitterEvents | End | Update | Responses | Destroy
Returns number
Inherited from TypedEventEmitter.listenerCount
- Defined in src/models/typed-event-emitter.ts:66

listeners

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

off

off<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.off
- Defined in src/models/typed-event-emitter.ts:74

on

on<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.on
- Defined in src/models/typed-event-emitter.ts:78

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:103

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:161

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

Class Poll

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

rootEvent: MatrixEvent

matrixClient: MatrixClient

Returns Poll

Properties

Private endEvent

Private fetchingResponsesPromise

Private matrixClient

Readonly pollEvent

Private responses

Readonly roomId

Private rootEvent

Accessors

isEnded

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

onNewRelation

Returns

Parameters

event: MatrixEvent

Returns void

`Private` endEvent

`Private` fetchingResponsesPromise

`Private` matrixClient

`Readonly` pollEvent

`Private` responses

`Readonly` roomId

`Private` rootEvent

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

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

`Private` fetchResponses

`Private` refilterResponsesOnEnd

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