Class ToDeviceChannel

constructor

• new ToDeviceChannel(
      client: MatrixClient,
      userId: string,
      devices: string[],
      transactionId?: string,
      deviceId?: string,
  ): ToDeviceChannel

• Parameters

  • client: MatrixClient
  • userId: string
  • devices: string[]
  • OptionaltransactionId: string
  • OptionaldeviceId: string

  Returns ToDeviceChannel

OptionaldeviceId

Optionalrequest

OptionaltransactionId

ReadonlyuserId

canCreateRequest

• canCreateRequest(type: string): boolean

• Parameters

  • type: string

  Returns boolean

completeContent

• completeContent(type: string, content: Record<string, any>): Record<string, any>

• Add all the fields to content needed for sending it over this channel. This is public so verification methods (SAS uses this) can get the exact content that will be sent independent of the used channel, as they need to calculate the hash of it.

  Parameters

  • type: string

    the event type
  • content: Record<string, any>

    the (incomplete) content

  Returns Record<string, any>

  the complete content, as it will be sent.

completedContentFromEvent

• completedContentFromEvent(event: MatrixEvent): Record<string, any>

• See InRoomChannel#completedContentFromEvent for why this is needed.

  Parameters

  • event: MatrixEvent

    the received event

  Returns Record<string, any>

  the content object

getTimestamp

• getTimestamp(event: MatrixEvent): number

• Parameters

  • event: MatrixEvent

    the event to get the timestamp of

  Returns number

  the timestamp when the event was sent

handleEvent

• handleEvent(
      event: MatrixEvent,
      request: Request,
      isLiveEvent?: boolean,
  ): Promise<void>

• Changes the state of the channel, request, and verifier in response to a key verification event.

  Parameters

  • event: MatrixEvent

    to handle
  • request: Request

    the request to forward handling to
  • isLiveEvent: boolean = false

    whether this is an even received through sync or not

  Returns Promise<void>

  a promise that resolves when any requests as an answer to the passed-in event are sent.

isToDevices

• isToDevices(devices: string[]): boolean

• Parameters

  • devices: string[]

  Returns boolean

send

• send(type: string, uncompletedContent?: Record<string, any>): Promise<void>

• Send an event over the channel with the content not having gone through completeContent.

  Parameters

  • type: string

    the event type
  • uncompletedContent: Record<string, any> = {}

    the (incomplete) content

  Returns Promise<void>

  the promise of the request

sendCompleted

• sendCompleted(type: string, content: Record<string, any>): Promise<void>

• Send an event over the channel with the content having gone through completeContent already.

  Parameters

  • type: string

    the event type
  • content: Record<string, any>

  Returns Promise<void>

  the promise of the request

StaticcanCreateRequest

• canCreateRequest(type: string): boolean

• Checks whether the given event type should be allowed to initiate a new VerificationRequest over this channel

  Parameters

  • type: string

    the event type to check

  Returns boolean

  boolean flag

StaticgetEventType

• getEventType(event: MatrixEvent): string

• Parameters

  • event: MatrixEvent

  Returns string

StaticgetTransactionId

• getTransactionId(event: MatrixEvent): string

• Extract the transaction id used by a given key verification event, if any

  Parameters

  • event: MatrixEvent

    the event

  Returns string

  the transaction id

StaticmakeTransactionId

• makeTransactionId(): string

• Allow Crypto module to create and know the transaction id before the .start event gets sent.

  Returns string

  the transaction id

StaticvalidateEvent

• validateEvent(event: MatrixEvent, client: MatrixClient): boolean

• Checks whether this event is a well-formed key verification event. This only does checks that don't rely on the current state of a potentially already channel so we can prevent channels being created by invalid events. handleEvent can do more checks and choose to ignore invalid events.

  Parameters

  • event: MatrixEvent

    the event to validate
  • client: MatrixClient

    the client to get the current user and device id from

  Returns boolean

  whether the event is valid and should be passed to handleEvent