Interface IVerificationChannel

interface IVerificationChannel {
    deviceId?: string;
    receiveStartFromOtherDevices?: boolean;
    request?: VerificationRequest<IVerificationChannel>;
    roomId?: string;
    transactionId?: string;
    userId?: string;
    canCreateRequest(type: string): boolean;
    completeContent(
        type: string,
        content: Record<string, any>,
    ): Record<string, any>;
    completedContentFromEvent(event: MatrixEvent): Record<string, any>;
    getTimestamp(event: MatrixEvent): number;
    handleEvent(
        event: MatrixEvent,
        request: VerificationRequest<IVerificationChannel>,
        isLiveEvent: boolean,
    ): Promise<void>;
    send(type: string, uncompletedContent: Record<string, any>): Promise<void>;
    sendCompleted(type: string, content: Record<string, any>): Promise<void>;
}

Implemented by

Index

Properties

deviceId? receiveStartFromOtherDevices? request? roomId? transactionId? userId?

Methods

canCreateRequest completeContent completedContentFromEvent getTimestamp handleEvent send sendCompleted

Properties

`Optional` `Readonly`deviceId

deviceId?: string

`Optional` `Readonly`receiveStartFromOtherDevices

receiveStartFromOtherDevices?: boolean

`Optional`request

request?: VerificationRequest<IVerificationChannel>

`Optional` `Readonly`roomId

roomId?: string

`Optional` `Readonly`transactionId

transactionId?: string

`Optional` `Readonly`userId

userId?: string

Methods

canCreateRequest

canCreateRequest(type: string): boolean
Parameters
- type: string
Returns boolean
- Defined in src/crypto/verification/request/Channel.ts:32

completeContent

completeContent(type: string, content: Record<string, any>): Record<string, any>
Parameters
- type: string
- content: Record<string, any>
Returns Record<string, any>
- Defined in src/crypto/verification/request/Channel.ts:29

completedContentFromEvent

completedContentFromEvent(event: MatrixEvent): Record<string, any>
Parameters
- event: MatrixEvent
Returns Record<string, any>
- Defined in src/crypto/verification/request/Channel.ts:31

getTimestamp

getTimestamp(event: MatrixEvent): number
Parameters
- event: MatrixEvent
Returns number
- Defined in src/crypto/verification/request/Channel.ts:27

handleEvent

handleEvent(
    event: MatrixEvent,
    request: VerificationRequest<IVerificationChannel>,
    isLiveEvent: boolean,
): Promise<void>
Parameters
- event: MatrixEvent
- request: VerificationRequest<IVerificationChannel>
- isLiveEvent: boolean
Returns Promise<void>
- Defined in src/crypto/verification/request/Channel.ts:33

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/request/Channel.ts:28

sendCompleted

sendCompleted(type: string, content: Record<string, any>): Promise<void>
Parameters
- type: string
- content: Record<string, any>
Returns Promise<void>
- Defined in src/crypto/verification/request/Channel.ts:30