Class VerificationBase<Events, Arguments>

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.

Type Parameters

Events extends string
Arguments extends ListenerMap<Events | VerificationEvent>

Hierarchy

TypedEventEmitter<Events | VerificationEvent, Arguments, VerificationEventHandlerMap>
- VerificationBase

Constructors

constructor

new VerificationBase<Events, Arguments>(channel: IVerificationChannel, baseApis: MatrixClient, userId: string, deviceId: string, startEvent: null | MatrixEvent, request: VerificationRequest<IVerificationChannel>): VerificationBase<Events, Arguments>
Base class for verification methods.

Once a verifier object is created, the verification can be started by calling the verify() method, which will return a promise that will resolve when the verification is completed, or reject if it could not complete.

Subclasses must have a NAME class property.
Type Parameters
- Events extends string
- Arguments extends ListenerMap<Cancel | Events>
Parameters
- channel: IVerificationChannel
  
  the verification channel to send verification messages over. TODO: Channel types
- baseApis: MatrixClient
  
  base matrix api interface
- userId: string
  
  the user ID that is being verified
- deviceId: string
  
  the device ID that is being verified
- startEvent: null | MatrixEvent
  
  the m.key.verification.start event that initiated this verification, if any
- request: VerificationRequest<IVerificationChannel>
  
  the key verification request object related to this verification, if any
Returns VerificationBase<Events, Arguments>
Overrides TypedEventEmitter.constructor
- Defined in src/crypto/verification/Base.ts:91

Properties

`Private` _done

_done: boolean = false

`Readonly` baseApis

baseApis: MatrixClient

base matrix api interface

`Private` cancelled

cancelled: boolean = false

`Readonly` channel

channel: IVerificationChannel

the verification channel to send verification messages over. TODO: Channel types

`Readonly` deviceId

deviceId: string

the device ID that is being verified

`Protected` `Optional` doVerification

doVerification?: (() => Promise<void>)

Type declaration

- (): Promise<void>
- Returns Promise<void>

`Protected` `Optional` expectedEvent

expectedEvent?: string

`Private` promise

promise: null | Promise<void> = null

`Private` `Optional` reject

reject?: ((e: Error | MatrixEvent) => void)

Type declaration

- (e: Error | MatrixEvent): void
- Parameters
  - e: Error | MatrixEvent
  Returns void

`Private` `Optional` rejectEvent

rejectEvent?: ((e: Error) => void)

Type declaration

- (e: Error): void
- Parameters
  - e: Error
  Returns void

`Readonly` request

request: VerificationRequest<IVerificationChannel>

the key verification request object related to this verification, if any

`Private` `Optional` resolve

resolve?: (() => void)

Type declaration

- (): void
- Returns void

`Private` `Optional` resolveEvent

resolveEvent?: ((e: MatrixEvent) => void)

Type declaration

- (e: MatrixEvent): void
- Parameters
  - e: MatrixEvent
  Returns void

startEvent

startEvent: null | MatrixEvent

the m.key.verification.start event that initiated this verification, if any

`Private` `Optional` started

started?: boolean

`Private` transactionTimeoutTimer

transactionTimeoutTimer: null | Timeout = null

`Readonly` userId

userId: string

the user ID that is being verified

Accessors

events

get events(): undefined | string[]
Returns undefined | string[]
- Defined in src/crypto/verification/Base.ts:366

hasBeenCancelled

get hasBeenCancelled(): boolean
Returns boolean
- Defined in src/crypto/verification/Base.ts:114

initiatedByMe

get initiatedByMe(): boolean
Returns boolean
- Defined in src/crypto/verification/Base.ts:102

Methods

addListener

addListener<T>(event: T, listener: Listener<Cancel | Events, Arguments, T>): VerificationBase<Events, Arguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Cancel | Events, Arguments, T>
Returns VerificationBase<Events, Arguments>
Inherited from TypedEventEmitter.addListener
- Defined in src/models/typed-event-emitter.ts:49

