class DAVESession

extends

EventEmitter

export declare class DAVESession extends EventEmitter

Manages the DAVE protocol group session.

Constructors

constructor(
protocolVersion: number
userId: string
channelId: string
options: DAVESessionOptions
)

Constructs a new instance of the DAVESession class

channelId : string

The channel id represented by this session.

optional
lastTransitionId? : number | undefined

The last transition id executed.

protocolVersion : number

The protocol version being used.

reinitializing : boolean

Whether this session is currently re-initializing due to an invalid transition.

session : SessionMethods | undefined

The underlying DAVE Session of this wrapper.

userId : string

The user id represented by this session.

readonly
voicePrivacyCode : string | null

The current voice privacy code of the session. Will be null if there is no session.

decrypt(
packet: Buffer
userId: string
) : Buffer | null

Decrypt a packet using end-to-end encryption.

Returns: The decrypted packet, or null if the decryption failed but should be ignored

destroy() : void

Resets the session.

encrypt(
packet: Buffer
) : Buffer

Encrypt a packet using end-to-end encryption.

executeTransition(
transitionId: number
) : boolean | undefined

Execute a transition.

getVerificationCode(
userId: string
) : Promise<string>

Gets the verification code for a user in the session.

prepareEpoch(
data: VoiceDavePrepareEpochData
) : void

Prepare for a new epoch.

prepareTransition(
data: VoiceDavePrepareTransitionData
) : boolean

Prepare for a transition.

Returns: Whether we should signal to the voice server that we are ready

processCommit(
payload: Buffer
) : TransitionResult

Processes a commit from the MLS group.

Returns: The transaction id and whether it was successful

processProposals(
payload: Buffer
connectedClients: Set<string>
) : Buffer | undefined

Processes proposals from the MLS group.

Returns: The payload to send back to the voice server, if there is one

processWelcome(
payload: Buffer
) : TransitionResult

Processes a welcome from the MLS group.

Returns: The transaction id and whether it was successful

recoverFromInvalidTransition(
transitionId: number
) : void

Recover from an invalid transition by re-initializing.

reinit() : void

Re-initializes (or initializes) the underlying session.

setExternalSender(
externalSender: Buffer
) : void

Set the external sender for this session.

Overload 1

Overload 2

Overload 3

Overload 4

class DAVESession

extends

Table of contents

Properties

Methods

Constructors

constructor(
protocolVersion: number
userId: string
channelId: string
options: DAVESessionOptions
)

Properties

channelId : string

optional
lastTransitionId? : number | undefined

protocolVersion : number

reinitializing : boolean

session : SessionMethods | undefined

userId : string

readonly
voicePrivacyCode : string | null

Methods

decrypt(
packet: Buffer
userId: string
) : Buffer | null

destroy() : void

encrypt(
packet: Buffer
) : Buffer

executeTransition(
transitionId: number
) : boolean | undefined

getVerificationCode(
userId: string
) : Promise<string>

prepareEpoch(
data: VoiceDavePrepareEpochData
) : void

prepareTransition(
data: VoiceDavePrepareTransitionData
) : boolean

processCommit(
payload: Buffer
) : TransitionResult

processProposals(
payload: Buffer
connectedClients: Set<string>
) : Buffer | undefined

processWelcome(
payload: Buffer
) : TransitionResult

recoverFromInvalidTransition(
transitionId: number
) : void

reinit() : void

setExternalSender(
externalSender: Buffer
) : void

on(
event: 'error'
listener: (error: Error) => void
) : this

class DAVESession

extends

Table of contents

Properties

Methods

Constructors

constructor(protocolVersion: numberuserId: stringchannelId: stringoptions: DAVESessionOptions)

Properties

channelId : string

optionallastTransitionId? : number | undefined

protocolVersion : number

reinitializing : boolean

session : SessionMethods | undefined

userId : string

readonlyvoicePrivacyCode : string | null

Methods

decrypt(packet: BufferuserId: string) : Buffer | null

destroy() : void

encrypt(packet: Buffer) : Buffer

executeTransition(transitionId: number) : boolean | undefined

getVerificationCode(userId: string) : Promise<string>

prepareEpoch(data: VoiceDavePrepareEpochData) : void

prepareTransition(data: VoiceDavePrepareTransitionData) : boolean

processCommit(payload: Buffer) : TransitionResult

processProposals(payload: BufferconnectedClients: Set<string>) : Buffer | undefined

processWelcome(payload: Buffer) : TransitionResult

recoverFromInvalidTransition(transitionId: number) : void

reinit() : void

setExternalSender(externalSender: Buffer) : void

on(event: 'error'listener: (error: Error) => void) : this

constructor(
protocolVersion: number
userId: string
channelId: string
options: DAVESessionOptions
)

optional
lastTransitionId? : number | undefined

readonly
voicePrivacyCode : string | null

decrypt(
packet: Buffer
userId: string
) : Buffer | null

encrypt(
packet: Buffer
) : Buffer

executeTransition(
transitionId: number
) : boolean | undefined

getVerificationCode(
userId: string
) : Promise<string>

prepareEpoch(
data: VoiceDavePrepareEpochData
) : void

prepareTransition(
data: VoiceDavePrepareTransitionData
) : boolean

processCommit(
payload: Buffer
) : TransitionResult

processProposals(
payload: Buffer
connectedClients: Set<string>
) : Buffer | undefined

processWelcome(
payload: Buffer
) : TransitionResult

recoverFromInvalidTransition(
transitionId: number
) : void

setExternalSender(
externalSender: Buffer
) : void

on(
event: 'error'
listener: (error: Error) => void
) : this