@types/office-js-preview 1.0.371 → 1.0.373
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-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +30 -353
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
|
|
|
8
8
|
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
|
|
9
9
|
|
|
10
10
|
### Additional Details
|
|
11
|
-
* Last updated:
|
|
11
|
+
* Last updated: Tue, 31 Jan 2023 21:32:38 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -239,20 +239,17 @@ declare namespace Office {
|
|
|
239
239
|
*
|
|
240
240
|
* **Support details**
|
|
241
241
|
*
|
|
242
|
-
* A capital Y in the following matrix indicates that this object is supported in the corresponding Office application.
|
|
243
|
-
* An empty cell indicates that the Office application doesn't support this object.
|
|
244
|
-
*
|
|
245
242
|
* For more information about Office application and server requirements, see
|
|
246
243
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
247
244
|
*
|
|
248
245
|
* *Supported applications, by platform*
|
|
249
246
|
* <table>
|
|
250
247
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
251
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
252
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
253
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
254
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
255
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
248
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
249
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
250
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
251
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> Supported </td></tr>
|
|
252
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
256
253
|
* </table>
|
|
257
254
|
*/
|
|
258
255
|
var context: Context;
|
|
@@ -274,20 +271,17 @@ declare namespace Office {
|
|
|
274
271
|
*
|
|
275
272
|
* **Support details**
|
|
276
273
|
*
|
|
277
|
-
* A capital Y in the following matrix indicates that this function is supported in the corresponding Office application.
|
|
278
|
-
* An empty cell indicates that the Office application doesn't support this function.
|
|
279
|
-
*
|
|
280
274
|
* For more information about Office application and server requirements, see
|
|
281
275
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
282
276
|
*
|
|
283
277
|
* *Supported applications, by platform*
|
|
284
278
|
* <table>
|
|
285
279
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
286
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
287
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
288
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
289
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
290
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
280
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
281
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
282
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
283
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> Supported </td></tr>
|
|
284
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
291
285
|
* </table>
|
|
292
286
|
*
|
|
293
287
|
* @param reason Indicates how the app was initialized.
|
|
@@ -311,20 +305,17 @@ declare namespace Office {
|
|
|
311
305
|
*
|
|
312
306
|
* **Support details**
|
|
313
307
|
*
|
|
314
|
-
* A capital Y in the following matrix indicates that this function is supported in the corresponding Office application.
|
|
315
|
-
* An empty cell indicates that the Office application doesn't support this function.
|
|
316
|
-
*
|
|
317
308
|
* For more information about Office application and server requirements, see
|
|
318
309
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
319
310
|
*
|
|
320
311
|
* *Supported applications, by platform*
|
|
321
312
|
* <table>
|
|
322
313
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
323
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
324
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
325
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
326
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
327
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
314
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
315
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
316
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
317
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> </td></tr>
|
|
318
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
328
319
|
* </table>
|
|
329
320
|
*
|
|
330
321
|
* @param useShortNamespace True to use the shortcut alias; otherwise false to disable it. The default is true.
|
|
@@ -875,20 +866,17 @@ declare namespace Office {
|
|
|
875
866
|
*
|
|
876
867
|
* **Support details**
|
|
877
868
|
*
|
|
878
|
-
* A capital Y in the following matrix indicates that this property is supported in the corresponding Office application.
|
|
879
|
-
* An empty cell indicates that the Office application doesn't support this property.
|
|
880
|
-
*
|
|
881
869
|
* For more information about Office application and server requirements, see
|
|
882
870
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
883
871
|
*
|
|
884
872
|
* *Supported applications, by platform*
|
|
885
873
|
* <table>
|
|
886
874
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
887
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
888
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
889
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
890
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
891
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
875
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
876
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
877
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
878
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> </td></tr>
|
|
879
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> </td></tr>
|
|
892
880
|
* </table>
|
|
893
881
|
*/
|
|
894
882
|
contentLanguage: string;
|
|
@@ -916,20 +904,17 @@ declare namespace Office {
|
|
|
916
904
|
*
|
|
917
905
|
* **Support details**
|
|
918
906
|
*
|
|
919
|
-
* A capital Y in the following matrix indicates that this property is supported in the corresponding Office application.
|
|
920
|
-
* An empty cell indicates that the Office application doesn't support this property.
|
|
921
|
-
*
|
|
922
907
|
* For more information about Office application and server requirements, see
|
|
923
908
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
924
909
|
*
|
|
925
910
|
* *Supported applications, by platform*
|
|
926
911
|
* <table>
|
|
927
912
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th><th> Outlook on mobile devices </th><th> Office on Mac </th></tr>
|
|
928
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
929
|
-
* <tr><td><strong> Outlook </strong></td><td>
|
|
930
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
931
|
-
* <tr><td><strong> Project </strong></td><td>
|
|
932
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
913
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
914
|
+
* <tr><td><strong> Outlook </strong></td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td><td> Supported </td></tr>
|
|
915
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> Supported </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
916
|
+
* <tr><td><strong> Project </strong></td><td> Supported </td><td> </td><td> </td><td> </td><td> Supported </td></tr>
|
|
917
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> </td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
933
918
|
* </table>
|
|
934
919
|
*/
|
|
935
920
|
displayLanguage: string;
|
|
@@ -1002,19 +987,6 @@ declare namespace Office {
|
|
|
1002
987
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
1003
988
|
*/
|
|
1004
989
|
roamingSettings: Office.RoamingSettings;
|
|
1005
|
-
/**
|
|
1006
|
-
* Gets the object to check the status of the catalog of sensitivity labels in Outlook and retrieve all available
|
|
1007
|
-
* sensitivity labels if the catalog is enabled.
|
|
1008
|
-
*
|
|
1009
|
-
* @remarks
|
|
1010
|
-
*
|
|
1011
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
1012
|
-
*
|
|
1013
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
1014
|
-
*
|
|
1015
|
-
* @beta
|
|
1016
|
-
*/
|
|
1017
|
-
sensitivityLabelsCatalog: Office.SensitivityLabelsCatalog;
|
|
1018
990
|
/**
|
|
1019
991
|
* Specifies whether the platform and device allows touch interaction.
|
|
1020
992
|
* True if the add-in is running on a touch device, such as an iPad; false otherwise.
|
|
@@ -2008,10 +1980,10 @@ declare namespace Office {
|
|
|
2008
1980
|
* *Supported applications, by platform*
|
|
2009
1981
|
* <table>
|
|
2010
1982
|
* <tr><th> </th><th> Office on Windows </th><th> Office on the web </th></tr>
|
|
2011
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
1983
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> </td></tr>
|
|
2012
1984
|
* <tr><td><strong> Outlook </strong></td><td> Preview </td><td> </td></tr>
|
|
2013
|
-
* <tr><td><strong> PowerPoint </strong></td><td>
|
|
2014
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
1985
|
+
* <tr><td><strong> PowerPoint </strong></td><td> Supported </td><td> </td></tr>
|
|
1986
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> Supported </td></tr>
|
|
2015
1987
|
* </table>
|
|
2016
1988
|
*/
|
|
2017
1989
|
interface OfficeTheme {
|
|
@@ -2092,17 +2064,14 @@ declare namespace Office {
|
|
|
2092
2064
|
*
|
|
2093
2065
|
* **Support details**
|
|
2094
2066
|
*
|
|
2095
|
-
* A capital Y in the following matrix indicates that this function is supported in the corresponding Office application.
|
|
2096
|
-
* An empty cell indicates that the Office application doesn't support this function.
|
|
2097
|
-
*
|
|
2098
2067
|
* For more information about Office application and server requirements, see
|
|
2099
2068
|
* {@link https://learn.microsoft.com/office/dev/add-ins/concepts/requirements-for-running-office-add-ins | Requirements for running Office Add-ins}.
|
|
2100
2069
|
*
|
|
2101
2070
|
* *Supported applications, by platform*
|
|
2102
2071
|
* <table>
|
|
2103
2072
|
* <tr><th> </th><th> Office on Windows </th><th> Office in web browser </th><th> Office on iPad </th></tr>
|
|
2104
|
-
* <tr><td><strong> Excel </strong></td><td>
|
|
2105
|
-
* <tr><td><strong> Word </strong></td><td>
|
|
2073
|
+
* <tr><td><strong> Excel </strong></td><td> Supported </td><td> Supported </td><td> Supported </td></tr>
|
|
2074
|
+
* <tr><td><strong> Word </strong></td><td> Supported </td><td> </td><td> Supported </td></tr>
|
|
2106
2075
|
* </table>
|
|
2107
2076
|
*/
|
|
2108
2077
|
function select(expression: string, callback?: (result: AsyncResult<any>) => void): Binding;
|
|
@@ -2437,19 +2406,6 @@ declare namespace Office {
|
|
|
2437
2406
|
* [Api set: Mailbox preview]
|
|
2438
2407
|
*/
|
|
2439
2408
|
SelectedItemsChanged,
|
|
2440
|
-
/**
|
|
2441
|
-
* Occurs in Outlook when the sensitivity label of a message or appointment changes.
|
|
2442
|
-
* **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
|
|
2443
|
-
*
|
|
2444
|
-
* To add an event handler for the `SensitivityLabelChanged` event, use the `addHandlerAsync` method of the `Item` object.
|
|
2445
|
-
* The event handler receives an argument of type
|
|
2446
|
-
* {@link https://learn.microsoft.com/javascript/api/outlook/office.sensitivitylabelchangedeventargs?view=outlook-js-preview | Office.SensitivityLabelChangedEventArgs}.
|
|
2447
|
-
*
|
|
2448
|
-
* [Api set: Mailbox preview]
|
|
2449
|
-
*
|
|
2450
|
-
* @beta
|
|
2451
|
-
*/
|
|
2452
|
-
SensitivityLabelChanged,
|
|
2453
2409
|
/**
|
|
2454
2410
|
* A Settings.settingsChanged event was raised.
|
|
2455
2411
|
*
|
|
@@ -9914,19 +9870,6 @@ declare namespace Office {
|
|
|
9914
9870
|
* @beta
|
|
9915
9871
|
*/
|
|
9916
9872
|
sensitivity: Sensitivity;
|
|
9917
|
-
/**
|
|
9918
|
-
* Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of an appointment.
|
|
9919
|
-
*
|
|
9920
|
-
* @remarks
|
|
9921
|
-
* [Api set: Mailbox preview]
|
|
9922
|
-
*
|
|
9923
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
9924
|
-
*
|
|
9925
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
9926
|
-
*
|
|
9927
|
-
* @beta
|
|
9928
|
-
*/
|
|
9929
|
-
sensitivityLabel: SensitivityLabel;
|
|
9930
9873
|
/**
|
|
9931
9874
|
* Gets the ID of the series that an instance belongs to.
|
|
9932
9875
|
*
|
|
@@ -15239,19 +15182,6 @@ declare namespace Office {
|
|
|
15239
15182
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15240
15183
|
*/
|
|
15241
15184
|
notificationMessages: NotificationMessages;
|
|
15242
|
-
/**
|
|
15243
|
-
* Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.
|
|
15244
|
-
*
|
|
15245
|
-
* @remarks
|
|
15246
|
-
* [Api set: Mailbox preview]
|
|
15247
|
-
*
|
|
15248
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15249
|
-
*
|
|
15250
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15251
|
-
*
|
|
15252
|
-
* @beta
|
|
15253
|
-
*/
|
|
15254
|
-
sensitivityLabel: SensitivityLabel;
|
|
15255
15185
|
/**
|
|
15256
15186
|
* Gets the ID of the series that an instance belongs to.
|
|
15257
15187
|
*
|
|
@@ -18559,259 +18489,6 @@ declare namespace Office {
|
|
|
18559
18489
|
*/
|
|
18560
18490
|
setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18561
18491
|
}
|
|
18562
|
-
/**
|
|
18563
|
-
* Provides methods to get or set the sensitivity label of a message or appointment. For more information on sensitivity labels, see
|
|
18564
|
-
* {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | Learn about sensitivity labels}.
|
|
18565
|
-
*
|
|
18566
|
-
* @remarks
|
|
18567
|
-
* [Api set: Mailbox preview]
|
|
18568
|
-
*
|
|
18569
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18570
|
-
*
|
|
18571
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18572
|
-
*
|
|
18573
|
-
* @beta
|
|
18574
|
-
*/
|
|
18575
|
-
interface SensitivityLabel {
|
|
18576
|
-
/**
|
|
18577
|
-
* Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
|
|
18578
|
-
*
|
|
18579
|
-
* @remarks
|
|
18580
|
-
* [Api set: Mailbox preview]
|
|
18581
|
-
*
|
|
18582
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18583
|
-
*
|
|
18584
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18585
|
-
*
|
|
18586
|
-
* @param options - An object literal that contains one or more of the following properties:-
|
|
18587
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18588
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18589
|
-
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18590
|
-
* `asyncResult.value` property.
|
|
18591
|
-
*
|
|
18592
|
-
* @beta
|
|
18593
|
-
*/
|
|
18594
|
-
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18595
|
-
/**
|
|
18596
|
-
* Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
|
|
18597
|
-
*
|
|
18598
|
-
* @remarks
|
|
18599
|
-
* [Api set: Mailbox preview]
|
|
18600
|
-
*
|
|
18601
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18602
|
-
*
|
|
18603
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18604
|
-
*
|
|
18605
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18606
|
-
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18607
|
-
* `asyncResult.value` property.
|
|
18608
|
-
*
|
|
18609
|
-
* @beta
|
|
18610
|
-
*/
|
|
18611
|
-
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
18612
|
-
/**
|
|
18613
|
-
* Applies the specified sensitivity label to the message or appointment being composed.
|
|
18614
|
-
*
|
|
18615
|
-
* @remarks
|
|
18616
|
-
* [Api set: Mailbox preview]
|
|
18617
|
-
*
|
|
18618
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18619
|
-
*
|
|
18620
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18621
|
-
*
|
|
18622
|
-
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18623
|
-
*
|
|
18624
|
-
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18625
|
-
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
18626
|
-
* @param options - An object literal that contains one or more of the following properties:-
|
|
18627
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18628
|
-
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18629
|
-
* which is an `Office.AsyncResult` object.
|
|
18630
|
-
*
|
|
18631
|
-
* @beta
|
|
18632
|
-
*/
|
|
18633
|
-
setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18634
|
-
/**
|
|
18635
|
-
* Applies the specified sensitivity label to the message or appointment being composed.
|
|
18636
|
-
*
|
|
18637
|
-
* @remarks
|
|
18638
|
-
* [Api set: Mailbox preview]
|
|
18639
|
-
*
|
|
18640
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18641
|
-
*
|
|
18642
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18643
|
-
*
|
|
18644
|
-
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18645
|
-
*
|
|
18646
|
-
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18647
|
-
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
18648
|
-
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18649
|
-
* which is an `Office.AsyncResult` object.
|
|
18650
|
-
*
|
|
18651
|
-
* @beta
|
|
18652
|
-
*/
|
|
18653
|
-
setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
18654
|
-
}
|
|
18655
|
-
/**
|
|
18656
|
-
* Provides methods to check the status of the catalog of {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | sensitivity labels}
|
|
18657
|
-
* in Outlook and retrieve all available sensitivity labels if the catalog is enabled.
|
|
18658
|
-
*
|
|
18659
|
-
* @remarks
|
|
18660
|
-
* [Api set: Mailbox preview]
|
|
18661
|
-
*
|
|
18662
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18663
|
-
*
|
|
18664
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18665
|
-
*
|
|
18666
|
-
* @beta
|
|
18667
|
-
*/
|
|
18668
|
-
export interface SensitivityLabelsCatalog {
|
|
18669
|
-
/**
|
|
18670
|
-
* Gets all the sensitivity labels that are enabled in Outlook.
|
|
18671
|
-
*
|
|
18672
|
-
* @remarks
|
|
18673
|
-
* [Api set: Mailbox preview]
|
|
18674
|
-
*
|
|
18675
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18676
|
-
*
|
|
18677
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18678
|
-
*
|
|
18679
|
-
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18680
|
-
*
|
|
18681
|
-
* @param options - An object literal that contains one or more of the following properties:-
|
|
18682
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18683
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18684
|
-
* which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
|
|
18685
|
-
* `asyncResult.value` property.
|
|
18686
|
-
*
|
|
18687
|
-
* @beta
|
|
18688
|
-
*/
|
|
18689
|
-
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
|
|
18690
|
-
/**
|
|
18691
|
-
* Gets all the sensitivity labels that are enabled in Outlook.
|
|
18692
|
-
*
|
|
18693
|
-
* @remarks
|
|
18694
|
-
* [Api set: Mailbox preview]
|
|
18695
|
-
*
|
|
18696
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18697
|
-
*
|
|
18698
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18699
|
-
*
|
|
18700
|
-
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18701
|
-
*
|
|
18702
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18703
|
-
* which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
|
|
18704
|
-
* `asyncResult.value` property.
|
|
18705
|
-
*
|
|
18706
|
-
* @beta
|
|
18707
|
-
*/
|
|
18708
|
-
getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
|
|
18709
|
-
/**
|
|
18710
|
-
* Checks whether the catalog of sensitivity labels is enabled in Outlook.
|
|
18711
|
-
*
|
|
18712
|
-
* @remarks
|
|
18713
|
-
* [Api set: Mailbox preview]
|
|
18714
|
-
*
|
|
18715
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18716
|
-
*
|
|
18717
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18718
|
-
*
|
|
18719
|
-
* **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
|
|
18720
|
-
* {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
|
|
18721
|
-
*
|
|
18722
|
-
* @param options - An object literal that contains one or more of the following properties:-
|
|
18723
|
-
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18724
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18725
|
-
* which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
|
|
18726
|
-
*
|
|
18727
|
-
* @beta
|
|
18728
|
-
*/
|
|
18729
|
-
getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
18730
|
-
/**
|
|
18731
|
-
* Checks whether the catalog of sensitivity labels is enabled in Outlook.
|
|
18732
|
-
*
|
|
18733
|
-
* @remarks
|
|
18734
|
-
* [Api set: Mailbox preview]
|
|
18735
|
-
*
|
|
18736
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18737
|
-
*
|
|
18738
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18739
|
-
*
|
|
18740
|
-
* **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
|
|
18741
|
-
* {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
|
|
18742
|
-
*
|
|
18743
|
-
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18744
|
-
* which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
|
|
18745
|
-
*
|
|
18746
|
-
* @beta
|
|
18747
|
-
*/
|
|
18748
|
-
getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
|
|
18749
|
-
}
|
|
18750
|
-
/**
|
|
18751
|
-
* Provides the change status of the sensitivity label applied to a message or appointment in compose mode. This information is provided when the
|
|
18752
|
-
* `Office.EventType.SensitivityLabelChanged` event is raised.
|
|
18753
|
-
*
|
|
18754
|
-
* @remarks
|
|
18755
|
-
* [Api set: Mailbox preview]
|
|
18756
|
-
*
|
|
18757
|
-
* @beta
|
|
18758
|
-
*/
|
|
18759
|
-
export interface SensitivityLabelChangedEventArgs {
|
|
18760
|
-
/**
|
|
18761
|
-
* The type of event that was raised. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
|
|
18762
|
-
*
|
|
18763
|
-
* @remarks
|
|
18764
|
-
* [Api set: Mailbox preview]
|
|
18765
|
-
*
|
|
18766
|
-
* @beta
|
|
18767
|
-
*/
|
|
18768
|
-
type: "olkSensitivityLabelChanged";
|
|
18769
|
-
}
|
|
18770
|
-
/**
|
|
18771
|
-
* Represents the properties of available sensitivity labels in Outlook.
|
|
18772
|
-
*
|
|
18773
|
-
* @remarks
|
|
18774
|
-
* [Api set: Mailbox preview]
|
|
18775
|
-
*
|
|
18776
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18777
|
-
*
|
|
18778
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18779
|
-
*
|
|
18780
|
-
* @beta
|
|
18781
|
-
*/
|
|
18782
|
-
interface SensitivityLabelDetails {
|
|
18783
|
-
/**
|
|
18784
|
-
* The color of the sensitivity label.
|
|
18785
|
-
*
|
|
18786
|
-
* @beta
|
|
18787
|
-
*/
|
|
18788
|
-
color: string;
|
|
18789
|
-
/**
|
|
18790
|
-
* The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.
|
|
18791
|
-
* Returns `null` if a label doesn't have any sublabels.
|
|
18792
|
-
*
|
|
18793
|
-
* @beta
|
|
18794
|
-
*/
|
|
18795
|
-
children: SensitivityLabelDetails[];
|
|
18796
|
-
/**
|
|
18797
|
-
* The unique identifier (GUID) of the sensitivity label.
|
|
18798
|
-
*
|
|
18799
|
-
* @beta
|
|
18800
|
-
*/
|
|
18801
|
-
id: string;
|
|
18802
|
-
/**
|
|
18803
|
-
* The name of the sensitivity label.
|
|
18804
|
-
*
|
|
18805
|
-
* @beta
|
|
18806
|
-
*/
|
|
18807
|
-
name: string;
|
|
18808
|
-
/**
|
|
18809
|
-
* The description of the sensitivity label.
|
|
18810
|
-
*
|
|
18811
|
-
* @beta
|
|
18812
|
-
*/
|
|
18813
|
-
tooltip: string;
|
|
18814
|
-
}
|
|
18815
18492
|
/**
|
|
18816
18493
|
* The `SeriesTime` object provides methods to get and set the dates and times of appointments in a recurring series and get the dates and times
|
|
18817
18494
|
* of meeting requests in a recurring series.
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.373",
|
|
4
4
|
"description": "TypeScript definitions for Office.js",
|
|
5
5
|
"homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,6 +45,6 @@
|
|
|
45
45
|
},
|
|
46
46
|
"scripts": {},
|
|
47
47
|
"dependencies": {},
|
|
48
|
-
"typesPublisherContentHash": "
|
|
48
|
+
"typesPublisherContentHash": "8dedcc8ad63bb1852b6398d2adba6e2f66c609674850b8e7f5027920075f7f9e",
|
|
49
49
|
"typeScriptVersion": "4.2"
|
|
50
50
|
}
|