@types/office-js-preview 1.0.370 → 1.0.372

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.
@@ -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: Wed, 25 Jan 2023 00:02:39 GMT
11
+ * Last updated: Fri, 27 Jan 2023 19:02:33 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -1002,19 +1002,6 @@ declare namespace Office {
1002
1002
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
1003
1003
  */
1004
1004
  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
1005
  /**
1019
1006
  * Specifies whether the platform and device allows touch interaction.
1020
1007
  * True if the add-in is running on a touch device, such as an iPad; false otherwise.
@@ -2005,9 +1992,14 @@ declare namespace Office {
2005
1992
  *
2006
1993
  * @remarks
2007
1994
  *
2008
- * **Applications**: Excel, Outlook (in preview), PowerPoint, Word
2009
- *
2010
- * `OfficeTheme` is only supported in Office on Windows, Mac, and the web.
1995
+ * *Supported applications, by platform*
1996
+ * <table>
1997
+ * <tr><th> </th><th> Office on Windows </th><th> Office on the web </th></tr>
1998
+ * <tr><td><strong> Excel </strong></td><td> Y </td><td> </td></tr>
1999
+ * <tr><td><strong> Outlook </strong></td><td> Preview </td><td> </td></tr>
2000
+ * <tr><td><strong> PowerPoint </strong></td><td> Y </td><td> </td></tr>
2001
+ * <tr><td><strong> Word </strong></td><td> Y </td><td> Y </td></tr>
2002
+ * </table>
2011
2003
  */
2012
2004
  interface OfficeTheme {
2013
2005
  /**
@@ -2432,19 +2424,6 @@ declare namespace Office {
2432
2424
  * [Api set: Mailbox preview]
2433
2425
  */
2434
2426
  SelectedItemsChanged,
2435
- /**
2436
- * Occurs in Outlook when the sensitivity label of a message or appointment changes.
2437
- * **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
2438
- *
2439
- * To add an event handler for the `SensitivityLabelChanged` event, use the `addHandlerAsync` method of the `Item` object.
2440
- * The event handler receives an argument of type
2441
- * {@link https://learn.microsoft.com/javascript/api/outlook/office.sensitivitylabelchangedeventargs?view=outlook-js-preview | Office.SensitivityLabelChangedEventArgs}.
2442
- *
2443
- * [Api set: Mailbox preview]
2444
- *
2445
- * @beta
2446
- */
2447
- SensitivityLabelChanged,
2448
2427
  /**
2449
2428
  * A Settings.settingsChanged event was raised.
2450
2429
  *
@@ -9909,19 +9888,6 @@ declare namespace Office {
9909
9888
  * @beta
9910
9889
  */
9911
9890
  sensitivity: Sensitivity;
9912
- /**
9913
- * Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of an appointment.
9914
- *
9915
- * @remarks
9916
- * [Api set: Mailbox preview]
9917
- *
9918
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
9919
- *
9920
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
9921
- *
9922
- * @beta
9923
- */
9924
- sensitivityLabel: SensitivityLabel;
9925
9891
  /**
9926
9892
  * Gets the ID of the series that an instance belongs to.
9927
9893
  *
@@ -15234,19 +15200,6 @@ declare namespace Office {
15234
15200
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15235
15201
  */
15236
15202
  notificationMessages: NotificationMessages;
15237
- /**
15238
- * Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.
15239
- *
15240
- * @remarks
15241
- * [Api set: Mailbox preview]
15242
- *
15243
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
15244
- *
15245
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15246
- *
15247
- * @beta
15248
- */
15249
- sensitivityLabel: SensitivityLabel;
15250
15203
  /**
15251
15204
  * Gets the ID of the series that an instance belongs to.
15252
15205
  *
@@ -18554,259 +18507,6 @@ declare namespace Office {
18554
18507
  */
18555
18508
  setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18556
18509
  }
18557
- /**
18558
- * Provides methods to get or set the sensitivity label of a message or appointment. For more information on sensitivity labels, see
18559
- * {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | Learn about sensitivity labels}.
18560
- *
18561
- * @remarks
18562
- * [Api set: Mailbox preview]
18563
- *
18564
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18565
- *
18566
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18567
- *
18568
- * @beta
18569
- */
18570
- interface SensitivityLabel {
18571
- /**
18572
- * Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
18573
- *
18574
- * @remarks
18575
- * [Api set: Mailbox preview]
18576
- *
18577
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18578
- *
18579
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18580
- *
18581
- * @param options - An object literal that contains one or more of the following properties:-
18582
- * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18583
- * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18584
- * which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
18585
- * `asyncResult.value` property.
18586
- *
18587
- * @beta
18588
- */
18589
- getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
18590
- /**
18591
- * Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
18592
- *
18593
- * @remarks
18594
- * [Api set: Mailbox preview]
18595
- *
18596
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18597
- *
18598
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18599
- *
18600
- * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18601
- * which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
18602
- * `asyncResult.value` property.
18603
- *
18604
- * @beta
18605
- */
18606
- getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
18607
- /**
18608
- * Applies the specified sensitivity label to the message or appointment being composed.
18609
- *
18610
- * @remarks
18611
- * [Api set: Mailbox preview]
18612
- *
18613
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18614
- *
18615
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18616
- *
18617
- * **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
18618
- *
18619
- * @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
18620
- * unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
18621
- * @param options - An object literal that contains one or more of the following properties:-
18622
- * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18623
- * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18624
- * which is an `Office.AsyncResult` object.
18625
- *
18626
- * @beta
18627
- */
18628
- setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18629
- /**
18630
- * Applies the specified sensitivity label to the message or appointment being composed.
18631
- *
18632
- * @remarks
18633
- * [Api set: Mailbox preview]
18634
- *
18635
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18636
- *
18637
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18638
- *
18639
- * **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
18640
- *
18641
- * @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
18642
- * unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
18643
- * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18644
- * which is an `Office.AsyncResult` object.
18645
- *
18646
- * @beta
18647
- */
18648
- setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18649
- }
18650
- /**
18651
- * Provides methods to check the status of the catalog of {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | sensitivity labels}
18652
- * in Outlook and retrieve all available sensitivity labels if the catalog is enabled.
18653
- *
18654
- * @remarks
18655
- * [Api set: Mailbox preview]
18656
- *
18657
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18658
- *
18659
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18660
- *
18661
- * @beta
18662
- */
18663
- export interface SensitivityLabelsCatalog {
18664
- /**
18665
- * Gets all the sensitivity labels that are enabled in Outlook.
18666
- *
18667
- * @remarks
18668
- * [Api set: Mailbox preview]
18669
- *
18670
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18671
- *
18672
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18673
- *
18674
- * **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
18675
- *
18676
- * @param options - An object literal that contains one or more of the following properties:-
18677
- * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18678
- * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18679
- * which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
18680
- * `asyncResult.value` property.
18681
- *
18682
- * @beta
18683
- */
18684
- getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
18685
- /**
18686
- * Gets all the sensitivity labels that are enabled in Outlook.
18687
- *
18688
- * @remarks
18689
- * [Api set: Mailbox preview]
18690
- *
18691
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18692
- *
18693
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18694
- *
18695
- * **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
18696
- *
18697
- * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18698
- * which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
18699
- * `asyncResult.value` property.
18700
- *
18701
- * @beta
18702
- */
18703
- getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
18704
- /**
18705
- * Checks whether the catalog of sensitivity labels is enabled in Outlook.
18706
- *
18707
- * @remarks
18708
- * [Api set: Mailbox preview]
18709
- *
18710
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18711
- *
18712
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18713
- *
18714
- * **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
18715
- * {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
18716
- *
18717
- * @param options - An object literal that contains one or more of the following properties:-
18718
- * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18719
- * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18720
- * which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
18721
- *
18722
- * @beta
18723
- */
18724
- getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
18725
- /**
18726
- * Checks whether the catalog of sensitivity labels is enabled in Outlook.
18727
- *
18728
- * @remarks
18729
- * [Api set: Mailbox preview]
18730
- *
18731
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18732
- *
18733
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18734
- *
18735
- * **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
18736
- * {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
18737
- *
18738
- * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18739
- * which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
18740
- *
18741
- * @beta
18742
- */
18743
- getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
18744
- }
18745
- /**
18746
- * Provides the change status of the sensitivity label applied to a message or appointment in compose mode. This information is provided when the
18747
- * `Office.EventType.SensitivityLabelChanged` event is raised.
18748
- *
18749
- * @remarks
18750
- * [Api set: Mailbox preview]
18751
- *
18752
- * @beta
18753
- */
18754
- export interface SensitivityLabelChangedEventArgs {
18755
- /**
18756
- * The type of event that was raised. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
18757
- *
18758
- * @remarks
18759
- * [Api set: Mailbox preview]
18760
- *
18761
- * @beta
18762
- */
18763
- type: "olkSensitivityLabelChanged";
18764
- }
18765
- /**
18766
- * Represents the properties of available sensitivity labels in Outlook.
18767
- *
18768
- * @remarks
18769
- * [Api set: Mailbox preview]
18770
- *
18771
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18772
- *
18773
- * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18774
- *
18775
- * @beta
18776
- */
18777
- interface SensitivityLabelDetails {
18778
- /**
18779
- * The color of the sensitivity label.
18780
- *
18781
- * @beta
18782
- */
18783
- color: string;
18784
- /**
18785
- * The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.
18786
- * Returns `null` if a label doesn't have any sublabels.
18787
- *
18788
- * @beta
18789
- */
18790
- children: SensitivityLabelDetails[];
18791
- /**
18792
- * The unique identifier (GUID) of the sensitivity label.
18793
- *
18794
- * @beta
18795
- */
18796
- id: string;
18797
- /**
18798
- * The name of the sensitivity label.
18799
- *
18800
- * @beta
18801
- */
18802
- name: string;
18803
- /**
18804
- * The description of the sensitivity label.
18805
- *
18806
- * @beta
18807
- */
18808
- tooltip: string;
18809
- }
18810
18510
  /**
18811
18511
  * 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
18812
18512
  * of meeting requests in a recurring series.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.370",
3
+ "version": "1.0.372",
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": "77e4d0fc18db24f73ccec1ab487dcafcda5813fa6bbc49e0d7295c36f1ba4ec3",
48
+ "typesPublisherContentHash": "210f600254c085ad5146acbeb954b0ab074752200829a7e0e326e45e76e78581",
49
49
  "typeScriptVersion": "4.2"
50
50
  }