blob: a6ee6703d484036fa5732444c2eeb4ae32e9255a (
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
/*
* Copyright 2020 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 { WidgetType } from "./WidgetType";
/**
* Widget data.
*/
export interface IWidgetData {
/**
* Optional title for the widget.
*/
title?: string;
/**
* Custom keys for inclusion in the template URL.
*/
[key: string]: unknown;
}
/**
* Common properties of a widget.
* https://matrix.org/docs/spec/widgets/latest#widgetcommonproperties-schema
*/
export interface IWidget {
/**
* The ID of the widget.
*/
id: string;
/**
* The user ID who originally created the widget.
*/
creatorUserId: string;
/**
* Optional name for the widget.
*/
name?: string;
/**
* The type of widget.
*/
type: WidgetType;
/**
* The URL for the widget, with template variables.
*/
url: string;
/**
* Optional flag to indicate whether or not the client should initiate communication
* right after the iframe loads (default, true) or when the widget indicates it is
* ready (false).
*/
waitForIframeLoad?: boolean;
/**
* Data for the widget.
*/
data?: IWidgetData;
}
|
