@types/office-js-preview 1.0.371 → 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: Thu, 26 Jan 2023 20:02:48 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.
@@ -2437,19 +2424,6 @@ declare namespace Office {
2437
2424
  * [Api set: Mailbox preview]
2438
2425
  */
2439
2426
  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
2427
  /**
2454
2428
  * A Settings.settingsChanged event was raised.
2455
2429
  *
@@ -9914,19 +9888,6 @@ declare namespace Office {
9914
9888
  * @beta
9915
9889
  */
9916
9890
  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
9891
  /**
9931
9892
  * Gets the ID of the series that an instance belongs to.
9932
9893
  *
@@ -15239,19 +15200,6 @@ declare namespace Office {
15239
15200
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15240
15201
  */
15241
15202
  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
15203
  /**
15256
15204
  * Gets the ID of the series that an instance belongs to.
15257
15205
  *
@@ -18559,259 +18507,6 @@ declare namespace Office {
18559
18507
  */
18560
18508
  setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18561
18509
  }
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
18510
  /**
18816
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
18817
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.371",
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": "150ed8384d94aab1f910118078762bc1e72fd42b996991dddec0478a9785286b",
48
+ "typesPublisherContentHash": "210f600254c085ad5146acbeb954b0ab074752200829a7e0e326e45e76e78581",
49
49
  "typeScriptVersion": "4.2"
50
50
  }