@types/office-js-preview 1.0.709 → 1.0.711
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 +1606 -164
- office-js-preview/package.json +3 -3
office-js-preview/index.d.ts
CHANGED
|
@@ -10822,7 +10822,7 @@ declare namespace Office {
|
|
|
10822
10822
|
* Specifies the status of Exchange Web Services (EWS) callback tokens or REST API tokens in an organization.
|
|
10823
10823
|
*
|
|
10824
10824
|
* @remarks
|
|
10825
|
-
* [Api set: Mailbox
|
|
10825
|
+
* [Api set: Mailbox 1.16]
|
|
10826
10826
|
*
|
|
10827
10827
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
10828
10828
|
*
|
|
@@ -10830,8 +10830,6 @@ declare namespace Office {
|
|
|
10830
10830
|
* If an Outlook add-in requires delegated user access or user identity, we recommend using MSAL (Microsoft Authentication Library) and nested app authentication (NAA).
|
|
10831
10831
|
* Exchange user identity tokens are still supported for Exchange on-premises. For more information, see
|
|
10832
10832
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | Nested app authentication FAQ}.
|
|
10833
|
-
*
|
|
10834
|
-
* @beta
|
|
10835
10833
|
*/
|
|
10836
10834
|
enum TokenStatus {
|
|
10837
10835
|
/**
|
|
@@ -11151,7 +11149,8 @@ declare namespace Office {
|
|
|
11151
11149
|
/**
|
|
11152
11150
|
* Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
|
|
11153
11151
|
*
|
|
11154
|
-
* **Important**:
|
|
11152
|
+
* **Important**: In Outlook clients that support Mailbox 1.15 or earlier, the entire SessionData object for each mail item is limited to 50,000 characters per add-in.
|
|
11153
|
+
* In clients that support Mailbox 1.16 or later, the character limit per add-in is 2,621,440 characters.
|
|
11155
11154
|
*
|
|
11156
11155
|
* @remarks
|
|
11157
11156
|
* [Api set: Mailbox 1.11]
|
|
@@ -12564,13 +12563,13 @@ declare namespace Office {
|
|
|
12564
12563
|
* The `optionalAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
12565
12564
|
* each optional attendee to the meeting. The maximum number of attendees returned varies per Outlook client.
|
|
12566
12565
|
*
|
|
12567
|
-
* - Windows (
|
|
12566
|
+
* - Windows (classic - Mailbox 1.15 and earlier): 500 attendees
|
|
12568
12567
|
*
|
|
12569
|
-
* - Windows (classic -
|
|
12568
|
+
* - Web, Windows (new, classic - Mailbox 1.16 and later): 1,000 recipients
|
|
12570
12569
|
*
|
|
12571
12570
|
* - Android, classic Mac UI, iOS: 100 attendees
|
|
12572
12571
|
*
|
|
12573
|
-
* - New Mac UI
|
|
12572
|
+
* - New Mac UI: No limit
|
|
12574
12573
|
*
|
|
12575
12574
|
* @remarks
|
|
12576
12575
|
*
|
|
@@ -12614,13 +12613,13 @@ declare namespace Office {
|
|
|
12614
12613
|
* The `requiredAttendees` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
12615
12614
|
* each required attendee to the meeting. The maximum number of attendees returned varies per Outlook client.
|
|
12616
12615
|
*
|
|
12617
|
-
* - Windows (
|
|
12616
|
+
* - Windows (classic - Mailbox 1.15 and earlier): 500 attendees
|
|
12618
12617
|
*
|
|
12619
|
-
* - Windows (classic -
|
|
12618
|
+
* - Web, Windows (new, classic - Mailbox 1.16 and later): 1,000 recipients
|
|
12620
12619
|
*
|
|
12621
12620
|
* - Android, classic Mac UI, iOS: 100 attendees
|
|
12622
12621
|
*
|
|
12623
|
-
* - New Mac UI
|
|
12622
|
+
* - New Mac UI: No limit
|
|
12624
12623
|
*
|
|
12625
12624
|
* @remarks
|
|
12626
12625
|
*
|
|
@@ -13414,18 +13413,15 @@ declare namespace Office {
|
|
|
13414
13413
|
* Gets the content identifier of an inline attachment.
|
|
13415
13414
|
*
|
|
13416
13415
|
* @remarks
|
|
13416
|
+
* [Api set: Mailbox 1.16]
|
|
13417
13417
|
*
|
|
13418
|
-
* **Important**:
|
|
13419
|
-
*
|
|
13420
|
-
* - The `contentId` property is only supported in Outlook on the web, the new Outlook on Windows, and classic Outlook on Windows (preview).
|
|
13421
|
-
* To preview the `contentId` property in classic Outlook on Windows, your Outlook client must run Version 2510 (Build 19312.20000)
|
|
13422
|
-
* or later and must be on the Beta Channel. For more information, see {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}.
|
|
13423
|
-
*
|
|
13424
|
-
* - Changes to how inline images are represented in the HTML body of Outlook emails in Outlook on the web and the new Outlook on Windows released on November 15, 2025.
|
|
13418
|
+
* **Important**: Changes to how inline images are represented in the HTML body of Outlook emails in
|
|
13419
|
+
* Outlook on the web and the new Outlook on Windows released on November 15, 2025.
|
|
13425
13420
|
* Previously, the attachment ID of the image appeared in the `src` attribute of the applicable `<img>` element.
|
|
13426
13421
|
* Now, the image is represented by a content ID (`cid`) in the `src` attribute instead.
|
|
13427
|
-
* If you parse the attachment ID from the HTML editor or get the Base64-encoded value of the image from the URL in the
|
|
13428
|
-
*
|
|
13422
|
+
* If you parse the attachment ID from the HTML editor or get the Base64-encoded value of the image from the URL in the
|
|
13423
|
+
* `src` attribute, you must update your add-in's parsing logic. For more information, see
|
|
13424
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-inline-images-in-outlook | Changes to inline image representation in Outlook on the web and new Outlook for Windows}.
|
|
13429
13425
|
*/
|
|
13430
13426
|
contentId: string;
|
|
13431
13427
|
/**
|
|
@@ -13517,18 +13513,15 @@ declare namespace Office {
|
|
|
13517
13513
|
* Gets the content identifier of an inline attachment.
|
|
13518
13514
|
*
|
|
13519
13515
|
* @remarks
|
|
13516
|
+
* [Api set: Mailbox 1.16]
|
|
13520
13517
|
*
|
|
13521
|
-
* **Important**:
|
|
13522
|
-
*
|
|
13523
|
-
* - The `contentId` property is only supported in Outlook on the web, the new Outlook on Windows, and classic Outlook on Windows (preview).
|
|
13524
|
-
* To preview the `contentId` property in classic Outlook on Windows, your Outlook client must run Version 2510 (Build 19312.20000)
|
|
13525
|
-
* or later and must be on the Beta Channel. For more information, see {@link https://aka.ms/Msft365InsiderProgram | Microsoft 365 Insider Program}.
|
|
13526
|
-
*
|
|
13527
|
-
* - Changes to how inline images are represented in the HTML body of Outlook emails in Outlook on the web and the new Outlook on Windows released on November 15, 2025.
|
|
13518
|
+
* **Important**: Changes to how inline images are represented in the HTML body of Outlook emails in
|
|
13519
|
+
* Outlook on the web and the new Outlook on Windows released on November 15, 2025.
|
|
13528
13520
|
* Previously, the attachment ID of the image appeared in the `src` attribute of the applicable `<img>` element.
|
|
13529
13521
|
* Now, the image is represented by a content ID (`cid`) in the `src` attribute instead.
|
|
13530
|
-
* If you parse the attachment ID from the HTML editor or get the Base64-encoded value of the image from the URL in the
|
|
13531
|
-
*
|
|
13522
|
+
* If you parse the attachment ID from the HTML editor or get the Base64-encoded value of the image from the URL in the
|
|
13523
|
+
* `src` attribute, you must update your add-in's parsing logic. For more information, see
|
|
13524
|
+
* {@link https://devblogs.microsoft.com/microsoft365dev/changes-to-inline-images-in-outlook | Changes to inline image representation in Outlook on the web and new Outlook for Windows}.
|
|
13532
13525
|
*/
|
|
13533
13526
|
contentId: string;
|
|
13534
13527
|
/**
|
|
@@ -14748,15 +14741,13 @@ declare namespace Office {
|
|
|
14748
14741
|
*
|
|
14749
14742
|
* @remarks
|
|
14750
14743
|
*
|
|
14751
|
-
* [Api set: Mailbox
|
|
14744
|
+
* [Api set: Mailbox 1.16]
|
|
14752
14745
|
*
|
|
14753
14746
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14754
14747
|
*
|
|
14755
14748
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14756
14749
|
*
|
|
14757
14750
|
* To learn how to develop an encryption add-in in Outlook, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | Create an encryption Outlook add-in}.
|
|
14758
|
-
*
|
|
14759
|
-
* @beta
|
|
14760
14751
|
*/
|
|
14761
14752
|
interface DecryptedMessageAttachment {
|
|
14762
14753
|
/**
|
|
@@ -14764,15 +14755,13 @@ declare namespace Office {
|
|
|
14764
14755
|
*
|
|
14765
14756
|
* @remarks
|
|
14766
14757
|
*
|
|
14767
|
-
* [Api set: Mailbox
|
|
14758
|
+
* [Api set: Mailbox 1.16]
|
|
14768
14759
|
*
|
|
14769
14760
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14770
14761
|
*
|
|
14771
14762
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14772
14763
|
*
|
|
14773
14764
|
* **Important**: Attachments of type `MailboxEnums.AttachmentType.Item` aren't currently supported.
|
|
14774
|
-
*
|
|
14775
|
-
* @beta
|
|
14776
14765
|
*/
|
|
14777
14766
|
attachmentType: MailboxEnums.AttachmentType;
|
|
14778
14767
|
/**
|
|
@@ -14780,15 +14769,13 @@ declare namespace Office {
|
|
|
14780
14769
|
*
|
|
14781
14770
|
* @remarks
|
|
14782
14771
|
*
|
|
14783
|
-
* [Api set: Mailbox
|
|
14772
|
+
* [Api set: Mailbox 1.16]
|
|
14784
14773
|
*
|
|
14785
14774
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14786
14775
|
*
|
|
14787
14776
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14788
14777
|
*
|
|
14789
14778
|
* **Important**: The `content` property isn't supported by attachments of type `MailboxEnums.AttachmentType.Cloud`.
|
|
14790
|
-
*
|
|
14791
|
-
* @beta
|
|
14792
14779
|
*/
|
|
14793
14780
|
content: string;
|
|
14794
14781
|
/**
|
|
@@ -14798,7 +14785,7 @@ declare namespace Office {
|
|
|
14798
14785
|
*
|
|
14799
14786
|
* @remarks
|
|
14800
14787
|
*
|
|
14801
|
-
* [Api set: Mailbox
|
|
14788
|
+
* [Api set: Mailbox 1.16]
|
|
14802
14789
|
*
|
|
14803
14790
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14804
14791
|
*
|
|
@@ -14808,8 +14795,6 @@ declare namespace Office {
|
|
|
14808
14795
|
* specified in the `src` attribute of the `<img>` element (for example, `<img width=96 height=96 id="Picture_1" src="cid:image001.png@01DC1E6F.FC7C7410">`).
|
|
14809
14796
|
* To easily identify and provide these inline attachments during decryption, we recommend saving the content IDs of inline attachments to the message header during encryption.
|
|
14810
14797
|
* Call `Office.context.mailbox.item.getAttachmentsAsync` to get the content ID of an inline attachment. Then, call `Office.context.mailbox.item.internetHeaders.setAsync` to save the ID to the header of the message.
|
|
14811
|
-
*
|
|
14812
|
-
* @beta
|
|
14813
14798
|
*/
|
|
14814
14799
|
contentId?: string;
|
|
14815
14800
|
/**
|
|
@@ -14818,13 +14803,11 @@ declare namespace Office {
|
|
|
14818
14803
|
*
|
|
14819
14804
|
* @remarks
|
|
14820
14805
|
*
|
|
14821
|
-
* [Api set: Mailbox
|
|
14806
|
+
* [Api set: Mailbox 1.16]
|
|
14822
14807
|
*
|
|
14823
14808
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14824
14809
|
*
|
|
14825
14810
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14826
|
-
*
|
|
14827
|
-
* @beta
|
|
14828
14811
|
*/
|
|
14829
14812
|
isInline?: boolean;
|
|
14830
14813
|
/**
|
|
@@ -14832,13 +14815,11 @@ declare namespace Office {
|
|
|
14832
14815
|
*
|
|
14833
14816
|
* @remarks
|
|
14834
14817
|
*
|
|
14835
|
-
* [Api set: Mailbox
|
|
14818
|
+
* [Api set: Mailbox 1.16]
|
|
14836
14819
|
*
|
|
14837
14820
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14838
14821
|
*
|
|
14839
14822
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14840
|
-
*
|
|
14841
|
-
* @beta
|
|
14842
14823
|
*/
|
|
14843
14824
|
name: string;
|
|
14844
14825
|
/**
|
|
@@ -14847,13 +14828,11 @@ declare namespace Office {
|
|
|
14847
14828
|
*
|
|
14848
14829
|
* @remarks
|
|
14849
14830
|
*
|
|
14850
|
-
* [Api set: Mailbox
|
|
14831
|
+
* [Api set: Mailbox 1.16]
|
|
14851
14832
|
*
|
|
14852
14833
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14853
14834
|
*
|
|
14854
14835
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14855
|
-
*
|
|
14856
|
-
* @beta
|
|
14857
14836
|
*/
|
|
14858
14837
|
path?: string;
|
|
14859
14838
|
}
|
|
@@ -14862,15 +14841,13 @@ declare namespace Office {
|
|
|
14862
14841
|
*
|
|
14863
14842
|
* @remarks
|
|
14864
14843
|
*
|
|
14865
|
-
* [Api set: Mailbox
|
|
14844
|
+
* [Api set: Mailbox 1.16]
|
|
14866
14845
|
*
|
|
14867
14846
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14868
14847
|
*
|
|
14869
14848
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14870
14849
|
*
|
|
14871
14850
|
* To learn how to develop an encryption add-in in Outlook, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | Create an encryption Outlook add-in}.
|
|
14872
|
-
*
|
|
14873
|
-
* @beta
|
|
14874
14851
|
*/
|
|
14875
14852
|
interface DecryptedMessageBody {
|
|
14876
14853
|
/**
|
|
@@ -14879,13 +14856,11 @@ declare namespace Office {
|
|
|
14879
14856
|
*
|
|
14880
14857
|
* @remarks
|
|
14881
14858
|
*
|
|
14882
|
-
* [Api set: Mailbox
|
|
14859
|
+
* [Api set: Mailbox 1.16]
|
|
14883
14860
|
*
|
|
14884
14861
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14885
14862
|
*
|
|
14886
14863
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14887
|
-
*
|
|
14888
|
-
* @beta
|
|
14889
14864
|
*/
|
|
14890
14865
|
coercionType: Office.CoercionType;
|
|
14891
14866
|
/**
|
|
@@ -14893,13 +14868,11 @@ declare namespace Office {
|
|
|
14893
14868
|
*
|
|
14894
14869
|
* @remarks
|
|
14895
14870
|
*
|
|
14896
|
-
* [Api set: Mailbox
|
|
14871
|
+
* [Api set: Mailbox 1.16]
|
|
14897
14872
|
*
|
|
14898
14873
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
14899
14874
|
*
|
|
14900
14875
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
14901
|
-
*
|
|
14902
|
-
* @beta
|
|
14903
14876
|
*/
|
|
14904
14877
|
content: string;
|
|
14905
14878
|
}
|
|
@@ -15034,22 +15007,16 @@ declare namespace Office {
|
|
|
15034
15007
|
*
|
|
15035
15008
|
* @remarks
|
|
15036
15009
|
*
|
|
15037
|
-
* [Api set: Mailbox
|
|
15010
|
+
* [Api set: Mailbox 1.16]
|
|
15038
15011
|
*
|
|
15039
15012
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15040
15013
|
*
|
|
15041
15014
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15042
15015
|
*
|
|
15043
|
-
* **Important**:
|
|
15044
|
-
*
|
|
15045
|
-
* - The `ews` property is available for preview in Outlook on the web and on Windows (new and classic (Version 2510, Build 19328.20000 and later)).
|
|
15046
|
-
*
|
|
15047
|
-
* - Legacy Exchange Online user identity tokens and callback tokens are no longer supported and are turned off across all Microsoft 365 tenants.
|
|
15016
|
+
* **Important**: Legacy Exchange Online user identity tokens and callback tokens are no longer supported and are turned off across all Microsoft 365 tenants.
|
|
15048
15017
|
* If an Outlook add-in requires delegated user access or user identity, we recommend using MSAL (Microsoft Authentication Library) and nested app authentication (NAA).
|
|
15049
15018
|
* Exchange user identity tokens are still supported for Exchange on-premises. For more information, see
|
|
15050
15019
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | Nested app authentication FAQ}.
|
|
15051
|
-
*
|
|
15052
|
-
* @beta
|
|
15053
15020
|
*/
|
|
15054
15021
|
ews: Ews;
|
|
15055
15022
|
/**
|
|
@@ -15854,7 +15821,7 @@ declare namespace Office {
|
|
|
15854
15821
|
*
|
|
15855
15822
|
* @remarks
|
|
15856
15823
|
*
|
|
15857
|
-
* [Api set: Mailbox
|
|
15824
|
+
* [Api set: Mailbox 1.16]
|
|
15858
15825
|
*
|
|
15859
15826
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15860
15827
|
*
|
|
@@ -15864,8 +15831,6 @@ declare namespace Office {
|
|
|
15864
15831
|
* If an Outlook add-in requires delegated user access or user identity, we recommend using MSAL (Microsoft Authentication Library) and nested app authentication (NAA).
|
|
15865
15832
|
* Exchange user identity tokens are still supported for Exchange on-premises. For more information, see
|
|
15866
15833
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/faq-nested-app-auth-outlook-legacy-tokens | Nested app authentication FAQ}.
|
|
15867
|
-
*
|
|
15868
|
-
* @beta
|
|
15869
15834
|
*/
|
|
15870
15835
|
interface Ews {
|
|
15871
15836
|
/**
|
|
@@ -15873,7 +15838,7 @@ declare namespace Office {
|
|
|
15873
15838
|
*
|
|
15874
15839
|
* @remarks
|
|
15875
15840
|
*
|
|
15876
|
-
* [Api set: Mailbox
|
|
15841
|
+
* [Api set: Mailbox 1.16]
|
|
15877
15842
|
*
|
|
15878
15843
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15879
15844
|
*
|
|
@@ -15881,8 +15846,6 @@ declare namespace Office {
|
|
|
15881
15846
|
*
|
|
15882
15847
|
* **Important**:
|
|
15883
15848
|
*
|
|
15884
|
-
* - The `getTokenStatusAsync` method is available for preview in Outlook on the web and on Windows (new and classic (Version 2510, Build 19328.20000 and later)).
|
|
15885
|
-
*
|
|
15886
15849
|
* - The `getTokenStatusAsync` method isn't supported if you load an add-in in an Outlook.com or Gmail mailbox.
|
|
15887
15850
|
*
|
|
15888
15851
|
* - Calling the `getTokenStatusAsync` method in compose mode requires you to have saved the item. The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
@@ -15893,8 +15856,6 @@ declare namespace Office {
|
|
|
15893
15856
|
* The `asyncResult.value` property returns the token status, which can be `Office.MailboxEnums.TokenStatus.Enabled`, `Office.MailboxEnums.TokenStatus.Disabled`, or
|
|
15894
15857
|
* `Office.MailboxEnums.TokenStatus.Removed`. A `Office.MailboxEnums.TokenStatus.Removed` status indicates that the mailbox is hosted in an Exchange Online environment
|
|
15895
15858
|
* where legacy Exchange tokens are turned off and are no longer supported.
|
|
15896
|
-
*
|
|
15897
|
-
* @beta
|
|
15898
15859
|
*/
|
|
15899
15860
|
getTokenStatusAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;
|
|
15900
15861
|
/**
|
|
@@ -15902,7 +15863,7 @@ declare namespace Office {
|
|
|
15902
15863
|
*
|
|
15903
15864
|
* @remarks
|
|
15904
15865
|
*
|
|
15905
|
-
* [Api set: Mailbox
|
|
15866
|
+
* [Api set: Mailbox 1.16]
|
|
15906
15867
|
*
|
|
15907
15868
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
15908
15869
|
*
|
|
@@ -15910,8 +15871,6 @@ declare namespace Office {
|
|
|
15910
15871
|
*
|
|
15911
15872
|
* **Important**:
|
|
15912
15873
|
*
|
|
15913
|
-
* - The `getTokenStatusAsync` method is available for preview in Outlook on the web and on Windows (new and classic (Version 2510, Build 19328.20000 and later)).
|
|
15914
|
-
*
|
|
15915
15874
|
* - The `getTokenStatusAsync` method isn't supported if you load an add-in in an Outlook.com or Gmail mailbox.
|
|
15916
15875
|
*
|
|
15917
15876
|
* - Calling the `getTokenStatusAsync` method in compose mode requires you to have saved the item. The `saveAsync` method requires a minimum permission level of **read/write item**.
|
|
@@ -15920,8 +15879,6 @@ declare namespace Office {
|
|
|
15920
15879
|
* The `asyncResult.value` property returns the token status, which can be `Office.MailboxEnums.TokenStatus.Enabled`, `Office.MailboxEnums.TokenStatus.Disabled`, or
|
|
15921
15880
|
* `Office.MailboxEnums.TokenStatus.Removed`. A `Office.MailboxEnums.TokenStatus.Removed` status indicates that the mailbox is hosted in an Exchange Online environment
|
|
15922
15881
|
* where legacy Exchange tokens are turned off and are no longer supported.
|
|
15923
|
-
*
|
|
15924
|
-
* @beta
|
|
15925
15882
|
*/
|
|
15926
15883
|
getTokenStatusAsync(callback: (asyncResult: Office.AsyncResult<MailboxEnums.TokenStatus>) => void): void;
|
|
15927
15884
|
}
|
|
@@ -18425,24 +18382,7 @@ declare namespace Office {
|
|
|
18425
18382
|
/**
|
|
18426
18383
|
* Provides diagnostic information to an Outlook add-in.
|
|
18427
18384
|
*
|
|
18428
|
-
*
|
|
18429
|
-
*
|
|
18430
|
-
* - `hostName` (string): A string that represents the name of the Office application.
|
|
18431
|
-
* It should be one of the following values: `Outlook`, `newOutlookWindows`, `OutlookWebApp`, `OutlookIOS`, or `OutlookAndroid`.
|
|
18432
|
-
* **Note**: The "Outlook" value is returned for Outlook on Windows (classic) and on Mac.
|
|
18433
|
-
*
|
|
18434
|
-
* - `hostVersion` (string): A string that represents the version of either the Office application or the Exchange Server (e.g., "15.0.468.0").
|
|
18435
|
-
* If the mail add-in is running in Outlook on Windows (classic), on Mac, or on mobile devices, the `hostVersion` property returns the version of the
|
|
18436
|
-
* Outlook client. In Outlook on the web and {@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new Outlook on Windows},
|
|
18437
|
-
* the property returns the version of the Exchange Server.
|
|
18438
|
-
*
|
|
18439
|
-
* - `OWAView` (`MailboxEnums.OWAView` or string): An enum (or string literal) that represents the current view of Outlook on the web.
|
|
18440
|
-
* If the application is not Outlook on the web, then accessing this property results in undefined.
|
|
18441
|
-
* Outlook on the web has three views (`OneColumn` - displayed when the screen is narrow, `TwoColumns` - displayed when the screen is wider,
|
|
18442
|
-
* and `ThreeColumns` - displayed when the screen is wide) that correspond to the width of the screen and the window, and the number of columns
|
|
18443
|
-
* that can be displayed.
|
|
18444
|
-
*
|
|
18445
|
-
* More information is under {@link Office.Diagnostics}.
|
|
18385
|
+
* For information about the diagnostic properties you can access, see {@link Office.Diagnostics}.
|
|
18446
18386
|
*
|
|
18447
18387
|
* @remarks
|
|
18448
18388
|
*
|
|
@@ -19531,7 +19471,7 @@ declare namespace Office {
|
|
|
19531
19471
|
* {@link https://learn.microsoft.com/office/dev/add-ins/develop/event-based-activation | event-based activation}, including
|
|
19532
19472
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/onmessagesend-onappointmentsend-events | Smart Alerts}, the
|
|
19533
19473
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}, or
|
|
19534
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | decryption}
|
|
19474
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/encryption-decryption | decryption}.
|
|
19535
19475
|
* It allows the add-in to signify to the Outlook client that it has completed processing an event.
|
|
19536
19476
|
*
|
|
19537
19477
|
* @remarks
|
|
@@ -19545,6 +19485,8 @@ declare namespace Office {
|
|
|
19545
19485
|
*
|
|
19546
19486
|
* - Support for the integrated spam-reporting feature was introduced in Mailbox 1.14.
|
|
19547
19487
|
*
|
|
19488
|
+
* - Support for the decryption feature was introduced in Mailbox 1.16.
|
|
19489
|
+
*
|
|
19548
19490
|
* - For information about the Event object used by the {@link https://learn.microsoft.com/office/dev/add-ins/design/add-in-commands | function command button},
|
|
19549
19491
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send add-in},
|
|
19550
19492
|
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/online-meeting | online-meeting provider add-in}, and
|
|
@@ -19553,7 +19495,7 @@ declare namespace Office {
|
|
|
19553
19495
|
*/
|
|
19554
19496
|
interface MailboxEvent {
|
|
19555
19497
|
/**
|
|
19556
|
-
* Indicates that the event-based, spam-reporting, or decryption
|
|
19498
|
+
* Indicates that the event-based, spam-reporting, or decryption add-in has completed processing an event.
|
|
19557
19499
|
*
|
|
19558
19500
|
* @remarks
|
|
19559
19501
|
* [Api set: Mailbox 1.10]
|
|
@@ -19568,6 +19510,8 @@ declare namespace Office {
|
|
|
19568
19510
|
*
|
|
19569
19511
|
* - Support to assign a `SmartAlertsEventCompletedOptions` object to the `options` parameter was introduced in Mailbox 1.12.
|
|
19570
19512
|
*
|
|
19513
|
+
* - Support for the decryption feature was introduced in Mailbox 1.16.
|
|
19514
|
+
*
|
|
19571
19515
|
* @param options - Optional. An object that specifies the behavior of an event-based, spam-reporting, or decryption add-in when it completes processing an event.
|
|
19572
19516
|
*/
|
|
19573
19517
|
completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions | MessageDecryptEventCompletedOptions): void;
|
|
@@ -20034,7 +19978,8 @@ declare namespace Office {
|
|
|
20034
19978
|
/**
|
|
20035
19979
|
* Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.
|
|
20036
19980
|
*
|
|
20037
|
-
* **Important**:
|
|
19981
|
+
* **Important**: In Outlook clients that support Mailbox 1.15 or earlier, the entire SessionData object for each mail item is limited to 50,000 characters per add-in.
|
|
19982
|
+
* In clients that support Mailbox 1.16 or later, the character limit per add-in is 2,621,440 characters.
|
|
20038
19983
|
*
|
|
20039
19984
|
* @remarks
|
|
20040
19985
|
* [Api set: Mailbox 1.11]
|
|
@@ -21521,13 +21466,11 @@ declare namespace Office {
|
|
|
21521
21466
|
*
|
|
21522
21467
|
* @remarks
|
|
21523
21468
|
*
|
|
21524
|
-
* [Api set: Mailbox
|
|
21469
|
+
* [Api set: Mailbox 1.16]
|
|
21525
21470
|
*
|
|
21526
21471
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
21527
21472
|
*
|
|
21528
21473
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
21529
|
-
*
|
|
21530
|
-
* @beta
|
|
21531
21474
|
*/
|
|
21532
21475
|
interface MessageDecryptEventCompletedOptions {
|
|
21533
21476
|
/**
|
|
@@ -21536,13 +21479,11 @@ declare namespace Office {
|
|
|
21536
21479
|
*
|
|
21537
21480
|
* @remarks
|
|
21538
21481
|
*
|
|
21539
|
-
* [Api set: Mailbox
|
|
21482
|
+
* [Api set: Mailbox 1.16]
|
|
21540
21483
|
*
|
|
21541
21484
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
21542
21485
|
*
|
|
21543
21486
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
21544
|
-
*
|
|
21545
|
-
* @beta
|
|
21546
21487
|
*/
|
|
21547
21488
|
allowEvent: boolean;
|
|
21548
21489
|
/**
|
|
@@ -21551,13 +21492,11 @@ declare namespace Office {
|
|
|
21551
21492
|
*
|
|
21552
21493
|
* @remarks
|
|
21553
21494
|
*
|
|
21554
|
-
* [Api set: Mailbox
|
|
21495
|
+
* [Api set: Mailbox 1.16]
|
|
21555
21496
|
*
|
|
21556
21497
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
21557
21498
|
*
|
|
21558
21499
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
21559
|
-
*
|
|
21560
|
-
* @beta
|
|
21561
21500
|
*/
|
|
21562
21501
|
attachments?: DecryptedMessageAttachment[];
|
|
21563
21502
|
/**
|
|
@@ -21566,7 +21505,7 @@ declare namespace Office {
|
|
|
21566
21505
|
*
|
|
21567
21506
|
* @remarks
|
|
21568
21507
|
*
|
|
21569
|
-
* [Api set: Mailbox
|
|
21508
|
+
* [Api set: Mailbox 1.16]
|
|
21570
21509
|
*
|
|
21571
21510
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
21572
21511
|
*
|
|
@@ -21578,8 +21517,6 @@ declare namespace Office {
|
|
|
21578
21517
|
* If you create a JSON string using `JSON.stringify()` and assign it to the `contextData` property, you must parse the string using `JSON.parse()` once you retrieve it.
|
|
21579
21518
|
*
|
|
21580
21519
|
* - You can use the `contextData` property to store custom internet headers to decrypt messages in reply and forward scenarios.
|
|
21581
|
-
*
|
|
21582
|
-
* @beta
|
|
21583
21520
|
*/
|
|
21584
21521
|
contextData?: any;
|
|
21585
21522
|
/**
|
|
@@ -21588,15 +21525,13 @@ declare namespace Office {
|
|
|
21588
21525
|
*
|
|
21589
21526
|
* @remarks
|
|
21590
21527
|
*
|
|
21591
|
-
* [Api set: Mailbox
|
|
21528
|
+
* [Api set: Mailbox 1.16]
|
|
21592
21529
|
*
|
|
21593
21530
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
|
|
21594
21531
|
*
|
|
21595
21532
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
21596
21533
|
*
|
|
21597
21534
|
* **Important**: If the `emailBody` property isn't specified, an empty body is returned.
|
|
21598
|
-
*
|
|
21599
|
-
* @beta
|
|
21600
21535
|
*/
|
|
21601
21536
|
emailBody?: DecryptedMessageBody;
|
|
21602
21537
|
}
|
|
@@ -21843,13 +21778,13 @@ declare namespace Office {
|
|
|
21843
21778
|
* The `cc` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
21844
21779
|
* each recipient listed on the **Cc** line of the message. The maximum number of recipients returned varies per Outlook client.
|
|
21845
21780
|
*
|
|
21846
|
-
* - Windows (classic): 500 recipients
|
|
21781
|
+
* - Windows (classic - Mailbox 1.15 and earlier): 500 recipients
|
|
21847
21782
|
*
|
|
21848
|
-
* - Windows (classic -
|
|
21783
|
+
* - Windows (classic - Mailbox 1.16 and later): 1,000 recipients
|
|
21849
21784
|
*
|
|
21850
21785
|
* - Android, classic Mac UI, iOS: 100 recipients
|
|
21851
21786
|
*
|
|
21852
|
-
* - Web browser, Windows (new): 20 recipients (collapsed view),
|
|
21787
|
+
* - Web browser, Windows (new): 20 recipients (collapsed view), 1,000 recipients (expanded view)
|
|
21853
21788
|
*
|
|
21854
21789
|
* - New Mac UI: No limit
|
|
21855
21790
|
*
|
|
@@ -22186,13 +22121,13 @@ declare namespace Office {
|
|
|
22186
22121
|
* The `to` property returns an array that contains an {@link Office.EmailAddressDetails | EmailAddressDetails} object for
|
|
22187
22122
|
* each recipient listed on the **To** line of the message. The maximum number of recipients returned varies per Outlook client.
|
|
22188
22123
|
*
|
|
22189
|
-
* - Windows (classic): 500 recipients
|
|
22124
|
+
* - Windows (classic - Mailbox 1.15 and earlier): 500 recipients
|
|
22190
22125
|
*
|
|
22191
|
-
* - Windows (classic -
|
|
22126
|
+
* - Windows (classic - Mailbox 1.16 and later): 1,000 recipients
|
|
22192
22127
|
*
|
|
22193
22128
|
* - Android, classic Mac UI, iOS: 100 recipients
|
|
22194
22129
|
*
|
|
22195
|
-
* - Web browser, Windows (new): 20 recipients (collapsed view),
|
|
22130
|
+
* - Web browser, Windows (new): 20 recipients (collapsed view), 1,000 recipients (expanded view)
|
|
22196
22131
|
*
|
|
22197
22132
|
* - New Mac UI: No limit
|
|
22198
22133
|
*
|
|
@@ -23482,16 +23417,14 @@ declare namespace Office {
|
|
|
23482
23417
|
*
|
|
23483
23418
|
* **Important**:
|
|
23484
23419
|
*
|
|
23485
|
-
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows
|
|
23420
|
+
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item at a time in Outlook on the web, on Windows
|
|
23486
23421
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
23487
23422
|
* However, take note of the following:
|
|
23488
23423
|
*
|
|
23489
|
-
* - In Outlook on
|
|
23490
|
-
*
|
|
23491
|
-
*
|
|
23492
|
-
*
|
|
23493
|
-
* Then, join the {@link https://techcommunity.microsoft.com/kb/microsoft-365-insider-kb/join-the-microsoft-365-insider-program-on-windows/4401748 | Microsoft 365 Insider program} and select the
|
|
23494
|
-
* **Beta Channel** option to access Office beta builds.
|
|
23424
|
+
* - In classic Outlook on Windows (Mailbox 1.15 and earlier) and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
23425
|
+
* In classic Outlook on Windows, clients that support Mailbox 1.16 and later can have a maximum of 1,000 recipients. Target fields in Outlook on the web and the
|
|
23426
|
+
* new Outlook on Windows have no recipient limits. If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly,
|
|
23427
|
+
* but be mindful of the recipient limit of the field.
|
|
23495
23428
|
*
|
|
23496
23429
|
* - In Outlook on Android and on iOS, the `addAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `addAsync` method isn't
|
|
23497
23430
|
* supported when a user replies from the the reply field at the bottom of a message.
|
|
@@ -23525,15 +23458,14 @@ declare namespace Office {
|
|
|
23525
23458
|
*
|
|
23526
23459
|
* **Important**:
|
|
23527
23460
|
*
|
|
23528
|
-
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on Windows
|
|
23529
|
-
* on Mac (classic UI), on Android, and on iOS.
|
|
23530
|
-
*
|
|
23531
|
-
* - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
23532
|
-
* If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field.
|
|
23461
|
+
* With the `addAsync` method, you can add a maximum of 100 recipients to a mail item at a time in Outlook on the web, on Windows
|
|
23462
|
+
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
23463
|
+
* However, take note of the following:
|
|
23533
23464
|
*
|
|
23534
|
-
* - In classic Outlook on Windows
|
|
23535
|
-
*
|
|
23536
|
-
*
|
|
23465
|
+
* - In classic Outlook on Windows (Mailbox 1.15 and earlier) and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
23466
|
+
* In classic Outlook on Windows, clients that support Mailbox 1.16 and later can have a maximum of 1,000 recipients. Target fields in Outlook on the web and the
|
|
23467
|
+
* new Outlook on Windows have no recipient limits. If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly,
|
|
23468
|
+
* but be mindful of the recipient limit of the field.
|
|
23537
23469
|
*
|
|
23538
23470
|
* - In Outlook on Android and on iOS, the `addAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `addAsync` method isn't
|
|
23539
23471
|
* supported when a user replies from the the reply field at the bottom of a message.
|
|
@@ -23567,9 +23499,9 @@ declare namespace Office {
|
|
|
23567
23499
|
*
|
|
23568
23500
|
* The maximum number of recipients returned by this method varies per Outlook client.
|
|
23569
23501
|
*
|
|
23570
|
-
* - Windows (
|
|
23502
|
+
* - Windows (classic - Mailbox 1.15 and earlier), Mac (classic UI): 500 recipients
|
|
23571
23503
|
*
|
|
23572
|
-
* - Windows (
|
|
23504
|
+
* - Web, Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new}, classic - Mailbox 1.16 and later): 1,000 recipients
|
|
23573
23505
|
*
|
|
23574
23506
|
* - Android, iOS: 100 recipients
|
|
23575
23507
|
*
|
|
@@ -23623,9 +23555,9 @@ declare namespace Office {
|
|
|
23623
23555
|
*
|
|
23624
23556
|
* The maximum number of recipients returned by this method varies per Outlook client.
|
|
23625
23557
|
*
|
|
23626
|
-
* - Windows (
|
|
23558
|
+
* - Windows (classic - Mailbox 1.15 and earlier), Mac (classic UI): 500 recipients
|
|
23627
23559
|
*
|
|
23628
|
-
* - Windows (
|
|
23560
|
+
* - Web, Windows ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new}, classic - Mailbox 1.16 and later): 1,000 recipients
|
|
23629
23561
|
*
|
|
23630
23562
|
* - Android, iOS: 100 recipients
|
|
23631
23563
|
*
|
|
@@ -23674,16 +23606,14 @@ declare namespace Office {
|
|
|
23674
23606
|
*
|
|
23675
23607
|
* **Important**:
|
|
23676
23608
|
*
|
|
23677
|
-
* With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
23609
|
+
* With the `setAsync` method, you can set a maximum of 100 recipients at a time in Outlook on the web, on Windows
|
|
23678
23610
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
23679
23611
|
* However, take note of the following:
|
|
23680
23612
|
*
|
|
23681
|
-
* - In Outlook on
|
|
23682
|
-
*
|
|
23683
|
-
*
|
|
23684
|
-
*
|
|
23685
|
-
* Then, join the {@link https://techcommunity.microsoft.com/kb/microsoft-365-insider-kb/join-the-microsoft-365-insider-program-on-windows/4401748 | Microsoft 365 Insider program} and select the
|
|
23686
|
-
* **Beta Channel** option to access Office beta builds.
|
|
23613
|
+
* - In classic Outlook on Windows (Mailbox 1.15 and earlier) and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
23614
|
+
* In classic Outlook on Windows, clients that support Mailbox 1.16 and later can have a maximum of 1,000 recipients. Target fields in Outlook on the web and the
|
|
23615
|
+
* new Outlook on Windows have no recipient limits. If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly,
|
|
23616
|
+
* but be mindful of the recipient limit of the field.
|
|
23687
23617
|
*
|
|
23688
23618
|
* - In Outlook on Android and on iOS, the `setAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `setAsync` method isn't
|
|
23689
23619
|
* supported when a user replies from the the reply field at the bottom of a message.
|
|
@@ -23720,16 +23650,14 @@ declare namespace Office {
|
|
|
23720
23650
|
*
|
|
23721
23651
|
* **Important**:
|
|
23722
23652
|
*
|
|
23723
|
-
* With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
|
|
23653
|
+
* With the `setAsync` method, you can set a maximum of 100 recipients at a time in Outlook on the web, on Windows
|
|
23724
23654
|
* ({@link https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627 | new} and classic), on Mac (classic UI), on Android, and on iOS.
|
|
23725
23655
|
* However, take note of the following:
|
|
23726
23656
|
*
|
|
23727
|
-
* - In Outlook on
|
|
23728
|
-
*
|
|
23729
|
-
*
|
|
23730
|
-
*
|
|
23731
|
-
* Then, join the {@link https://techcommunity.microsoft.com/kb/microsoft-365-insider-kb/join-the-microsoft-365-insider-program-on-windows/4401748 | Microsoft 365 Insider program} and select the
|
|
23732
|
-
* **Beta Channel** option to access Office beta builds.
|
|
23657
|
+
* - In classic Outlook on Windows (Mailbox 1.15 and earlier) and on Mac (classic UI), you can have a maximum of 500 recipients in a target field.
|
|
23658
|
+
* In classic Outlook on Windows, clients that support Mailbox 1.16 and later can have a maximum of 1,000 recipients. Target fields in Outlook on the web and the
|
|
23659
|
+
* new Outlook on Windows have no recipient limits. If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly,
|
|
23660
|
+
* but be mindful of the recipient limit of the field.
|
|
23733
23661
|
*
|
|
23734
23662
|
* - In Outlook on Android and on iOS, the `setAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `setAsync` method isn't
|
|
23735
23663
|
* supported when a user replies from the the reply field at the bottom of a message.
|
|
@@ -25016,7 +24944,8 @@ declare namespace Office {
|
|
|
25016
24944
|
*
|
|
25017
24945
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
25018
24946
|
*
|
|
25019
|
-
* **Important**:
|
|
24947
|
+
* **Important**: In Outlook clients that support Mailbox 1.15 or earlier, the entire SessionData object for each mail item is limited to 50,000 characters per add-in.
|
|
24948
|
+
* In clients that support Mailbox 1.16 or later, the character limit per add-in is 2,621,440 characters.
|
|
25020
24949
|
*/
|
|
25021
24950
|
interface SessionData {
|
|
25022
24951
|
/**
|
|
@@ -25121,9 +25050,7 @@ declare namespace Office {
|
|
|
25121
25050
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
25122
25051
|
*
|
|
25123
25052
|
* **Important**: In Outlook clients that support Mailbox 1.15 or earlier, the entire SessionData object for each mail item is limited to 50,000 characters per add-in.
|
|
25124
|
-
* In
|
|
25125
|
-
* {@link https://aka.ms/MSFT365InsiderProgram | Microsoft 365 Insider program}, then choose the Beta Channel in the classic Outlook on Windows client.
|
|
25126
|
-
* Your client must be on Version 2510 (Build 19317.20000) or later.
|
|
25053
|
+
* In clients that support Mailbox 1.16 or later, the character limit per add-in is 2,621,440 characters.
|
|
25127
25054
|
*
|
|
25128
25055
|
* @param name - The session data key.
|
|
25129
25056
|
* @param value - The session data value as a string.
|
|
@@ -25144,9 +25071,7 @@ declare namespace Office {
|
|
|
25144
25071
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
25145
25072
|
*
|
|
25146
25073
|
* **Important**: In Outlook clients that support Mailbox 1.15 or earlier, the entire SessionData object for each mail item is limited to 50,000 characters per add-in.
|
|
25147
|
-
* In
|
|
25148
|
-
* {@link https://aka.ms/MSFT365InsiderProgram | Microsoft 365 Insider program}, then choose the Beta Channel in the classic Outlook on Windows client.
|
|
25149
|
-
* Your client must be on Version 2510 (Build 19317.20000) or later.
|
|
25074
|
+
* In clients that support Mailbox 1.16 or later, the character limit per add-in is 2,621,440 characters.
|
|
25150
25075
|
*
|
|
25151
25076
|
* @param name - The session data key.
|
|
25152
25077
|
* @param value - The session data value as a string.
|
|
@@ -26422,7 +26347,6 @@ declare namespace OfficeCore {
|
|
|
26422
26347
|
/////////////////////// Begin Excel APIs ///////////////////////
|
|
26423
26348
|
////////////////////////////////////////////////////////////////
|
|
26424
26349
|
|
|
26425
|
-
|
|
26426
26350
|
declare namespace Excel {
|
|
26427
26351
|
/**
|
|
26428
26352
|
* Represents an unknown cell control.
|
|
@@ -35573,6 +35497,10 @@ declare namespace Excel {
|
|
|
35573
35497
|
* [Api set: ExcelApi 1.5]
|
|
35574
35498
|
*/
|
|
35575
35499
|
readonly runtime: Runtime;
|
|
35500
|
+
/**
|
|
35501
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35502
|
+
*/
|
|
35503
|
+
readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog;
|
|
35576
35504
|
}
|
|
35577
35505
|
interface RunOptions extends OfficeExtension.RunOptions<Session> {
|
|
35578
35506
|
/**
|
|
@@ -35623,8 +35551,416 @@ declare namespace Excel {
|
|
|
35623
35551
|
* @param batch - A function that takes in a RequestContext and returns a promise (typically, just the result of "context.sync()"). The context parameter facilitates requests to the Excel application. Since the Office add-in and the Excel application run in two different processes, the RequestContext is required to get access to the Excel object model from the add-in.
|
|
35624
35552
|
*/
|
|
35625
35553
|
function run<T>(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;
|
|
35626
|
-
|
|
35627
|
-
|
|
35554
|
+
/**
|
|
35555
|
+
* Represents the labeling capability status of the sensitivity label catalog.
|
|
35556
|
+
*
|
|
35557
|
+
* @remarks
|
|
35558
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35559
|
+
* @beta
|
|
35560
|
+
*/
|
|
35561
|
+
enum LabelingCapability {
|
|
35562
|
+
/**
|
|
35563
|
+
* No valid license is available for sensitivity labeling.
|
|
35564
|
+
* @remarks
|
|
35565
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35566
|
+
* @beta
|
|
35567
|
+
*/
|
|
35568
|
+
noLicense = "NoLicense",
|
|
35569
|
+
/**
|
|
35570
|
+
* Sensitivity labeling is disabled for the user or tenant.
|
|
35571
|
+
* @remarks
|
|
35572
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35573
|
+
* @beta
|
|
35574
|
+
*/
|
|
35575
|
+
labelingDisabled = "LabelingDisabled",
|
|
35576
|
+
/**
|
|
35577
|
+
* No labeling policy was found for the user.
|
|
35578
|
+
* @remarks
|
|
35579
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35580
|
+
* @beta
|
|
35581
|
+
*/
|
|
35582
|
+
labelingPolicyNotFound = "LabelingPolicyNotFound",
|
|
35583
|
+
/**
|
|
35584
|
+
* Sensitivity labeling is fully enabled.
|
|
35585
|
+
* @remarks
|
|
35586
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35587
|
+
* @beta
|
|
35588
|
+
*/
|
|
35589
|
+
labelingEnabled = "LabelingEnabled"
|
|
35590
|
+
}
|
|
35591
|
+
/**
|
|
35592
|
+
* Represents the sensitivity label on the workbook.
|
|
35593
|
+
*
|
|
35594
|
+
* @remarks
|
|
35595
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35596
|
+
* @beta
|
|
35597
|
+
*/
|
|
35598
|
+
class SensitivityLabel extends OfficeExtension.ClientObject {
|
|
35599
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35600
|
+
context: RequestContext;
|
|
35601
|
+
/**
|
|
35602
|
+
* Gets the current label information that exists on the workbook for the user.
|
|
35603
|
+
If there's no sensitivity label on the current workbook, an object with an `isNullObject` property set to `true` is returned.
|
|
35604
|
+
For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
35605
|
+
*
|
|
35606
|
+
* @remarks
|
|
35607
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35608
|
+
* @beta
|
|
35609
|
+
* @returns The current `SensitivityLabelDetails` object.
|
|
35610
|
+
*/
|
|
35611
|
+
getCurrentOrNullObject(): Excel.SensitivityLabelDetails;
|
|
35612
|
+
/**
|
|
35613
|
+
* Tries to update to the provided sensitivity label on the workbook for the user.
|
|
35614
|
+
*
|
|
35615
|
+
* @remarks
|
|
35616
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35617
|
+
* @beta
|
|
35618
|
+
*
|
|
35619
|
+
* @param labelId The ID of the label to apply.
|
|
35620
|
+
* @returns The `SensitivityLabelUpdateResult` object.
|
|
35621
|
+
*/
|
|
35622
|
+
tryToUpdate(labelId: string): OfficeExtension.ClientResult<Excel.SensitivityLabelUpdateResult>;
|
|
35623
|
+
/**
|
|
35624
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
35625
|
+
* Whereas the original `Excel.SensitivityLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelData`) that contains shallow copies of any loaded child properties from the original object.
|
|
35626
|
+
*/
|
|
35627
|
+
toJSON(): {
|
|
35628
|
+
[key: string]: string;
|
|
35629
|
+
};
|
|
35630
|
+
}
|
|
35631
|
+
/**
|
|
35632
|
+
* Represents the properties of available sensitivity labels in Excel.
|
|
35633
|
+
*
|
|
35634
|
+
* @remarks
|
|
35635
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35636
|
+
* @beta
|
|
35637
|
+
*/
|
|
35638
|
+
class SensitivityLabelDetails extends OfficeExtension.ClientObject {
|
|
35639
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35640
|
+
context: RequestContext;
|
|
35641
|
+
/**
|
|
35642
|
+
* Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
|
|
35643
|
+
*
|
|
35644
|
+
* @remarks
|
|
35645
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35646
|
+
* @beta
|
|
35647
|
+
*/
|
|
35648
|
+
readonly children: SensitivityLabelDetailsCollection | null;
|
|
35649
|
+
/**
|
|
35650
|
+
* Gets the color of the sensitivity label.
|
|
35651
|
+
*
|
|
35652
|
+
* @remarks
|
|
35653
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35654
|
+
* @beta
|
|
35655
|
+
*/
|
|
35656
|
+
readonly color: string;
|
|
35657
|
+
/**
|
|
35658
|
+
* Gets the unique identifier (GUID) of the sensitivity label.
|
|
35659
|
+
*
|
|
35660
|
+
* @remarks
|
|
35661
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35662
|
+
* @beta
|
|
35663
|
+
*/
|
|
35664
|
+
readonly id: string;
|
|
35665
|
+
/**
|
|
35666
|
+
* Gets a value indicating whether the label is enabled.
|
|
35667
|
+
*
|
|
35668
|
+
* @remarks
|
|
35669
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35670
|
+
* @beta
|
|
35671
|
+
*/
|
|
35672
|
+
readonly isEnabled: boolean;
|
|
35673
|
+
/**
|
|
35674
|
+
* Gets the name of the sensitivity label.
|
|
35675
|
+
*
|
|
35676
|
+
* @remarks
|
|
35677
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35678
|
+
* @beta
|
|
35679
|
+
*/
|
|
35680
|
+
readonly name: string;
|
|
35681
|
+
/**
|
|
35682
|
+
* Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
35683
|
+
*
|
|
35684
|
+
* @remarks
|
|
35685
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35686
|
+
* @beta
|
|
35687
|
+
*/
|
|
35688
|
+
readonly order: number;
|
|
35689
|
+
/**
|
|
35690
|
+
* Gets a value indicating the protection type provided by this label.
|
|
35691
|
+
*
|
|
35692
|
+
* @remarks
|
|
35693
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35694
|
+
* @beta
|
|
35695
|
+
*/
|
|
35696
|
+
readonly protectionType: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
35697
|
+
/**
|
|
35698
|
+
* Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
35699
|
+
*
|
|
35700
|
+
* @remarks
|
|
35701
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35702
|
+
* @beta
|
|
35703
|
+
*/
|
|
35704
|
+
readonly siteId: string;
|
|
35705
|
+
/**
|
|
35706
|
+
* Gets the description of the sensitivity label.
|
|
35707
|
+
*
|
|
35708
|
+
* @remarks
|
|
35709
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35710
|
+
* @beta
|
|
35711
|
+
*/
|
|
35712
|
+
readonly tooltip: string;
|
|
35713
|
+
/**
|
|
35714
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35715
|
+
*
|
|
35716
|
+
* @param options Provides options for which properties of the object to load.
|
|
35717
|
+
*/
|
|
35718
|
+
load(options?: Excel.Interfaces.SensitivityLabelDetailsLoadOptions): Excel.SensitivityLabelDetails;
|
|
35719
|
+
/**
|
|
35720
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35721
|
+
*
|
|
35722
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
35723
|
+
*/
|
|
35724
|
+
load(propertyNames?: string | string[]): Excel.SensitivityLabelDetails;
|
|
35725
|
+
/**
|
|
35726
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35727
|
+
*
|
|
35728
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
35729
|
+
*/
|
|
35730
|
+
load(propertyNamesAndPaths?: {
|
|
35731
|
+
select?: string;
|
|
35732
|
+
expand?: string;
|
|
35733
|
+
}): Excel.SensitivityLabelDetails;
|
|
35734
|
+
/**
|
|
35735
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
35736
|
+
* Whereas the original `Excel.SensitivityLabelDetails` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelDetailsData`) that contains shallow copies of any loaded child properties from the original object.
|
|
35737
|
+
*/
|
|
35738
|
+
toJSON(): Excel.Interfaces.SensitivityLabelDetailsData;
|
|
35739
|
+
}
|
|
35740
|
+
/**
|
|
35741
|
+
* Represents the collection of {@link Excel.SensitivityLabelDetails} objects.
|
|
35742
|
+
*
|
|
35743
|
+
* @remarks
|
|
35744
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35745
|
+
* @beta
|
|
35746
|
+
*/
|
|
35747
|
+
class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject {
|
|
35748
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35749
|
+
context: RequestContext;
|
|
35750
|
+
/** Gets the loaded child items in this collection. */
|
|
35751
|
+
readonly items: Excel.SensitivityLabelDetails[];
|
|
35752
|
+
/**
|
|
35753
|
+
* Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
35754
|
+
*
|
|
35755
|
+
* @remarks
|
|
35756
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35757
|
+
* @beta
|
|
35758
|
+
* @returns A new `SensitivityLabelDetails` object.
|
|
35759
|
+
*/
|
|
35760
|
+
getFirst(): Excel.SensitivityLabelDetails;
|
|
35761
|
+
/**
|
|
35762
|
+
* Gets the first `SensitivityLabelDetails` object in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
35763
|
+
*
|
|
35764
|
+
* @remarks
|
|
35765
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35766
|
+
* @beta
|
|
35767
|
+
* @returns The new `SensitivityLabelDetails` object.
|
|
35768
|
+
*/
|
|
35769
|
+
getFirstOrNullObject(): OfficeExtension.ClientResult<any>;
|
|
35770
|
+
/**
|
|
35771
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35772
|
+
*
|
|
35773
|
+
* @param options Provides options for which properties of the object to load.
|
|
35774
|
+
*/
|
|
35775
|
+
load(options?: Excel.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.SensitivityLabelDetailsCollection;
|
|
35776
|
+
/**
|
|
35777
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35778
|
+
*
|
|
35779
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
35780
|
+
*/
|
|
35781
|
+
load(propertyNames?: string | string[]): Excel.SensitivityLabelDetailsCollection;
|
|
35782
|
+
/**
|
|
35783
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35784
|
+
*
|
|
35785
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
35786
|
+
*/
|
|
35787
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.SensitivityLabelDetailsCollection;
|
|
35788
|
+
/**
|
|
35789
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
35790
|
+
* Whereas the original `Excel.SensitivityLabelDetailsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelDetailsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
35791
|
+
*/
|
|
35792
|
+
toJSON(): Excel.Interfaces.SensitivityLabelDetailsCollectionData;
|
|
35793
|
+
}
|
|
35794
|
+
/**
|
|
35795
|
+
* Represents the protection type.
|
|
35796
|
+
*
|
|
35797
|
+
* @remarks
|
|
35798
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35799
|
+
* @beta
|
|
35800
|
+
*/
|
|
35801
|
+
enum SensitivityLabelProtectionType {
|
|
35802
|
+
/**
|
|
35803
|
+
* No protection is applied by this label.
|
|
35804
|
+
* @remarks
|
|
35805
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35806
|
+
* @beta
|
|
35807
|
+
*/
|
|
35808
|
+
noProtection = "NoProtection",
|
|
35809
|
+
/**
|
|
35810
|
+
* Protection is defined by an administrator.
|
|
35811
|
+
* @remarks
|
|
35812
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35813
|
+
* @beta
|
|
35814
|
+
*/
|
|
35815
|
+
adminDefined = "AdminDefined",
|
|
35816
|
+
/**
|
|
35817
|
+
* Protection is defined by the user.
|
|
35818
|
+
* @remarks
|
|
35819
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35820
|
+
* @beta
|
|
35821
|
+
*/
|
|
35822
|
+
userDefined = "UserDefined"
|
|
35823
|
+
}
|
|
35824
|
+
/**
|
|
35825
|
+
* Represents the result of updating the sensitivity label on the workbook.
|
|
35826
|
+
*
|
|
35827
|
+
* @remarks
|
|
35828
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35829
|
+
* @beta
|
|
35830
|
+
*/
|
|
35831
|
+
enum SensitivityLabelUpdateResult {
|
|
35832
|
+
/**
|
|
35833
|
+
* The sensitivity label was successfully updated.
|
|
35834
|
+
* @remarks
|
|
35835
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35836
|
+
* @beta
|
|
35837
|
+
*/
|
|
35838
|
+
success = "Success",
|
|
35839
|
+
/**
|
|
35840
|
+
* The update failed due to an unspecified error.
|
|
35841
|
+
* @remarks
|
|
35842
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35843
|
+
* @beta
|
|
35844
|
+
*/
|
|
35845
|
+
unspecifiedFailure = "UnspecifiedFailure",
|
|
35846
|
+
/**
|
|
35847
|
+
* The specified sensitivity label could not be found.
|
|
35848
|
+
* @remarks
|
|
35849
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35850
|
+
* @beta
|
|
35851
|
+
*/
|
|
35852
|
+
labelNotFound = "LabelNotFound",
|
|
35853
|
+
/**
|
|
35854
|
+
* The document is read-only and cannot be modified.
|
|
35855
|
+
* @remarks
|
|
35856
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35857
|
+
* @beta
|
|
35858
|
+
*/
|
|
35859
|
+
documentReadOnly = "DocumentReadOnly",
|
|
35860
|
+
/**
|
|
35861
|
+
* The user does not have sufficient permissions to update the label.
|
|
35862
|
+
* @remarks
|
|
35863
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35864
|
+
* @beta
|
|
35865
|
+
*/
|
|
35866
|
+
insufficientPermission = "InsufficientPermission",
|
|
35867
|
+
/**
|
|
35868
|
+
* The label update failed due to unsupported Double Key Encryption (DKE).
|
|
35869
|
+
* @remarks
|
|
35870
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35871
|
+
* @beta
|
|
35872
|
+
*/
|
|
35873
|
+
unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption",
|
|
35874
|
+
/**
|
|
35875
|
+
* The label update failed because native labeling is not enabled for the user or installed SKU.
|
|
35876
|
+
* @remarks
|
|
35877
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35878
|
+
* @beta
|
|
35879
|
+
*/
|
|
35880
|
+
labelingDisabled = "LabelingDisabled",
|
|
35881
|
+
/**
|
|
35882
|
+
* The label update failed because the user's identity is not valid for applying a label.
|
|
35883
|
+
* @remarks
|
|
35884
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35885
|
+
* @beta
|
|
35886
|
+
*/
|
|
35887
|
+
userNotFound = "UserNotFound",
|
|
35888
|
+
/**
|
|
35889
|
+
* The label update failed due to unsupported User Defined Permissions (UDP).
|
|
35890
|
+
* @remarks
|
|
35891
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35892
|
+
* @beta
|
|
35893
|
+
*/
|
|
35894
|
+
unsupportedUdp = "UnsupportedUdp",
|
|
35895
|
+
/**
|
|
35896
|
+
* The label update failed because the specified label is a parent label, which cannot be applied.
|
|
35897
|
+
* @remarks
|
|
35898
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35899
|
+
* @beta
|
|
35900
|
+
*/
|
|
35901
|
+
parentLabelNotSupported = "ParentLabelNotSupported",
|
|
35902
|
+
/**
|
|
35903
|
+
* The label update failed because the document doesn't belong to the same tenant as the user.
|
|
35904
|
+
* @remarks
|
|
35905
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35906
|
+
* @beta
|
|
35907
|
+
*/
|
|
35908
|
+
crossTenant = "CrossTenant"
|
|
35909
|
+
}
|
|
35910
|
+
/**
|
|
35911
|
+
* Provides methods to check the status of the catalog of sensitivity labels in Excel and retrieve all available sensitivity labels if the catalog is enabled.
|
|
35912
|
+
*
|
|
35913
|
+
* @remarks
|
|
35914
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35915
|
+
* @beta
|
|
35916
|
+
*/
|
|
35917
|
+
class SensitivityLabelsCatalog extends OfficeExtension.ClientObject {
|
|
35918
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
35919
|
+
context: RequestContext;
|
|
35920
|
+
/**
|
|
35921
|
+
* Gets whether the catalog of sensitivity labels is enabled in Excel.
|
|
35922
|
+
*
|
|
35923
|
+
* @remarks
|
|
35924
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35925
|
+
* @beta
|
|
35926
|
+
*/
|
|
35927
|
+
readonly getLabelingCapability: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
35928
|
+
/**
|
|
35929
|
+
* Gets sensitivity labels that are available to the current user.
|
|
35930
|
+
*
|
|
35931
|
+
* @remarks
|
|
35932
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
35933
|
+
* @beta
|
|
35934
|
+
* @returns The current `SensitivityLabelDetailsCollection` object.
|
|
35935
|
+
*/
|
|
35936
|
+
getLabels(): Excel.SensitivityLabelDetailsCollection;
|
|
35937
|
+
/**
|
|
35938
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35939
|
+
*
|
|
35940
|
+
* @param options Provides options for which properties of the object to load.
|
|
35941
|
+
*/
|
|
35942
|
+
load(options?: Excel.Interfaces.SensitivityLabelsCatalogLoadOptions): Excel.SensitivityLabelsCatalog;
|
|
35943
|
+
/**
|
|
35944
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35945
|
+
*
|
|
35946
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
35947
|
+
*/
|
|
35948
|
+
load(propertyNames?: string | string[]): Excel.SensitivityLabelsCatalog;
|
|
35949
|
+
/**
|
|
35950
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
35951
|
+
*
|
|
35952
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
35953
|
+
*/
|
|
35954
|
+
load(propertyNamesAndPaths?: {
|
|
35955
|
+
select?: string;
|
|
35956
|
+
expand?: string;
|
|
35957
|
+
}): Excel.SensitivityLabelsCatalog;
|
|
35958
|
+
/**
|
|
35959
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
35960
|
+
* Whereas the original `Excel.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object.
|
|
35961
|
+
*/
|
|
35962
|
+
toJSON(): Excel.Interfaces.SensitivityLabelsCatalogData;
|
|
35963
|
+
}
|
|
35628
35964
|
/**
|
|
35629
35965
|
* Provides information about the ranges that raised the `onCalculationBusy` event, which triggers when the calculation is in progress in a worksheet.
|
|
35630
35966
|
*
|
|
@@ -40904,6 +41240,14 @@ declare namespace Excel {
|
|
|
40904
41240
|
* [Api set: ExcelApi 1.1]
|
|
40905
41241
|
*/
|
|
40906
41242
|
readonly worksheets: Excel.WorksheetCollection;
|
|
41243
|
+
/**
|
|
41244
|
+
* Returns the sensitivity label of the workbook.
|
|
41245
|
+
*
|
|
41246
|
+
* @remarks
|
|
41247
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
41248
|
+
* @beta
|
|
41249
|
+
*/
|
|
41250
|
+
readonly sensitivityLabel: Excel.SensitivityLabel;
|
|
40907
41251
|
/**
|
|
40908
41252
|
* Specifies if the workbook is in AutoSave mode.
|
|
40909
41253
|
*
|
|
@@ -62292,6 +62636,55 @@ declare namespace Excel {
|
|
|
62292
62636
|
*/
|
|
62293
62637
|
toJSON(): Excel.Interfaces.SlicerItemCollectionData;
|
|
62294
62638
|
}
|
|
62639
|
+
/**
|
|
62640
|
+
* Provides information about the `LinkedEntityCellValue` that was requested given a specified `LinkedEntityId`.
|
|
62641
|
+
*
|
|
62642
|
+
* @remarks
|
|
62643
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62644
|
+
* @beta
|
|
62645
|
+
*/
|
|
62646
|
+
interface LinkedEntityCellValueLoadedEventArgs {
|
|
62647
|
+
/**
|
|
62648
|
+
* Any error encountered during the request to load the `LinkedEntityCellValue`.
|
|
62649
|
+
*
|
|
62650
|
+
* @remarks
|
|
62651
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62652
|
+
* @beta
|
|
62653
|
+
*/
|
|
62654
|
+
error?: string;
|
|
62655
|
+
/**
|
|
62656
|
+
* Gets the `LinkedEntityId` of the requested `LinkedEntityCellValue`.
|
|
62657
|
+
*
|
|
62658
|
+
* @remarks
|
|
62659
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62660
|
+
* @beta
|
|
62661
|
+
*/
|
|
62662
|
+
id: LinkedEntityId;
|
|
62663
|
+
/**
|
|
62664
|
+
* Gets the `LinkedEntityCellValue` of the requested `LinkedEntityId`. If the load operation failed, this property is `null`.
|
|
62665
|
+
*
|
|
62666
|
+
* @remarks
|
|
62667
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62668
|
+
* @beta
|
|
62669
|
+
*/
|
|
62670
|
+
linkedEntityCellValue?: LinkedEntityCellValue;
|
|
62671
|
+
/**
|
|
62672
|
+
* Gets the source of the event. See `Excel.EventSource` for details.
|
|
62673
|
+
*
|
|
62674
|
+
* @remarks
|
|
62675
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62676
|
+
* @beta
|
|
62677
|
+
*/
|
|
62678
|
+
source: Excel.EventSource | "Local" | "Remote";
|
|
62679
|
+
/**
|
|
62680
|
+
* Gets the type of the event. See `Excel.EventType` for details.
|
|
62681
|
+
*
|
|
62682
|
+
* @remarks
|
|
62683
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62684
|
+
* @beta
|
|
62685
|
+
*/
|
|
62686
|
+
type: "LinkedEntityDataDomainLinkedEntityCellValueLoaded";
|
|
62687
|
+
}
|
|
62295
62688
|
/**
|
|
62296
62689
|
* Represents a specific category or field of information that shares some common characteristics or attributes.
|
|
62297
62690
|
A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook.
|
|
@@ -62592,6 +62985,17 @@ declare namespace Excel {
|
|
|
62592
62985
|
* @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned.
|
|
62593
62986
|
*/
|
|
62594
62987
|
getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;
|
|
62988
|
+
/**
|
|
62989
|
+
* Submits a request to load the `LinkedEntityCellValue` object with the specified `LinkedEntityId`.
|
|
62990
|
+
If found, the `LinkedEntityCellValue` object will be returned through the `LinkedEntityCellValueLoaded` event.
|
|
62991
|
+
*
|
|
62992
|
+
* @remarks
|
|
62993
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
62994
|
+
* @beta
|
|
62995
|
+
*
|
|
62996
|
+
* @param id A specific `LinkedEntityId`
|
|
62997
|
+
*/
|
|
62998
|
+
loadLinkedEntityCellValue(id: LinkedEntityId): void;
|
|
62595
62999
|
/**
|
|
62596
63000
|
* Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.
|
|
62597
63001
|
The refresh request can fail if the data providers are busy or temporarily inaccessible.
|
|
@@ -62620,6 +63024,16 @@ declare namespace Excel {
|
|
|
62620
63024
|
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
62621
63025
|
*/
|
|
62622
63026
|
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;
|
|
63027
|
+
/**
|
|
63028
|
+
* Occurs when the request to load a `LinkedEntityCellValue` is completed.
|
|
63029
|
+
*
|
|
63030
|
+
* @remarks
|
|
63031
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
63032
|
+
*
|
|
63033
|
+
* @eventproperty
|
|
63034
|
+
* @beta
|
|
63035
|
+
*/
|
|
63036
|
+
readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers<Excel.LinkedEntityCellValueLoadedEventArgs>;
|
|
62623
63037
|
/**
|
|
62624
63038
|
* Occurs when a new linked entity data domain is added to the workbook.
|
|
62625
63039
|
*
|
|
@@ -74968,6 +75382,10 @@ declare namespace Excel {
|
|
|
74968
75382
|
*/
|
|
74969
75383
|
$skip?: number;
|
|
74970
75384
|
}
|
|
75385
|
+
/** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */
|
|
75386
|
+
interface SensitivityLabelDetailsCollectionUpdateData {
|
|
75387
|
+
items?: Excel.Interfaces.SensitivityLabelDetailsData[];
|
|
75388
|
+
}
|
|
74971
75389
|
/** An interface for updating data on the `AllowEditRange` object, for use in `allowEditRange.set({ ... })`. */
|
|
74972
75390
|
interface AllowEditRangeUpdateData {
|
|
74973
75391
|
/**
|
|
@@ -80621,6 +81039,96 @@ declare namespace Excel {
|
|
|
80621
81039
|
interface PaneCollectionUpdateData {
|
|
80622
81040
|
items?: Excel.Interfaces.PaneData[];
|
|
80623
81041
|
}
|
|
81042
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */
|
|
81043
|
+
interface SensitivityLabelDetailsData {
|
|
81044
|
+
/**
|
|
81045
|
+
* Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
|
|
81046
|
+
*
|
|
81047
|
+
* @remarks
|
|
81048
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81049
|
+
* @beta
|
|
81050
|
+
*/
|
|
81051
|
+
children?: SensitivityLabelDetailsCollection | null;
|
|
81052
|
+
/**
|
|
81053
|
+
* Gets the color of the sensitivity label.
|
|
81054
|
+
*
|
|
81055
|
+
* @remarks
|
|
81056
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81057
|
+
* @beta
|
|
81058
|
+
*/
|
|
81059
|
+
color?: string;
|
|
81060
|
+
/**
|
|
81061
|
+
* Gets the unique identifier (GUID) of the sensitivity label.
|
|
81062
|
+
*
|
|
81063
|
+
* @remarks
|
|
81064
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81065
|
+
* @beta
|
|
81066
|
+
*/
|
|
81067
|
+
id?: string;
|
|
81068
|
+
/**
|
|
81069
|
+
* Gets a value indicating whether the label is enabled.
|
|
81070
|
+
*
|
|
81071
|
+
* @remarks
|
|
81072
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81073
|
+
* @beta
|
|
81074
|
+
*/
|
|
81075
|
+
isEnabled?: boolean;
|
|
81076
|
+
/**
|
|
81077
|
+
* Gets the name of the sensitivity label.
|
|
81078
|
+
*
|
|
81079
|
+
* @remarks
|
|
81080
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81081
|
+
* @beta
|
|
81082
|
+
*/
|
|
81083
|
+
name?: string;
|
|
81084
|
+
/**
|
|
81085
|
+
* Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
81086
|
+
*
|
|
81087
|
+
* @remarks
|
|
81088
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81089
|
+
* @beta
|
|
81090
|
+
*/
|
|
81091
|
+
order?: number;
|
|
81092
|
+
/**
|
|
81093
|
+
* Gets a value indicating the protection type provided by this label.
|
|
81094
|
+
*
|
|
81095
|
+
* @remarks
|
|
81096
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81097
|
+
* @beta
|
|
81098
|
+
*/
|
|
81099
|
+
protectionType?: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
81100
|
+
/**
|
|
81101
|
+
* Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
81102
|
+
*
|
|
81103
|
+
* @remarks
|
|
81104
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81105
|
+
* @beta
|
|
81106
|
+
*/
|
|
81107
|
+
siteId?: string;
|
|
81108
|
+
/**
|
|
81109
|
+
* Gets the description of the sensitivity label.
|
|
81110
|
+
*
|
|
81111
|
+
* @remarks
|
|
81112
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81113
|
+
* @beta
|
|
81114
|
+
*/
|
|
81115
|
+
tooltip?: string;
|
|
81116
|
+
}
|
|
81117
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */
|
|
81118
|
+
interface SensitivityLabelDetailsCollectionData {
|
|
81119
|
+
items?: Excel.Interfaces.SensitivityLabelDetailsData[];
|
|
81120
|
+
}
|
|
81121
|
+
/** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */
|
|
81122
|
+
interface SensitivityLabelsCatalogData {
|
|
81123
|
+
/**
|
|
81124
|
+
* Gets whether the catalog of sensitivity labels is enabled in Excel.
|
|
81125
|
+
*
|
|
81126
|
+
* @remarks
|
|
81127
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
81128
|
+
* @beta
|
|
81129
|
+
*/
|
|
81130
|
+
getLabelingCapability?: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
81131
|
+
}
|
|
80624
81132
|
/** An interface describing the data returned by calling `allowEditRange.toJSON()`. */
|
|
80625
81133
|
interface AllowEditRangeData {
|
|
80626
81134
|
/**
|
|
@@ -88413,6 +88921,197 @@ declare namespace Excel {
|
|
|
88413
88921
|
*/
|
|
88414
88922
|
value?: T;
|
|
88415
88923
|
}
|
|
88924
|
+
/**
|
|
88925
|
+
* Represents the properties of available sensitivity labels in Excel.
|
|
88926
|
+
*
|
|
88927
|
+
* @remarks
|
|
88928
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88929
|
+
* @beta
|
|
88930
|
+
*/
|
|
88931
|
+
interface SensitivityLabelDetailsLoadOptions {
|
|
88932
|
+
/**
|
|
88933
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
88934
|
+
*/
|
|
88935
|
+
$all?: boolean;
|
|
88936
|
+
/**
|
|
88937
|
+
* Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
|
|
88938
|
+
*
|
|
88939
|
+
* @remarks
|
|
88940
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88941
|
+
* @beta
|
|
88942
|
+
*/
|
|
88943
|
+
children?: boolean;
|
|
88944
|
+
/**
|
|
88945
|
+
* Gets the color of the sensitivity label.
|
|
88946
|
+
*
|
|
88947
|
+
* @remarks
|
|
88948
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88949
|
+
* @beta
|
|
88950
|
+
*/
|
|
88951
|
+
color?: boolean;
|
|
88952
|
+
/**
|
|
88953
|
+
* Gets the unique identifier (GUID) of the sensitivity label.
|
|
88954
|
+
*
|
|
88955
|
+
* @remarks
|
|
88956
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88957
|
+
* @beta
|
|
88958
|
+
*/
|
|
88959
|
+
id?: boolean;
|
|
88960
|
+
/**
|
|
88961
|
+
* Gets a value indicating whether the label is enabled.
|
|
88962
|
+
*
|
|
88963
|
+
* @remarks
|
|
88964
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88965
|
+
* @beta
|
|
88966
|
+
*/
|
|
88967
|
+
isEnabled?: boolean;
|
|
88968
|
+
/**
|
|
88969
|
+
* Gets the name of the sensitivity label.
|
|
88970
|
+
*
|
|
88971
|
+
* @remarks
|
|
88972
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88973
|
+
* @beta
|
|
88974
|
+
*/
|
|
88975
|
+
name?: boolean;
|
|
88976
|
+
/**
|
|
88977
|
+
* Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
88978
|
+
*
|
|
88979
|
+
* @remarks
|
|
88980
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88981
|
+
* @beta
|
|
88982
|
+
*/
|
|
88983
|
+
order?: boolean;
|
|
88984
|
+
/**
|
|
88985
|
+
* Gets a value indicating the protection type provided by this label.
|
|
88986
|
+
*
|
|
88987
|
+
* @remarks
|
|
88988
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88989
|
+
* @beta
|
|
88990
|
+
*/
|
|
88991
|
+
protectionType?: boolean;
|
|
88992
|
+
/**
|
|
88993
|
+
* Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
88994
|
+
*
|
|
88995
|
+
* @remarks
|
|
88996
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
88997
|
+
* @beta
|
|
88998
|
+
*/
|
|
88999
|
+
siteId?: boolean;
|
|
89000
|
+
/**
|
|
89001
|
+
* Gets the description of the sensitivity label.
|
|
89002
|
+
*
|
|
89003
|
+
* @remarks
|
|
89004
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89005
|
+
* @beta
|
|
89006
|
+
*/
|
|
89007
|
+
tooltip?: boolean;
|
|
89008
|
+
}
|
|
89009
|
+
/**
|
|
89010
|
+
* Represents the collection of {@link Excel.SensitivityLabelDetails} objects.
|
|
89011
|
+
*
|
|
89012
|
+
* @remarks
|
|
89013
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89014
|
+
* @beta
|
|
89015
|
+
*/
|
|
89016
|
+
interface SensitivityLabelDetailsCollectionLoadOptions {
|
|
89017
|
+
/**
|
|
89018
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
89019
|
+
*/
|
|
89020
|
+
$all?: boolean;
|
|
89021
|
+
/**
|
|
89022
|
+
* For EACH ITEM in the collection: Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
|
|
89023
|
+
*
|
|
89024
|
+
* @remarks
|
|
89025
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89026
|
+
* @beta
|
|
89027
|
+
*/
|
|
89028
|
+
children?: boolean;
|
|
89029
|
+
/**
|
|
89030
|
+
* For EACH ITEM in the collection: Gets the color of the sensitivity label.
|
|
89031
|
+
*
|
|
89032
|
+
* @remarks
|
|
89033
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89034
|
+
* @beta
|
|
89035
|
+
*/
|
|
89036
|
+
color?: boolean;
|
|
89037
|
+
/**
|
|
89038
|
+
* For EACH ITEM in the collection: Gets the unique identifier (GUID) of the sensitivity label.
|
|
89039
|
+
*
|
|
89040
|
+
* @remarks
|
|
89041
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89042
|
+
* @beta
|
|
89043
|
+
*/
|
|
89044
|
+
id?: boolean;
|
|
89045
|
+
/**
|
|
89046
|
+
* For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.
|
|
89047
|
+
*
|
|
89048
|
+
* @remarks
|
|
89049
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89050
|
+
* @beta
|
|
89051
|
+
*/
|
|
89052
|
+
isEnabled?: boolean;
|
|
89053
|
+
/**
|
|
89054
|
+
* For EACH ITEM in the collection: Gets the name of the sensitivity label.
|
|
89055
|
+
*
|
|
89056
|
+
* @remarks
|
|
89057
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89058
|
+
* @beta
|
|
89059
|
+
*/
|
|
89060
|
+
name?: boolean;
|
|
89061
|
+
/**
|
|
89062
|
+
* For EACH ITEM in the collection: Gets the priority of the sensitivity label, with 0 as lowest priority.
|
|
89063
|
+
*
|
|
89064
|
+
* @remarks
|
|
89065
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89066
|
+
* @beta
|
|
89067
|
+
*/
|
|
89068
|
+
order?: boolean;
|
|
89069
|
+
/**
|
|
89070
|
+
* For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.
|
|
89071
|
+
*
|
|
89072
|
+
* @remarks
|
|
89073
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89074
|
+
* @beta
|
|
89075
|
+
*/
|
|
89076
|
+
protectionType?: boolean;
|
|
89077
|
+
/**
|
|
89078
|
+
* For EACH ITEM in the collection: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
89079
|
+
*
|
|
89080
|
+
* @remarks
|
|
89081
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89082
|
+
* @beta
|
|
89083
|
+
*/
|
|
89084
|
+
siteId?: boolean;
|
|
89085
|
+
/**
|
|
89086
|
+
* For EACH ITEM in the collection: Gets the description of the sensitivity label.
|
|
89087
|
+
*
|
|
89088
|
+
* @remarks
|
|
89089
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89090
|
+
* @beta
|
|
89091
|
+
*/
|
|
89092
|
+
tooltip?: boolean;
|
|
89093
|
+
}
|
|
89094
|
+
/**
|
|
89095
|
+
* Provides methods to check the status of the catalog of sensitivity labels in Excel and retrieve all available sensitivity labels if the catalog is enabled.
|
|
89096
|
+
*
|
|
89097
|
+
* @remarks
|
|
89098
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89099
|
+
* @beta
|
|
89100
|
+
*/
|
|
89101
|
+
interface SensitivityLabelsCatalogLoadOptions {
|
|
89102
|
+
/**
|
|
89103
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
89104
|
+
*/
|
|
89105
|
+
$all?: boolean;
|
|
89106
|
+
/**
|
|
89107
|
+
* Gets whether the catalog of sensitivity labels is enabled in Excel.
|
|
89108
|
+
*
|
|
89109
|
+
* @remarks
|
|
89110
|
+
* [Api set: ExcelApi BETA (PREVIEW ONLY)]
|
|
89111
|
+
* @beta
|
|
89112
|
+
*/
|
|
89113
|
+
getLabelingCapability?: boolean;
|
|
89114
|
+
}
|
|
88416
89115
|
/**
|
|
88417
89116
|
* Represents an `AllowEditRange` object found in a worksheet. This object works with worksheet protection properties.
|
|
88418
89117
|
When worksheet protection is enabled, an `AllowEditRange` object can be used to allow editing of a specific range, while maintaining protection on the rest of the worksheet.
|
|
@@ -108108,6 +108807,14 @@ declare namespace Word {
|
|
|
108108
108807
|
* [Api set: WordApiDesktop 1.4]
|
|
108109
108808
|
*/
|
|
108110
108809
|
readonly selection: Word.Selection;
|
|
108810
|
+
/**
|
|
108811
|
+
* Returns the sensitivity label of the document.
|
|
108812
|
+
*
|
|
108813
|
+
* @remarks
|
|
108814
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
108815
|
+
* @beta
|
|
108816
|
+
*/
|
|
108817
|
+
readonly sensitivityLabel: Word.SensitivityLabel;
|
|
108111
108818
|
/**
|
|
108112
108819
|
* Gets the `RangeScopedCollection` object that represents all the sentences in the document.
|
|
108113
108820
|
*
|
|
@@ -116705,6 +117412,318 @@ declare namespace Word {
|
|
|
116705
117412
|
*/
|
|
116706
117413
|
toJSON(): Word.Interfaces.SectionCollectionData;
|
|
116707
117414
|
}
|
|
117415
|
+
/**
|
|
117416
|
+
* Represents the sensitivity label on the document.
|
|
117417
|
+
*
|
|
117418
|
+
* @remarks
|
|
117419
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117420
|
+
* @beta
|
|
117421
|
+
*/
|
|
117422
|
+
class SensitivityLabel extends OfficeExtension.ClientObject {
|
|
117423
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
117424
|
+
context: RequestContext;
|
|
117425
|
+
/**
|
|
117426
|
+
* Gets the current label information that exists on the document for the user.
|
|
117427
|
+
*
|
|
117428
|
+
* @remarks
|
|
117429
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117430
|
+
* @beta
|
|
117431
|
+
*/
|
|
117432
|
+
getCurrentOrNullObject(): Word.SensitivityLabelDetails;
|
|
117433
|
+
/**
|
|
117434
|
+
* Try to update to the provided sensitivity label on the document for the user.
|
|
117435
|
+
*
|
|
117436
|
+
* @remarks
|
|
117437
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117438
|
+
* @beta
|
|
117439
|
+
*
|
|
117440
|
+
* @param LabelId The label information that needs to be set on the document.
|
|
117441
|
+
* @param Justification Optional. The justification of changing the label.
|
|
117442
|
+
*/
|
|
117443
|
+
tryToUpdate(LabelId: string, Justification?: string): OfficeExtension.ClientResult<Word.SensitivityLabelUpdateResult>;
|
|
117444
|
+
/**
|
|
117445
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117446
|
+
*
|
|
117447
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
117448
|
+
*/
|
|
117449
|
+
load(propertyNames?: string | string[]): Word.SensitivityLabel;
|
|
117450
|
+
/**
|
|
117451
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117452
|
+
*
|
|
117453
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
117454
|
+
*/
|
|
117455
|
+
load(propertyNamesAndPaths?: {
|
|
117456
|
+
select?: string;
|
|
117457
|
+
expand?: string;
|
|
117458
|
+
}): Word.SensitivityLabel;
|
|
117459
|
+
/**
|
|
117460
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
117461
|
+
*/
|
|
117462
|
+
track(): Word.SensitivityLabel;
|
|
117463
|
+
/**
|
|
117464
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
117465
|
+
*/
|
|
117466
|
+
untrack(): Word.SensitivityLabel;
|
|
117467
|
+
/**
|
|
117468
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
117469
|
+
* Whereas the original `Word.SensitivityLabel` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117470
|
+
*/
|
|
117471
|
+
toJSON(): {
|
|
117472
|
+
[key: string]: string;
|
|
117473
|
+
};
|
|
117474
|
+
}
|
|
117475
|
+
/**
|
|
117476
|
+
* Provides methods to check the status of the catalog of sensitivity labels in Word and retrieve all available sensitivity labels if the catalog is enabled.
|
|
117477
|
+
*
|
|
117478
|
+
* @remarks
|
|
117479
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117480
|
+
* @beta
|
|
117481
|
+
*/
|
|
117482
|
+
class SensitivityLabelsCatalog extends OfficeExtension.ClientObject {
|
|
117483
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
117484
|
+
context: RequestContext;
|
|
117485
|
+
/**
|
|
117486
|
+
* Gets the labeling capability status of the sensitivity label catalog in Word.
|
|
117487
|
+
*
|
|
117488
|
+
* @remarks
|
|
117489
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117490
|
+
* @beta
|
|
117491
|
+
*/
|
|
117492
|
+
readonly getLabelingCapability: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
117493
|
+
/**
|
|
117494
|
+
* Gets all the sensitivity labels that are enabled in Word.
|
|
117495
|
+
*
|
|
117496
|
+
* @remarks
|
|
117497
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117498
|
+
* @beta
|
|
117499
|
+
*/
|
|
117500
|
+
getLabels(): Word.SensitivityLabelDetailsCollection;
|
|
117501
|
+
/**
|
|
117502
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117503
|
+
*
|
|
117504
|
+
* @param options Provides options for which properties of the object to load.
|
|
117505
|
+
*/
|
|
117506
|
+
load(options?: Word.Interfaces.SensitivityLabelsCatalogLoadOptions): Word.SensitivityLabelsCatalog;
|
|
117507
|
+
/**
|
|
117508
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117509
|
+
*
|
|
117510
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
117511
|
+
*/
|
|
117512
|
+
load(propertyNames?: string | string[]): Word.SensitivityLabelsCatalog;
|
|
117513
|
+
/**
|
|
117514
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117515
|
+
*
|
|
117516
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
117517
|
+
*/
|
|
117518
|
+
load(propertyNamesAndPaths?: {
|
|
117519
|
+
select?: string;
|
|
117520
|
+
expand?: string;
|
|
117521
|
+
}): Word.SensitivityLabelsCatalog;
|
|
117522
|
+
/**
|
|
117523
|
+
* Create a new instance of the `Word.SensitivityLabelsCatalog` object.
|
|
117524
|
+
*/
|
|
117525
|
+
static newObject(context: OfficeExtension.ClientRequestContext): Word.SensitivityLabelsCatalog;
|
|
117526
|
+
/**
|
|
117527
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
117528
|
+
*/
|
|
117529
|
+
track(): Word.SensitivityLabelsCatalog;
|
|
117530
|
+
/**
|
|
117531
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
117532
|
+
*/
|
|
117533
|
+
untrack(): Word.SensitivityLabelsCatalog;
|
|
117534
|
+
/**
|
|
117535
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
117536
|
+
* Whereas the original `Word.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117537
|
+
*/
|
|
117538
|
+
toJSON(): Word.Interfaces.SensitivityLabelsCatalogData;
|
|
117539
|
+
}
|
|
117540
|
+
/**
|
|
117541
|
+
* Represents the collection of {@link Word.SensitivityLabelDetails} objects.
|
|
117542
|
+
*
|
|
117543
|
+
* @remarks
|
|
117544
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117545
|
+
* @beta
|
|
117546
|
+
*/
|
|
117547
|
+
class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject {
|
|
117548
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
117549
|
+
context: RequestContext;
|
|
117550
|
+
/** Gets the loaded child items in this collection. */
|
|
117551
|
+
readonly items: Word.SensitivityLabelDetails[];
|
|
117552
|
+
/**
|
|
117553
|
+
* Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty.
|
|
117554
|
+
*
|
|
117555
|
+
* @remarks
|
|
117556
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117557
|
+
* @beta
|
|
117558
|
+
*/
|
|
117559
|
+
getFirst(): Word.SensitivityLabelDetails;
|
|
117560
|
+
/**
|
|
117561
|
+
* Gets the first `SensitivityLabelDetails` object in this collection. If this collection is empty, then this method will return an object with its `isNullObject` property set to `true`. For further information, see {@link https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
|
|
117562
|
+
*
|
|
117563
|
+
* @remarks
|
|
117564
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117565
|
+
* @beta
|
|
117566
|
+
*/
|
|
117567
|
+
getFirstOrNullObject(): Word.SensitivityLabelDetails;
|
|
117568
|
+
/**
|
|
117569
|
+
* Gets a `SensitivityLabelDetails` object by its index in the collection.
|
|
117570
|
+
*
|
|
117571
|
+
* @remarks
|
|
117572
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117573
|
+
* @beta
|
|
117574
|
+
*
|
|
117575
|
+
* @param index A number that identifies the index location of a `SensitivityLabelDetails` object.
|
|
117576
|
+
*/
|
|
117577
|
+
getItem(index: number): Word.SensitivityLabelDetails;
|
|
117578
|
+
/**
|
|
117579
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117580
|
+
*
|
|
117581
|
+
* @param options Provides options for which properties of the object to load.
|
|
117582
|
+
*/
|
|
117583
|
+
load(options?: Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SensitivityLabelDetailsCollection;
|
|
117584
|
+
/**
|
|
117585
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117586
|
+
*
|
|
117587
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
117588
|
+
*/
|
|
117589
|
+
load(propertyNames?: string | string[]): Word.SensitivityLabelDetailsCollection;
|
|
117590
|
+
/**
|
|
117591
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117592
|
+
*
|
|
117593
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
117594
|
+
*/
|
|
117595
|
+
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SensitivityLabelDetailsCollection;
|
|
117596
|
+
/**
|
|
117597
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
117598
|
+
*/
|
|
117599
|
+
track(): Word.SensitivityLabelDetailsCollection;
|
|
117600
|
+
/**
|
|
117601
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
117602
|
+
*/
|
|
117603
|
+
untrack(): Word.SensitivityLabelDetailsCollection;
|
|
117604
|
+
/**
|
|
117605
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
117606
|
+
* Whereas the original `Word.SensitivityLabelDetailsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelDetailsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
|
|
117607
|
+
*/
|
|
117608
|
+
toJSON(): Word.Interfaces.SensitivityLabelDetailsCollectionData;
|
|
117609
|
+
}
|
|
117610
|
+
/**
|
|
117611
|
+
* Represents the properties of available sensitivity labels in Word.
|
|
117612
|
+
*
|
|
117613
|
+
* @remarks
|
|
117614
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117615
|
+
* @beta
|
|
117616
|
+
*/
|
|
117617
|
+
class SensitivityLabelDetails extends OfficeExtension.ClientObject {
|
|
117618
|
+
/** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
|
|
117619
|
+
context: RequestContext;
|
|
117620
|
+
/**
|
|
117621
|
+
* The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.
|
|
117622
|
+
*
|
|
117623
|
+
* @remarks
|
|
117624
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117625
|
+
* @beta
|
|
117626
|
+
*/
|
|
117627
|
+
readonly children: Word.SensitivityLabelDetailsCollection;
|
|
117628
|
+
/**
|
|
117629
|
+
* The color of the sensitivity label.
|
|
117630
|
+
*
|
|
117631
|
+
* @remarks
|
|
117632
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117633
|
+
* @beta
|
|
117634
|
+
*/
|
|
117635
|
+
readonly color: string;
|
|
117636
|
+
/**
|
|
117637
|
+
* The unique identifier (GUID) of the sensitivity label.
|
|
117638
|
+
*
|
|
117639
|
+
* @remarks
|
|
117640
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117641
|
+
* @beta
|
|
117642
|
+
*/
|
|
117643
|
+
readonly id: string;
|
|
117644
|
+
/**
|
|
117645
|
+
* Gets a value indicating whether the label is enabled.
|
|
117646
|
+
*
|
|
117647
|
+
* @remarks
|
|
117648
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117649
|
+
* @beta
|
|
117650
|
+
*/
|
|
117651
|
+
readonly isEnabled: boolean;
|
|
117652
|
+
/**
|
|
117653
|
+
* The name of the sensitivity label.
|
|
117654
|
+
*
|
|
117655
|
+
* @remarks
|
|
117656
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117657
|
+
* @beta
|
|
117658
|
+
*/
|
|
117659
|
+
readonly name: string;
|
|
117660
|
+
/**
|
|
117661
|
+
* The order of the sensitivity label.
|
|
117662
|
+
*
|
|
117663
|
+
* @remarks
|
|
117664
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117665
|
+
* @beta
|
|
117666
|
+
*/
|
|
117667
|
+
readonly order: number;
|
|
117668
|
+
/**
|
|
117669
|
+
* Gets a value indicating the protection type provided by this label.
|
|
117670
|
+
*
|
|
117671
|
+
* @remarks
|
|
117672
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117673
|
+
* @beta
|
|
117674
|
+
*/
|
|
117675
|
+
readonly protectionType: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
117676
|
+
/**
|
|
117677
|
+
* The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
117678
|
+
*
|
|
117679
|
+
* @remarks
|
|
117680
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117681
|
+
* @beta
|
|
117682
|
+
*/
|
|
117683
|
+
readonly siteId: string;
|
|
117684
|
+
/**
|
|
117685
|
+
* The description of the sensitivity label.
|
|
117686
|
+
*
|
|
117687
|
+
* @remarks
|
|
117688
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
117689
|
+
* @beta
|
|
117690
|
+
*/
|
|
117691
|
+
readonly tooltip: string;
|
|
117692
|
+
/**
|
|
117693
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117694
|
+
*
|
|
117695
|
+
* @param options Provides options for which properties of the object to load.
|
|
117696
|
+
*/
|
|
117697
|
+
load(options?: Word.Interfaces.SensitivityLabelDetailsLoadOptions): Word.SensitivityLabelDetails;
|
|
117698
|
+
/**
|
|
117699
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117700
|
+
*
|
|
117701
|
+
* @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
|
|
117702
|
+
*/
|
|
117703
|
+
load(propertyNames?: string | string[]): Word.SensitivityLabelDetails;
|
|
117704
|
+
/**
|
|
117705
|
+
* Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
|
|
117706
|
+
*
|
|
117707
|
+
* @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
|
|
117708
|
+
*/
|
|
117709
|
+
load(propertyNamesAndPaths?: {
|
|
117710
|
+
select?: string;
|
|
117711
|
+
expand?: string;
|
|
117712
|
+
}): Word.SensitivityLabelDetails;
|
|
117713
|
+
/**
|
|
117714
|
+
* Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
|
|
117715
|
+
*/
|
|
117716
|
+
track(): Word.SensitivityLabelDetails;
|
|
117717
|
+
/**
|
|
117718
|
+
* Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect.
|
|
117719
|
+
*/
|
|
117720
|
+
untrack(): Word.SensitivityLabelDetails;
|
|
117721
|
+
/**
|
|
117722
|
+
* Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.)
|
|
117723
|
+
* Whereas the original `Word.SensitivityLabelDetails` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelDetailsData`) that contains shallow copies of any loaded child properties from the original object.
|
|
117724
|
+
*/
|
|
117725
|
+
toJSON(): Word.Interfaces.SensitivityLabelDetailsData;
|
|
117726
|
+
}
|
|
116708
117727
|
/**
|
|
116709
117728
|
* Represents a setting of the add-in.
|
|
116710
117729
|
*
|
|
@@ -148862,6 +149881,159 @@ declare namespace Word {
|
|
|
148862
149881
|
*/
|
|
148863
149882
|
owners = "Owners",
|
|
148864
149883
|
}
|
|
149884
|
+
/**
|
|
149885
|
+
* Represents the result of updating the sensitivity label on the document.
|
|
149886
|
+
*
|
|
149887
|
+
* @remarks
|
|
149888
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149889
|
+
* @beta
|
|
149890
|
+
*/
|
|
149891
|
+
enum SensitivityLabelUpdateResult {
|
|
149892
|
+
/**
|
|
149893
|
+
* The sensitivity label was successfully updated.
|
|
149894
|
+
* @remarks
|
|
149895
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149896
|
+
* @beta
|
|
149897
|
+
*/
|
|
149898
|
+
success = "Success",
|
|
149899
|
+
/**
|
|
149900
|
+
* The update failed due to an unspecified error.
|
|
149901
|
+
* @remarks
|
|
149902
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149903
|
+
* @beta
|
|
149904
|
+
*/
|
|
149905
|
+
unspecifiedFailure = "UnspecifiedFailure",
|
|
149906
|
+
/**
|
|
149907
|
+
* The specified sensitivity label could not be found.
|
|
149908
|
+
* @remarks
|
|
149909
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149910
|
+
* @beta
|
|
149911
|
+
*/
|
|
149912
|
+
labelNotFound = "LabelNotFound",
|
|
149913
|
+
/**
|
|
149914
|
+
* The document is read-only and cannot be modified.
|
|
149915
|
+
* @remarks
|
|
149916
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149917
|
+
* @beta
|
|
149918
|
+
*/
|
|
149919
|
+
documentReadOnly = "DocumentReadOnly",
|
|
149920
|
+
/**
|
|
149921
|
+
* The user does not have sufficient permissions to update the label.
|
|
149922
|
+
* @remarks
|
|
149923
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149924
|
+
* @beta
|
|
149925
|
+
*/
|
|
149926
|
+
insufficientPermission = "InsufficientPermission",
|
|
149927
|
+
/**
|
|
149928
|
+
* The label update failed due to unsupported Double Key Encryption (DKE).
|
|
149929
|
+
* @remarks
|
|
149930
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149931
|
+
* @beta
|
|
149932
|
+
*/
|
|
149933
|
+
unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption",
|
|
149934
|
+
/**
|
|
149935
|
+
* The label update failed because native labeling is not enabled for the user or installed SKU.
|
|
149936
|
+
* @remarks
|
|
149937
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149938
|
+
* @beta
|
|
149939
|
+
*/
|
|
149940
|
+
labelingDisabled = "LabelingDisabled",
|
|
149941
|
+
/**
|
|
149942
|
+
* The label update failed because the user's identity is not valid for applying a label.
|
|
149943
|
+
* @remarks
|
|
149944
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149945
|
+
* @beta
|
|
149946
|
+
*/
|
|
149947
|
+
userNotFound = "UserNotFound",
|
|
149948
|
+
/**
|
|
149949
|
+
* The label update failed due to unsupported Universal Data Protection (UDP).
|
|
149950
|
+
* @remarks
|
|
149951
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149952
|
+
* @beta
|
|
149953
|
+
*/
|
|
149954
|
+
unsupportedUdp = "UnsupportedUdp",
|
|
149955
|
+
/**
|
|
149956
|
+
* The label update failed because the specified label is a parent label, which cannot be applied.
|
|
149957
|
+
* @remarks
|
|
149958
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149959
|
+
* @beta
|
|
149960
|
+
*/
|
|
149961
|
+
parentLabelNotSupported = "ParentLabelNotSupported",
|
|
149962
|
+
/**
|
|
149963
|
+
* The label update failed because the document doesn't belong to the same tenant as the user.
|
|
149964
|
+
* @remarks
|
|
149965
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149966
|
+
* @beta
|
|
149967
|
+
*/
|
|
149968
|
+
crossTenant = "CrossTenant",
|
|
149969
|
+
}
|
|
149970
|
+
/**
|
|
149971
|
+
* Represents the labeling capability status of the sensitivity label catalog.
|
|
149972
|
+
*
|
|
149973
|
+
* @remarks
|
|
149974
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149975
|
+
* @beta
|
|
149976
|
+
*/
|
|
149977
|
+
enum LabelingCapability {
|
|
149978
|
+
/**
|
|
149979
|
+
* No valid license is available for sensitivity labeling.
|
|
149980
|
+
* @remarks
|
|
149981
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149982
|
+
* @beta
|
|
149983
|
+
*/
|
|
149984
|
+
noLicense = "NoLicense",
|
|
149985
|
+
/**
|
|
149986
|
+
* Sensitivity labeling is disabled for the user or tenant.
|
|
149987
|
+
* @remarks
|
|
149988
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149989
|
+
* @beta
|
|
149990
|
+
*/
|
|
149991
|
+
labelingDisabled = "LabelingDisabled",
|
|
149992
|
+
/**
|
|
149993
|
+
* No labeling policy was found for the user.
|
|
149994
|
+
* @remarks
|
|
149995
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
149996
|
+
* @beta
|
|
149997
|
+
*/
|
|
149998
|
+
labelingPolicyNotFound = "LabelingPolicyNotFound",
|
|
149999
|
+
/**
|
|
150000
|
+
* Sensitivity labeling is fully enabled.
|
|
150001
|
+
* @remarks
|
|
150002
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150003
|
+
* @beta
|
|
150004
|
+
*/
|
|
150005
|
+
labelingEnabled = "LabelingEnabled",
|
|
150006
|
+
}
|
|
150007
|
+
/**
|
|
150008
|
+
* Specifies the type of protection applied by a sensitivity label.
|
|
150009
|
+
*
|
|
150010
|
+
* @remarks
|
|
150011
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150012
|
+
* @beta
|
|
150013
|
+
*/
|
|
150014
|
+
enum SensitivityLabelProtectionType {
|
|
150015
|
+
/**
|
|
150016
|
+
* The label applies no protection.
|
|
150017
|
+
* @remarks
|
|
150018
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150019
|
+
* @beta
|
|
150020
|
+
*/
|
|
150021
|
+
noProtection = "NoProtection",
|
|
150022
|
+
/**
|
|
150023
|
+
* The label applies admin-defined protection.
|
|
150024
|
+
* @remarks
|
|
150025
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150026
|
+
* @beta
|
|
150027
|
+
*/
|
|
150028
|
+
adminDefined = "AdminDefined",
|
|
150029
|
+
/**
|
|
150030
|
+
* The label applies user-defined protection.
|
|
150031
|
+
* @remarks
|
|
150032
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
150033
|
+
* @beta
|
|
150034
|
+
*/
|
|
150035
|
+
userDefined = "UserDefined",
|
|
150036
|
+
}
|
|
148865
150037
|
enum ErrorCodes {
|
|
148866
150038
|
accessDenied = "AccessDenied",
|
|
148867
150039
|
generalException = "GeneralException",
|
|
@@ -151600,6 +152772,10 @@ declare namespace Word {
|
|
|
151600
152772
|
interface SectionCollectionUpdateData {
|
|
151601
152773
|
items?: Word.Interfaces.SectionData[];
|
|
151602
152774
|
}
|
|
152775
|
+
/** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */
|
|
152776
|
+
interface SensitivityLabelDetailsCollectionUpdateData {
|
|
152777
|
+
items?: Word.Interfaces.SensitivityLabelDetailsData[];
|
|
152778
|
+
}
|
|
151603
152779
|
/** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */
|
|
151604
152780
|
interface SettingUpdateData {
|
|
151605
152781
|
/**
|
|
@@ -159065,6 +160241,96 @@ declare namespace Word {
|
|
|
159065
160241
|
interface SectionCollectionData {
|
|
159066
160242
|
items?: Word.Interfaces.SectionData[];
|
|
159067
160243
|
}
|
|
160244
|
+
/** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */
|
|
160245
|
+
interface SensitivityLabelsCatalogData {
|
|
160246
|
+
/**
|
|
160247
|
+
* Gets the labeling capability status of the sensitivity label catalog in Word.
|
|
160248
|
+
*
|
|
160249
|
+
* @remarks
|
|
160250
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160251
|
+
* @beta
|
|
160252
|
+
*/
|
|
160253
|
+
getLabelingCapability?: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
|
|
160254
|
+
}
|
|
160255
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */
|
|
160256
|
+
interface SensitivityLabelDetailsCollectionData {
|
|
160257
|
+
items?: Word.Interfaces.SensitivityLabelDetailsData[];
|
|
160258
|
+
}
|
|
160259
|
+
/** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */
|
|
160260
|
+
interface SensitivityLabelDetailsData {
|
|
160261
|
+
/**
|
|
160262
|
+
* The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.
|
|
160263
|
+
*
|
|
160264
|
+
* @remarks
|
|
160265
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160266
|
+
* @beta
|
|
160267
|
+
*/
|
|
160268
|
+
children?: Word.Interfaces.SensitivityLabelDetailsData[];
|
|
160269
|
+
/**
|
|
160270
|
+
* The color of the sensitivity label.
|
|
160271
|
+
*
|
|
160272
|
+
* @remarks
|
|
160273
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160274
|
+
* @beta
|
|
160275
|
+
*/
|
|
160276
|
+
color?: string;
|
|
160277
|
+
/**
|
|
160278
|
+
* The unique identifier (GUID) of the sensitivity label.
|
|
160279
|
+
*
|
|
160280
|
+
* @remarks
|
|
160281
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160282
|
+
* @beta
|
|
160283
|
+
*/
|
|
160284
|
+
id?: string;
|
|
160285
|
+
/**
|
|
160286
|
+
* Gets a value indicating whether the label is enabled.
|
|
160287
|
+
*
|
|
160288
|
+
* @remarks
|
|
160289
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160290
|
+
* @beta
|
|
160291
|
+
*/
|
|
160292
|
+
isEnabled?: boolean;
|
|
160293
|
+
/**
|
|
160294
|
+
* The name of the sensitivity label.
|
|
160295
|
+
*
|
|
160296
|
+
* @remarks
|
|
160297
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160298
|
+
* @beta
|
|
160299
|
+
*/
|
|
160300
|
+
name?: string;
|
|
160301
|
+
/**
|
|
160302
|
+
* The order of the sensitivity label.
|
|
160303
|
+
*
|
|
160304
|
+
* @remarks
|
|
160305
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160306
|
+
* @beta
|
|
160307
|
+
*/
|
|
160308
|
+
order?: number;
|
|
160309
|
+
/**
|
|
160310
|
+
* Gets a value indicating the protection type provided by this label.
|
|
160311
|
+
*
|
|
160312
|
+
* @remarks
|
|
160313
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160314
|
+
* @beta
|
|
160315
|
+
*/
|
|
160316
|
+
protectionType?: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
|
|
160317
|
+
/**
|
|
160318
|
+
* The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
160319
|
+
*
|
|
160320
|
+
* @remarks
|
|
160321
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160322
|
+
* @beta
|
|
160323
|
+
*/
|
|
160324
|
+
siteId?: string;
|
|
160325
|
+
/**
|
|
160326
|
+
* The description of the sensitivity label.
|
|
160327
|
+
*
|
|
160328
|
+
* @remarks
|
|
160329
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
160330
|
+
* @beta
|
|
160331
|
+
*/
|
|
160332
|
+
tooltip?: string;
|
|
160333
|
+
}
|
|
159068
160334
|
/** An interface describing the data returned by calling `setting.toJSON()`. */
|
|
159069
160335
|
interface SettingData {
|
|
159070
160336
|
/**
|
|
@@ -170345,6 +171611,181 @@ declare namespace Word {
|
|
|
170345
171611
|
*/
|
|
170346
171612
|
protectedForForms?: boolean;
|
|
170347
171613
|
}
|
|
171614
|
+
/**
|
|
171615
|
+
* Provides methods to check the status of the catalog of sensitivity labels in Word and retrieve all available sensitivity labels if the catalog is enabled.
|
|
171616
|
+
*
|
|
171617
|
+
* @remarks
|
|
171618
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171619
|
+
* @beta
|
|
171620
|
+
*/
|
|
171621
|
+
interface SensitivityLabelsCatalogLoadOptions {
|
|
171622
|
+
/**
|
|
171623
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
171624
|
+
*/
|
|
171625
|
+
$all?: boolean;
|
|
171626
|
+
/**
|
|
171627
|
+
* Gets the labeling capability status of the sensitivity label catalog in Word.
|
|
171628
|
+
*
|
|
171629
|
+
* @remarks
|
|
171630
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171631
|
+
* @beta
|
|
171632
|
+
*/
|
|
171633
|
+
getLabelingCapability?: boolean;
|
|
171634
|
+
}
|
|
171635
|
+
/**
|
|
171636
|
+
* Represents the collection of {@link Word.SensitivityLabelDetails} objects.
|
|
171637
|
+
*
|
|
171638
|
+
* @remarks
|
|
171639
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171640
|
+
* @beta
|
|
171641
|
+
*/
|
|
171642
|
+
interface SensitivityLabelDetailsCollectionLoadOptions {
|
|
171643
|
+
/**
|
|
171644
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
171645
|
+
*/
|
|
171646
|
+
$all?: boolean;
|
|
171647
|
+
/**
|
|
171648
|
+
* For EACH ITEM in the collection: The color of the sensitivity label.
|
|
171649
|
+
*
|
|
171650
|
+
* @remarks
|
|
171651
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171652
|
+
* @beta
|
|
171653
|
+
*/
|
|
171654
|
+
color?: boolean;
|
|
171655
|
+
/**
|
|
171656
|
+
* For EACH ITEM in the collection: The unique identifier (GUID) of the sensitivity label.
|
|
171657
|
+
*
|
|
171658
|
+
* @remarks
|
|
171659
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171660
|
+
* @beta
|
|
171661
|
+
*/
|
|
171662
|
+
id?: boolean;
|
|
171663
|
+
/**
|
|
171664
|
+
* For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.
|
|
171665
|
+
*
|
|
171666
|
+
* @remarks
|
|
171667
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171668
|
+
* @beta
|
|
171669
|
+
*/
|
|
171670
|
+
isEnabled?: boolean;
|
|
171671
|
+
/**
|
|
171672
|
+
* For EACH ITEM in the collection: The name of the sensitivity label.
|
|
171673
|
+
*
|
|
171674
|
+
* @remarks
|
|
171675
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171676
|
+
* @beta
|
|
171677
|
+
*/
|
|
171678
|
+
name?: boolean;
|
|
171679
|
+
/**
|
|
171680
|
+
* For EACH ITEM in the collection: The order of the sensitivity label.
|
|
171681
|
+
*
|
|
171682
|
+
* @remarks
|
|
171683
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171684
|
+
* @beta
|
|
171685
|
+
*/
|
|
171686
|
+
order?: boolean;
|
|
171687
|
+
/**
|
|
171688
|
+
* For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.
|
|
171689
|
+
*
|
|
171690
|
+
* @remarks
|
|
171691
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171692
|
+
* @beta
|
|
171693
|
+
*/
|
|
171694
|
+
protectionType?: boolean;
|
|
171695
|
+
/**
|
|
171696
|
+
* For EACH ITEM in the collection: The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
171697
|
+
*
|
|
171698
|
+
* @remarks
|
|
171699
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171700
|
+
* @beta
|
|
171701
|
+
*/
|
|
171702
|
+
siteId?: boolean;
|
|
171703
|
+
/**
|
|
171704
|
+
* For EACH ITEM in the collection: The description of the sensitivity label.
|
|
171705
|
+
*
|
|
171706
|
+
* @remarks
|
|
171707
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171708
|
+
* @beta
|
|
171709
|
+
*/
|
|
171710
|
+
tooltip?: boolean;
|
|
171711
|
+
}
|
|
171712
|
+
/**
|
|
171713
|
+
* Represents the properties of available sensitivity labels in Word.
|
|
171714
|
+
*
|
|
171715
|
+
* @remarks
|
|
171716
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171717
|
+
* @beta
|
|
171718
|
+
*/
|
|
171719
|
+
interface SensitivityLabelDetailsLoadOptions {
|
|
171720
|
+
/**
|
|
171721
|
+
Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`).
|
|
171722
|
+
*/
|
|
171723
|
+
$all?: boolean;
|
|
171724
|
+
/**
|
|
171725
|
+
* The color of the sensitivity label.
|
|
171726
|
+
*
|
|
171727
|
+
* @remarks
|
|
171728
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171729
|
+
* @beta
|
|
171730
|
+
*/
|
|
171731
|
+
color?: boolean;
|
|
171732
|
+
/**
|
|
171733
|
+
* The unique identifier (GUID) of the sensitivity label.
|
|
171734
|
+
*
|
|
171735
|
+
* @remarks
|
|
171736
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171737
|
+
* @beta
|
|
171738
|
+
*/
|
|
171739
|
+
id?: boolean;
|
|
171740
|
+
/**
|
|
171741
|
+
* Gets a value indicating whether the label is enabled.
|
|
171742
|
+
*
|
|
171743
|
+
* @remarks
|
|
171744
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171745
|
+
* @beta
|
|
171746
|
+
*/
|
|
171747
|
+
isEnabled?: boolean;
|
|
171748
|
+
/**
|
|
171749
|
+
* The name of the sensitivity label.
|
|
171750
|
+
*
|
|
171751
|
+
* @remarks
|
|
171752
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171753
|
+
* @beta
|
|
171754
|
+
*/
|
|
171755
|
+
name?: boolean;
|
|
171756
|
+
/**
|
|
171757
|
+
* The order of the sensitivity label.
|
|
171758
|
+
*
|
|
171759
|
+
* @remarks
|
|
171760
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171761
|
+
* @beta
|
|
171762
|
+
*/
|
|
171763
|
+
order?: boolean;
|
|
171764
|
+
/**
|
|
171765
|
+
* Gets a value indicating the protection type provided by this label.
|
|
171766
|
+
*
|
|
171767
|
+
* @remarks
|
|
171768
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171769
|
+
* @beta
|
|
171770
|
+
*/
|
|
171771
|
+
protectionType?: boolean;
|
|
171772
|
+
/**
|
|
171773
|
+
* The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
|
|
171774
|
+
*
|
|
171775
|
+
* @remarks
|
|
171776
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171777
|
+
* @beta
|
|
171778
|
+
*/
|
|
171779
|
+
siteId?: boolean;
|
|
171780
|
+
/**
|
|
171781
|
+
* The description of the sensitivity label.
|
|
171782
|
+
*
|
|
171783
|
+
* @remarks
|
|
171784
|
+
* [Api set: WordApi BETA (PREVIEW ONLY)]
|
|
171785
|
+
* @beta
|
|
171786
|
+
*/
|
|
171787
|
+
tooltip?: boolean;
|
|
171788
|
+
}
|
|
170348
171789
|
/**
|
|
170349
171790
|
* Represents a setting of the add-in.
|
|
170350
171791
|
*
|
|
@@ -177658,6 +179099,7 @@ declare namespace Word {
|
|
|
177658
179099
|
constructor(url?: string);
|
|
177659
179100
|
readonly document: Document;
|
|
177660
179101
|
readonly application: Application;
|
|
179102
|
+
readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog;
|
|
177661
179103
|
}
|
|
177662
179104
|
/**
|
|
177663
179105
|
* Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects.
|