@types/office-runtime 1.0.25 → 1.0.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
office-runtime/README.md CHANGED
@@ -8,7 +8,7 @@ This package contains type definitions for office-runtime (https://github.com/Of
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-runtime.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Thu, 14 Jul 2022 22:02:27 GMT
11
+ * Last updated: Thu, 08 Sep 2022 20:32:46 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `OfficeRuntime`
14
14
 
office-runtime/index.d.ts CHANGED
@@ -20,7 +20,8 @@ declare namespace OfficeRuntime {
20
20
  /**
21
21
  * Function that enables a pop up web dialog box.
22
22
  *
23
- * [Api set: SharedRuntime 1.1]
23
+ * @remarks
24
+ * [Api set: CustomFunctionsRuntime 1.1]
24
25
  *
25
26
  * @param url Must be a string.
26
27
  * @param options Optional parameter. Must be of type DisplayWebDialogOptions.
@@ -133,23 +134,37 @@ declare namespace OfficeRuntime {
133
134
  */
134
135
  getKeys(): Promise<string[]>;
135
136
  }
136
- /** Object representing the dialog box. */
137
+ /**
138
+ * Object representing the dialog box.
139
+ *
140
+ * @remarks
141
+ * [Api set: CustomFunctionsRuntime 1.1]
142
+ *
143
+ */
137
144
  interface Dialog {
138
145
  /**
139
146
  * Method to close a dialog box. Returns a Promise.
140
147
  *
141
- * [Api set: SharedRuntime 1.1]
148
+ * @remarks
149
+ * [Api set: CustomFunctionsRuntime 1.1]
142
150
  *
143
151
  */
144
152
  close(): Promise<void>;
145
153
  }
146
- /** Provides display options and actions a dialog box may take. */
154
+ /**
155
+ * Provides display options and actions a dialog box may take.
156
+ *
157
+ * @remarks
158
+ * [Api set: CustomFunctionsRuntime 1.1]
159
+ *
160
+ */
147
161
  interface DisplayWebDialogOptions {
148
162
  /**
149
163
  * Optional parameter that determines whether the dialog box displays as a popup (false) or within an IFrame (true).
150
164
  * This setting is only applicable to custom functions running on Excel Online.
151
165
  *
152
- * [Api set: SharedRuntime 1.1]
166
+ * @remarks
167
+ * [Api set: CustomFunctionsRuntime 1.1]
153
168
  *
154
169
  */
155
170
  displayInIFrame?: boolean;
@@ -157,7 +172,8 @@ declare namespace OfficeRuntime {
157
172
  * Optional parameter that defines the height of the dialog box as a percentage of the current display.
158
173
  * For example, accepts strings such as: '50%', '50'.
159
174
  *
160
- * [Api set: SharedRuntime 1.1]
175
+ * @remarks
176
+ * [Api set: CustomFunctionsRuntime 1.1]
161
177
  *
162
178
  */
163
179
  height?: string;
@@ -165,28 +181,32 @@ declare namespace OfficeRuntime {
165
181
  * Optional parameter that defines the width of dialog as a percentage of window.
166
182
  * For example, accepts strings such as: '50%', '50'.
167
183
  *
168
- * [Api set: SharedRuntime 1.1]
184
+ * @remarks
185
+ * [Api set: CustomFunctionsRuntime 1.1]
169
186
  *
170
187
  */
171
188
  width?: string;
172
189
  /**
173
190
  * Optional callback that runs when the dialog box sends a message to its parent.
174
191
  *
175
- * [Api set: SharedRuntime 1.1]
192
+ * @remarks
193
+ * [Api set: CustomFunctionsRuntime 1.1]
176
194
  *
177
195
  */
178
196
  onMessage?: (message: string, dialog?: Dialog) => void;
179
197
  /**
180
198
  * Optional callback that runs when the dialog box is closed.
181
199
  *
182
- * [Api set: SharedRuntime 1.1]
200
+ * @remarks
201
+ * [Api set: CustomFunctionsRuntime 1.1]
183
202
  *
184
203
  */
185
204
  onClose?: () => void;
186
205
  /**
187
206
  * Optional callback that runs when the dialog box sends an error.
188
207
  *
189
- * [Api set: SharedRuntime 1.1]
208
+ * @remarks
209
+ * [Api set: CustomFunctionsRuntime 1.1]
190
210
  *
191
211
  */
192
212
  onRuntimeError?: (error: Error, dialog?: Dialog) => void;
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-runtime",
3
- "version": "1.0.25",
3
+ "version": "1.0.26",
4
4
  "description": "TypeScript definitions for office-runtime",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-runtime",
6
6
  "license": "MIT",
@@ -40,6 +40,6 @@
40
40
  },
41
41
  "scripts": {},
42
42
  "dependencies": {},
43
- "typesPublisherContentHash": "411de12567453639065511b1219d785a256c1c089b94c2e3f1d8807502b5777e",
44
- "typeScriptVersion": "4.0"
43
+ "typesPublisherContentHash": "792f2ed71875e61e1d93e9a38f216e7d0cdd30c8a3f550d5afb7bf97573802dd",
44
+ "typeScriptVersion": "4.1"
45
45
  }