@types/office-js-preview 1.0.378 → 1.0.380
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 +89 -19
- office-js-preview/package.json +3 -3
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: Thu, 13 Apr 2023 21:02:45 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
|
@@ -718,7 +718,7 @@ declare namespace Office {
|
|
|
718
718
|
* This method only requests that the tab be registered. The actual registration is controlled by the Office application and may not be complete when the returned `Promise` object is resolved.
|
|
719
719
|
* For more information and code examples, see {@link https://learn.microsoft.com/office/dev/add-ins/design/contextual-tabs | Create custom contextual tabs}.
|
|
720
720
|
*
|
|
721
|
-
* @param tabDefinition - Specifies the tab's properties and child controls and their properties.
|
|
721
|
+
* @param tabDefinition - Specifies the tab's properties and child controls and their properties. This parameter isn't strongly typed because its shape is defined by a JSON schema that can be versioned. To create the parameter object, pass a JSON string that conforms to the Office {@link https://developer.microsoft.com/json-schemas/office-js/dynamic-ribbon.schema.json | dynamic-ribbon JSON schema} to `JSON.parse`, and then pass the returned object to this method. To get IntelliSense for the JSON in Visual Studio Code, see {@link https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings | Editing JSON with Visual Studio Code - JSON schemas and settings }.
|
|
722
722
|
*/
|
|
723
723
|
requestCreateControls(tabDefinition: Object): Promise<void>;
|
|
724
724
|
/**
|
|
@@ -9905,7 +9905,12 @@ declare namespace Office {
|
|
|
9905
9905
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
9906
9906
|
*
|
|
9907
9907
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
|
|
9908
|
-
*
|
|
9908
|
+
*
|
|
9909
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
9910
|
+
*
|
|
9911
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
9912
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
9913
|
+
*
|
|
9909
9914
|
* @beta
|
|
9910
9915
|
*/
|
|
9911
9916
|
sensitivityLabel: SensitivityLabel;
|
|
@@ -15230,7 +15235,12 @@ declare namespace Office {
|
|
|
15230
15235
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
15231
15236
|
*
|
|
15232
15237
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
|
|
15233
|
-
*
|
|
15238
|
+
*
|
|
15239
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
15240
|
+
*
|
|
15241
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
15242
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
15243
|
+
*
|
|
15234
15244
|
* @beta
|
|
15235
15245
|
*/
|
|
15236
15246
|
sensitivityLabel: SensitivityLabel;
|
|
@@ -18551,7 +18561,12 @@ declare namespace Office {
|
|
|
18551
18561
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18552
18562
|
*
|
|
18553
18563
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18554
|
-
*
|
|
18564
|
+
*
|
|
18565
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18566
|
+
*
|
|
18567
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18568
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18569
|
+
*
|
|
18555
18570
|
* @beta
|
|
18556
18571
|
*/
|
|
18557
18572
|
interface SensitivityLabel {
|
|
@@ -18564,13 +18579,18 @@ declare namespace Office {
|
|
|
18564
18579
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18565
18580
|
*
|
|
18566
18581
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18567
|
-
*
|
|
18582
|
+
*
|
|
18583
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18584
|
+
*
|
|
18585
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18586
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18587
|
+
*
|
|
18568
18588
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
18569
18589
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18570
18590
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18571
18591
|
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18572
18592
|
* `asyncResult.value` property.
|
|
18573
|
-
*
|
|
18593
|
+
*
|
|
18574
18594
|
* @beta
|
|
18575
18595
|
*/
|
|
18576
18596
|
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
@@ -18583,11 +18603,16 @@ declare namespace Office {
|
|
|
18583
18603
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18584
18604
|
*
|
|
18585
18605
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18586
|
-
*
|
|
18606
|
+
*
|
|
18607
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18608
|
+
*
|
|
18609
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18610
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18611
|
+
*
|
|
18587
18612
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18588
18613
|
* which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
|
|
18589
18614
|
* `asyncResult.value` property.
|
|
18590
|
-
*
|
|
18615
|
+
*
|
|
18591
18616
|
* @beta
|
|
18592
18617
|
*/
|
|
18593
18618
|
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
|
|
@@ -18600,8 +18625,13 @@ declare namespace Office {
|
|
|
18600
18625
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18601
18626
|
*
|
|
18602
18627
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18603
|
-
*
|
|
18628
|
+
*
|
|
18629
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18630
|
+
*
|
|
18604
18631
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18632
|
+
*
|
|
18633
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18634
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18605
18635
|
*
|
|
18606
18636
|
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18607
18637
|
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
@@ -18609,7 +18639,7 @@ declare namespace Office {
|
|
|
18609
18639
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18610
18640
|
* @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18611
18641
|
* which is an `Office.AsyncResult` object.
|
|
18612
|
-
*
|
|
18642
|
+
*
|
|
18613
18643
|
* @beta
|
|
18614
18644
|
*/
|
|
18615
18645
|
setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
@@ -18622,8 +18652,13 @@ declare namespace Office {
|
|
|
18622
18652
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18623
18653
|
*
|
|
18624
18654
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18625
|
-
*
|
|
18655
|
+
*
|
|
18656
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18657
|
+
*
|
|
18626
18658
|
* **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
|
|
18659
|
+
*
|
|
18660
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18661
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18627
18662
|
*
|
|
18628
18663
|
* @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
|
|
18629
18664
|
* unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
|
|
@@ -18640,7 +18675,12 @@ declare namespace Office {
|
|
|
18640
18675
|
*
|
|
18641
18676
|
* @remarks
|
|
18642
18677
|
* [Api set: Mailbox preview]
|
|
18643
|
-
*
|
|
18678
|
+
*
|
|
18679
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18680
|
+
*
|
|
18681
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18682
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18683
|
+
*
|
|
18644
18684
|
* @beta
|
|
18645
18685
|
*/
|
|
18646
18686
|
export interface SensitivityLabelChangedEventArgs {
|
|
@@ -18663,6 +18703,11 @@ declare namespace Office {
|
|
|
18663
18703
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18664
18704
|
*
|
|
18665
18705
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18706
|
+
*
|
|
18707
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18708
|
+
*
|
|
18709
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18710
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18666
18711
|
*
|
|
18667
18712
|
* @beta
|
|
18668
18713
|
*/
|
|
@@ -18709,7 +18754,12 @@ declare namespace Office {
|
|
|
18709
18754
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18710
18755
|
*
|
|
18711
18756
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18712
|
-
*
|
|
18757
|
+
*
|
|
18758
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18759
|
+
*
|
|
18760
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18761
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18762
|
+
*
|
|
18713
18763
|
* @beta
|
|
18714
18764
|
*/
|
|
18715
18765
|
export interface SensitivityLabelsCatalog {
|
|
@@ -18722,9 +18772,14 @@ declare namespace Office {
|
|
|
18722
18772
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18723
18773
|
*
|
|
18724
18774
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18725
|
-
*
|
|
18775
|
+
*
|
|
18776
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18777
|
+
*
|
|
18726
18778
|
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18727
|
-
*
|
|
18779
|
+
*
|
|
18780
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18781
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18782
|
+
*
|
|
18728
18783
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
18729
18784
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18730
18785
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
@@ -18743,8 +18798,13 @@ declare namespace Office {
|
|
|
18743
18798
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18744
18799
|
*
|
|
18745
18800
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18746
|
-
*
|
|
18801
|
+
*
|
|
18802
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18803
|
+
*
|
|
18747
18804
|
* **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
|
|
18805
|
+
*
|
|
18806
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18807
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18748
18808
|
*
|
|
18749
18809
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18750
18810
|
* which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
|
|
@@ -18765,7 +18825,12 @@ declare namespace Office {
|
|
|
18765
18825
|
*
|
|
18766
18826
|
* **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
|
|
18767
18827
|
* {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
|
|
18768
|
-
*
|
|
18828
|
+
*
|
|
18829
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18830
|
+
*
|
|
18831
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18832
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18833
|
+
*
|
|
18769
18834
|
* @param options - An object literal that contains one or more of the following properties:-
|
|
18770
18835
|
* `asyncContext`: Developers can provide any object they wish to access in the callback function.
|
|
18771
18836
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
@@ -18783,10 +18848,15 @@ declare namespace Office {
|
|
|
18783
18848
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
18784
18849
|
*
|
|
18785
18850
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
18786
|
-
*
|
|
18851
|
+
*
|
|
18787
18852
|
* **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
|
|
18788
18853
|
* {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
|
|
18789
|
-
*
|
|
18854
|
+
*
|
|
18855
|
+
* **Important**: To use the sensitivity label feature in your add-in, you must have a Microsoft 365 E5 subscription.
|
|
18856
|
+
*
|
|
18857
|
+
* To learn more about how to manage sensitivity labels in your add-in, see
|
|
18858
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/sensitivity-label | Manage the sensitivity label of your message or appointment in compose mode (preview)}.
|
|
18859
|
+
*
|
|
18790
18860
|
* @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
|
|
18791
18861
|
* which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
|
|
18792
18862
|
*
|
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.380",
|
|
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": "
|
|
49
|
-
"typeScriptVersion": "4.
|
|
48
|
+
"typesPublisherContentHash": "256759ce6cef15e36020eb5124f084d7a54c3f18f30c143e4e77839603252776",
|
|
49
|
+
"typeScriptVersion": "4.3"
|
|
50
50
|
}
|