blob: 549ebc83f519cacaca7b16d41acd67c56c764c36 (
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
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
/*
Copyright 2022 The Matrix.org Foundation C.I.C.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
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>;
}
|
