summaryrefslogtreecommitdiff
path: root/includes/external/matrix/node_modules/matrix-js-sdk/lib/rendezvous/RendezvousChannel.d.ts
blob: b125779ee22bc3d9f0491a65b066af041a1c3a15 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
import { RendezvousCode, RendezvousIntent, RendezvousFailureReason } from ".";
export interface RendezvousChannel<T> {
    /**
     * @returns the checksum/confirmation digits to be shown to the user
     */
    connect(): Promise<string>;
    /**
     * Send a payload via the channel.
     * @param data - payload to send
     */
    send(data: T): Promise<void>;
    /**
     * Receive a payload from the channel.
     * @returns the received payload
     */
    receive(): Promise<Partial<T> | undefined>;
    /**
     * Close the channel and clear up any resources.
     */
    close(): Promise<void>;
    /**
     * @returns a representation of the channel that can be encoded in a QR or similar
     */
    generateCode(intent: RendezvousIntent): Promise<RendezvousCode>;
    cancel(reason: RendezvousFailureReason): Promise<void>;
}
//# sourceMappingURL=RendezvousChannel.d.ts.map