canSwitchStartEvent

canSwitchStartEvent(event: MatrixEvent): boolean
Parameters
- event: MatrixEvent
Returns boolean
- Defined in src/crypto/verification/Base.ts:158

cancel

cancel(e: Error | MatrixEvent): void
Parameters
- e: Error | MatrixEvent
Returns void
- Defined in src/crypto/verification/Base.ts:223

done

done(): Promise<void | KeysDuringVerification>
Returns Promise<void | KeysDuringVerification>
- Defined in src/crypto/verification/Base.ts:214

emit

emit<T>(event: T, ...args: Parameters<VerificationEventHandlerMap[T]>): boolean
Type Parameters
- T extends string
Parameters
- event: T
- Rest ...args: Parameters<VerificationEventHandlerMap[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:56
emit<T>(event: T, ...args: Parameters<Arguments[T]>): boolean
Type Parameters
- T extends string
Parameters
- event: T
- Rest ...args: Parameters<Arguments[T]>
Returns boolean
Inherited from TypedEventEmitter.emit
- Defined in src/models/typed-event-emitter.ts:57

`Private` endTimer

endTimer(): void
Returns void
- Defined in src/crypto/verification/Base.ts:131

handleEvent

handleEvent(e: MatrixEvent): void
Parameters
- e: MatrixEvent
Returns void
- Defined in src/crypto/verification/Base.ts:175

listenerCount

listenerCount(event: EventEmitterEvents | Cancel | Events): number
Parameters
- event: EventEmitterEvents | Cancel | Events
Returns number
Inherited from TypedEventEmitter.listenerCount
- Defined in src/models/typed-event-emitter.ts:62

listeners

listeners(event: EventEmitterEvents | Cancel | Events): Function[]
Parameters
- event: EventEmitterEvents | Cancel | Events
Returns Function[]
Inherited from TypedEventEmitter.listeners
- Defined in src/models/typed-event-emitter.ts:66

off

off<T>(event: T, listener: Listener<Cancel | Events, Arguments, T>): VerificationBase<Events, Arguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Cancel | Events, Arguments, T>
Returns VerificationBase<Events, Arguments>
Inherited from TypedEventEmitter.off
- Defined in src/models/typed-event-emitter.ts:70

on

on<T>(event: T, listener: Listener<Cancel | Events, Arguments, T>): VerificationBase<Events, Arguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Cancel | Events, Arguments, T>
Returns VerificationBase<Events, Arguments>
Inherited from TypedEventEmitter.on
- Defined in src/models/typed-event-emitter.ts:74

once

once<T>(event: T, listener: Listener<Cancel | Events, Arguments, T>): VerificationBase<Events, Arguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Cancel | Events, Arguments, T>
Returns VerificationBase<Events, Arguments>
Inherited from TypedEventEmitter.once
- Defined in src/models/typed-event-emitter.ts:78

prependListener

prependListener<T>(event: T, listener: Listener<Cancel | Events, Arguments, T>): VerificationBase<Events, Arguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Cancel | Events, Arguments, T>
Returns VerificationBase<Events, Arguments>
Inherited from TypedEventEmitter.prependListener
- Defined in src/models/typed-event-emitter.ts:82

prependOnceListener

prependOnceListener<T>(event: T, listener: Listener<Cancel | Events, Arguments, T>): VerificationBase<Events, Arguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Cancel | Events, Arguments, T>
Returns VerificationBase<Events, Arguments>
Inherited from TypedEventEmitter.prependOnceListener
- Defined in src/models/typed-event-emitter.ts:89

rawListeners

rawListeners(event: EventEmitterEvents | Cancel | Events): Function[]
Parameters
- event: EventEmitterEvents | Cancel | Events
Returns Function[]
Inherited from TypedEventEmitter.rawListeners
- Defined in src/models/typed-event-emitter.ts:107

removeAllListeners

removeAllListeners(event?: EventEmitterEvents | Cancel | Events): VerificationBase<Events, Arguments>
Parameters
- Optional event: EventEmitterEvents | Cancel | Events
Returns VerificationBase<Events, Arguments>
Inherited from TypedEventEmitter.removeAllListeners
- Defined in src/models/typed-event-emitter.ts:96

removeListener

removeListener<T>(event: T, listener: Listener<Cancel | Events, Arguments, T>): VerificationBase<Events, Arguments>
Type Parameters
- T extends string
Parameters
- event: T
- listener: Listener<Cancel | Events, Arguments, T>
Returns VerificationBase<Events, Arguments>
Inherited from TypedEventEmitter.removeListener
- Defined in src/models/typed-event-emitter.ts:100

`Private` resetTimer

resetTimer(): void
Returns void
- Defined in src/crypto/verification/Base.ts:118

`Protected` send

send(type: string, uncompletedContent: Record<string, any>): Promise<void>
Parameters
- type: string
- uncompletedContent: Record<string, any>
Returns Promise<void>
- Defined in src/crypto/verification/Base.ts:138

switchStartEvent

switchStartEvent(event: MatrixEvent): void
Parameters
- event: MatrixEvent
Returns void
- Defined in src/crypto/verification/Base.ts:162

verify

verify(): Promise<void>
Begin the key verification

Returns
Promise which resolves when the verification has completed.

Returns Promise<void>
- Defined in src/crypto/verification/Base.ts:277

`Protected` verifyKeys

verifyKeys(userId: string, keys: Record<string, string>, verifier: KeyVerifier): Promise<void>
Parameters
- userId: string
- keys: Record<string, string>
- verifier: KeyVerifier
Returns Promise<void>
- Defined in src/crypto/verification/Base.ts:310

`Protected` waitForEvent

waitForEvent(type: string): Promise<MatrixEvent>
Parameters
- type: string
Returns Promise<MatrixEvent>
- Defined in src/crypto/verification/Base.ts:142

Class VerificationBase<Events, Arguments>

Type Parameters

Events extends string

Arguments extends ListenerMap<Events | VerificationEvent>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Events extends string

Arguments extends ListenerMap<Cancel | Events>

Parameters

channel: IVerificationChannel

baseApis: MatrixClient

userId: string

deviceId: string

startEvent: null | MatrixEvent

request: VerificationRequest<IVerificationChannel>

Returns VerificationBase<Events, Arguments>

Properties

Private _done

Readonly baseApis

Private cancelled

Readonly channel

Readonly deviceId

Protected Optional doVerification

Type declaration

Returns Promise<void>

Protected Optional expectedEvent

Private promise

Private Optional reject

Type declaration

Parameters

e: Error | MatrixEvent

Returns void

Private Optional rejectEvent

Type declaration

Parameters

e: Error

Returns void

Readonly request

Private Optional resolve

Type declaration

Returns void

Private Optional resolveEvent

Type declaration

Parameters

e: MatrixEvent

Returns void

startEvent

Private Optional started

Private transactionTimeoutTimer

Readonly userId

Accessors

events

Returns undefined | string[]

hasBeenCancelled

Returns boolean

initiatedByMe

Returns boolean

Methods

addListener

Type Parameters

T extends string

Parameters

event: T

listener: Listener<Cancel | Events, Arguments, T>

Returns VerificationBase<Events, Arguments>

canSwitchStartEvent

Parameters

event: MatrixEvent

Returns boolean

cancel

Parameters

e: Error | MatrixEvent

Returns void

`Private` _done

`Readonly` baseApis

`Private` cancelled

`Readonly` channel

`Readonly` deviceId

`Protected` `Optional` doVerification

`Protected` `Optional` expectedEvent

`Private` promise

`Private` `Optional` reject

`Private` `Optional` rejectEvent

`Readonly` request

`Private` `Optional` resolve

`Private` `Optional` resolveEvent

`Private` `Optional` started

`Private` transactionTimeoutTimer

`Readonly` userId

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

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

`Private` endTimer