@types/office-js-preview 1.0.710 → 1.0.712

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.
@@ -26347,7 +26347,6 @@ declare namespace OfficeCore {
26347
26347
  /////////////////////// Begin Excel APIs ///////////////////////
26348
26348
  ////////////////////////////////////////////////////////////////
26349
26349
 
26350
-
26351
26350
  declare namespace Excel {
26352
26351
  /**
26353
26352
  * Represents an unknown cell control.
@@ -35498,6 +35497,10 @@ declare namespace Excel {
35498
35497
  * [Api set: ExcelApi 1.5]
35499
35498
  */
35500
35499
  readonly runtime: Runtime;
35500
+ /**
35501
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
35502
+ */
35503
+ readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog;
35501
35504
  }
35502
35505
  interface RunOptions extends OfficeExtension.RunOptions<Session> {
35503
35506
  /**
@@ -35548,8 +35551,416 @@ declare namespace Excel {
35548
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.
35549
35552
  */
35550
35553
  function run<T>(context: OfficeExtension.ClientRequestContext, batch: (context: Excel.RequestContext) => Promise<T>): Promise<T>;
35551
- function postprocessBindingDescriptor(response: any): any;
35552
- function getDataCommonPostprocess(response: any, callArgs: any): any;
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
+ }
35553
35964
  /**
35554
35965
  * Provides information about the ranges that raised the `onCalculationBusy` event, which triggers when the calculation is in progress in a worksheet.
35555
35966
  *
@@ -40829,6 +41240,14 @@ declare namespace Excel {
40829
41240
  * [Api set: ExcelApi 1.1]
40830
41241
  */
40831
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;
40832
41251
  /**
40833
41252
  * Specifies if the workbook is in AutoSave mode.
40834
41253
  *
@@ -62217,6 +62636,49 @@ declare namespace Excel {
62217
62636
  */
62218
62637
  toJSON(): Excel.Interfaces.SlicerItemCollectionData;
62219
62638
  }
62639
+ /**
62640
+ * Provides information about the `LinkedEntityCellValue` that was requested given a specified `LinkedEntityId`.
62641
+ *
62642
+ * @remarks
62643
+ * [Api set: ExcelApi 1.21]
62644
+ */
62645
+ interface LinkedEntityCellValueLoadedEventArgs {
62646
+ /**
62647
+ * Any error encountered during the request to load the `LinkedEntityCellValue`.
62648
+ *
62649
+ * @remarks
62650
+ * [Api set: ExcelApi 1.21]
62651
+ */
62652
+ error?: string;
62653
+ /**
62654
+ * Gets the `LinkedEntityId` of the requested `LinkedEntityCellValue`.
62655
+ *
62656
+ * @remarks
62657
+ * [Api set: ExcelApi 1.21]
62658
+ */
62659
+ id: LinkedEntityId;
62660
+ /**
62661
+ * Gets the `LinkedEntityCellValue` of the requested `LinkedEntityId`. If the load operation failed, this property is `null`.
62662
+ *
62663
+ * @remarks
62664
+ * [Api set: ExcelApi 1.21]
62665
+ */
62666
+ linkedEntityCellValue?: LinkedEntityCellValue;
62667
+ /**
62668
+ * Gets the source of the event. See `Excel.EventSource` for details.
62669
+ *
62670
+ * @remarks
62671
+ * [Api set: ExcelApi 1.21]
62672
+ */
62673
+ source: Excel.EventSource | "Local" | "Remote";
62674
+ /**
62675
+ * Gets the type of the event. See `Excel.EventType` for details.
62676
+ *
62677
+ * @remarks
62678
+ * [Api set: ExcelApi 1.21]
62679
+ */
62680
+ type: "LinkedEntityDataDomainLinkedEntityCellValueLoaded";
62681
+ }
62220
62682
  /**
62221
62683
  * Represents a specific category or field of information that shares some common characteristics or attributes.
62222
62684
  A data domain is linked to a data provider, that acts as the data source for `LinkedEntityCellValue` objects in the workbook.
@@ -62517,6 +62979,16 @@ declare namespace Excel {
62517
62979
  * @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.
62518
62980
  */
62519
62981
  getItemOrNullObject(id: string): Excel.LinkedEntityDataDomain;
62982
+ /**
62983
+ * Submits a request to load the `LinkedEntityCellValue` object with the specified `LinkedEntityId`.
62984
+ If found, the `LinkedEntityCellValue` object will be returned through the `LinkedEntityCellValueLoaded` event.
62985
+ *
62986
+ * @remarks
62987
+ * [Api set: ExcelApi 1.21]
62988
+ *
62989
+ * @param id A specific `LinkedEntityId`
62990
+ */
62991
+ loadLinkedEntityCellValue(id: LinkedEntityId): void;
62520
62992
  /**
62521
62993
  * Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.
62522
62994
  The refresh request can fail if the data providers are busy or temporarily inaccessible.
@@ -62545,6 +63017,17 @@ declare namespace Excel {
62545
63017
  * @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.
62546
63018
  */
62547
63019
  load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.LinkedEntityDataDomainCollection;
63020
+ /**
63021
+ * Occurs when the request to load a `LinkedEntityCellValue` is completed.
63022
+ *
63023
+ * @remarks
63024
+ * [Api set: ExcelApi 1.21]
63025
+ *
63026
+ * This event isn't supported in Excel on the web.
63027
+ *
63028
+ * @eventproperty
63029
+ */
63030
+ readonly onLinkedEntityCellValueLoaded: OfficeExtension.EventHandlers<Excel.LinkedEntityCellValueLoadedEventArgs>;
62548
63031
  /**
62549
63032
  * Occurs when a new linked entity data domain is added to the workbook.
62550
63033
  *
@@ -74893,6 +75376,10 @@ declare namespace Excel {
74893
75376
  */
74894
75377
  $skip?: number;
74895
75378
  }
75379
+ /** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */
75380
+ interface SensitivityLabelDetailsCollectionUpdateData {
75381
+ items?: Excel.Interfaces.SensitivityLabelDetailsData[];
75382
+ }
74896
75383
  /** An interface for updating data on the `AllowEditRange` object, for use in `allowEditRange.set({ ... })`. */
74897
75384
  interface AllowEditRangeUpdateData {
74898
75385
  /**
@@ -80546,6 +81033,96 @@ declare namespace Excel {
80546
81033
  interface PaneCollectionUpdateData {
80547
81034
  items?: Excel.Interfaces.PaneData[];
80548
81035
  }
81036
+ /** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */
81037
+ interface SensitivityLabelDetailsData {
81038
+ /**
81039
+ * Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
81040
+ *
81041
+ * @remarks
81042
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81043
+ * @beta
81044
+ */
81045
+ children?: SensitivityLabelDetailsCollection | null;
81046
+ /**
81047
+ * Gets the color of the sensitivity label.
81048
+ *
81049
+ * @remarks
81050
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81051
+ * @beta
81052
+ */
81053
+ color?: string;
81054
+ /**
81055
+ * Gets the unique identifier (GUID) of the sensitivity label.
81056
+ *
81057
+ * @remarks
81058
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81059
+ * @beta
81060
+ */
81061
+ id?: string;
81062
+ /**
81063
+ * Gets a value indicating whether the label is enabled.
81064
+ *
81065
+ * @remarks
81066
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81067
+ * @beta
81068
+ */
81069
+ isEnabled?: boolean;
81070
+ /**
81071
+ * Gets the name of the sensitivity label.
81072
+ *
81073
+ * @remarks
81074
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81075
+ * @beta
81076
+ */
81077
+ name?: string;
81078
+ /**
81079
+ * Gets the priority of the sensitivity label, with 0 as lowest priority.
81080
+ *
81081
+ * @remarks
81082
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81083
+ * @beta
81084
+ */
81085
+ order?: number;
81086
+ /**
81087
+ * Gets a value indicating the protection type provided by this label.
81088
+ *
81089
+ * @remarks
81090
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81091
+ * @beta
81092
+ */
81093
+ protectionType?: Excel.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
81094
+ /**
81095
+ * Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
81096
+ *
81097
+ * @remarks
81098
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81099
+ * @beta
81100
+ */
81101
+ siteId?: string;
81102
+ /**
81103
+ * Gets the description of the sensitivity label.
81104
+ *
81105
+ * @remarks
81106
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81107
+ * @beta
81108
+ */
81109
+ tooltip?: string;
81110
+ }
81111
+ /** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */
81112
+ interface SensitivityLabelDetailsCollectionData {
81113
+ items?: Excel.Interfaces.SensitivityLabelDetailsData[];
81114
+ }
81115
+ /** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */
81116
+ interface SensitivityLabelsCatalogData {
81117
+ /**
81118
+ * Gets whether the catalog of sensitivity labels is enabled in Excel.
81119
+ *
81120
+ * @remarks
81121
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
81122
+ * @beta
81123
+ */
81124
+ getLabelingCapability?: Excel.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
81125
+ }
80549
81126
  /** An interface describing the data returned by calling `allowEditRange.toJSON()`. */
80550
81127
  interface AllowEditRangeData {
80551
81128
  /**
@@ -88338,6 +88915,197 @@ declare namespace Excel {
88338
88915
  */
88339
88916
  value?: T;
88340
88917
  }
88918
+ /**
88919
+ * Represents the properties of available sensitivity labels in Excel.
88920
+ *
88921
+ * @remarks
88922
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88923
+ * @beta
88924
+ */
88925
+ interface SensitivityLabelDetailsLoadOptions {
88926
+ /**
88927
+ 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`).
88928
+ */
88929
+ $all?: boolean;
88930
+ /**
88931
+ * Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
88932
+ *
88933
+ * @remarks
88934
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88935
+ * @beta
88936
+ */
88937
+ children?: boolean;
88938
+ /**
88939
+ * Gets the color of the sensitivity label.
88940
+ *
88941
+ * @remarks
88942
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88943
+ * @beta
88944
+ */
88945
+ color?: boolean;
88946
+ /**
88947
+ * Gets the unique identifier (GUID) of the sensitivity label.
88948
+ *
88949
+ * @remarks
88950
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88951
+ * @beta
88952
+ */
88953
+ id?: boolean;
88954
+ /**
88955
+ * Gets a value indicating whether the label is enabled.
88956
+ *
88957
+ * @remarks
88958
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88959
+ * @beta
88960
+ */
88961
+ isEnabled?: boolean;
88962
+ /**
88963
+ * Gets the name of the sensitivity label.
88964
+ *
88965
+ * @remarks
88966
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88967
+ * @beta
88968
+ */
88969
+ name?: boolean;
88970
+ /**
88971
+ * Gets the priority of the sensitivity label, with 0 as lowest priority.
88972
+ *
88973
+ * @remarks
88974
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88975
+ * @beta
88976
+ */
88977
+ order?: boolean;
88978
+ /**
88979
+ * Gets a value indicating the protection type provided by this label.
88980
+ *
88981
+ * @remarks
88982
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88983
+ * @beta
88984
+ */
88985
+ protectionType?: boolean;
88986
+ /**
88987
+ * Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
88988
+ *
88989
+ * @remarks
88990
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88991
+ * @beta
88992
+ */
88993
+ siteId?: boolean;
88994
+ /**
88995
+ * Gets the description of the sensitivity label.
88996
+ *
88997
+ * @remarks
88998
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
88999
+ * @beta
89000
+ */
89001
+ tooltip?: boolean;
89002
+ }
89003
+ /**
89004
+ * Represents the collection of {@link Excel.SensitivityLabelDetails} objects.
89005
+ *
89006
+ * @remarks
89007
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89008
+ * @beta
89009
+ */
89010
+ interface SensitivityLabelDetailsCollectionLoadOptions {
89011
+ /**
89012
+ 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`).
89013
+ */
89014
+ $all?: boolean;
89015
+ /**
89016
+ * For EACH ITEM in the collection: Gets the sublabels of the sensitivity label. Returns `null` if a label doesn't have any sublabels.
89017
+ *
89018
+ * @remarks
89019
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89020
+ * @beta
89021
+ */
89022
+ children?: boolean;
89023
+ /**
89024
+ * For EACH ITEM in the collection: Gets the color of the sensitivity label.
89025
+ *
89026
+ * @remarks
89027
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89028
+ * @beta
89029
+ */
89030
+ color?: boolean;
89031
+ /**
89032
+ * For EACH ITEM in the collection: Gets the unique identifier (GUID) of the sensitivity label.
89033
+ *
89034
+ * @remarks
89035
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89036
+ * @beta
89037
+ */
89038
+ id?: boolean;
89039
+ /**
89040
+ * For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.
89041
+ *
89042
+ * @remarks
89043
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89044
+ * @beta
89045
+ */
89046
+ isEnabled?: boolean;
89047
+ /**
89048
+ * For EACH ITEM in the collection: Gets the name of the sensitivity label.
89049
+ *
89050
+ * @remarks
89051
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89052
+ * @beta
89053
+ */
89054
+ name?: boolean;
89055
+ /**
89056
+ * For EACH ITEM in the collection: Gets the priority of the sensitivity label, with 0 as lowest priority.
89057
+ *
89058
+ * @remarks
89059
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89060
+ * @beta
89061
+ */
89062
+ order?: boolean;
89063
+ /**
89064
+ * For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.
89065
+ *
89066
+ * @remarks
89067
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89068
+ * @beta
89069
+ */
89070
+ protectionType?: boolean;
89071
+ /**
89072
+ * For EACH ITEM in the collection: Gets the unique identifier (GUID) of the tenant which the sensitivity label is belonged.
89073
+ *
89074
+ * @remarks
89075
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89076
+ * @beta
89077
+ */
89078
+ siteId?: boolean;
89079
+ /**
89080
+ * For EACH ITEM in the collection: Gets the description of the sensitivity label.
89081
+ *
89082
+ * @remarks
89083
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89084
+ * @beta
89085
+ */
89086
+ tooltip?: boolean;
89087
+ }
89088
+ /**
89089
+ * 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.
89090
+ *
89091
+ * @remarks
89092
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89093
+ * @beta
89094
+ */
89095
+ interface SensitivityLabelsCatalogLoadOptions {
89096
+ /**
89097
+ 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`).
89098
+ */
89099
+ $all?: boolean;
89100
+ /**
89101
+ * Gets whether the catalog of sensitivity labels is enabled in Excel.
89102
+ *
89103
+ * @remarks
89104
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
89105
+ * @beta
89106
+ */
89107
+ getLabelingCapability?: boolean;
89108
+ }
88341
89109
  /**
88342
89110
  * Represents an `AllowEditRange` object found in a worksheet. This object works with worksheet protection properties.
88343
89111
  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.
@@ -108033,6 +108801,14 @@ declare namespace Word {
108033
108801
  * [Api set: WordApiDesktop 1.4]
108034
108802
  */
108035
108803
  readonly selection: Word.Selection;
108804
+ /**
108805
+ * Returns the sensitivity label of the document.
108806
+ *
108807
+ * @remarks
108808
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
108809
+ * @beta
108810
+ */
108811
+ readonly sensitivityLabel: Word.SensitivityLabel;
108036
108812
  /**
108037
108813
  * Gets the `RangeScopedCollection` object that represents all the sentences in the document.
108038
108814
  *
@@ -116630,6 +117406,318 @@ declare namespace Word {
116630
117406
  */
116631
117407
  toJSON(): Word.Interfaces.SectionCollectionData;
116632
117408
  }
117409
+ /**
117410
+ * Represents the sensitivity label on the document.
117411
+ *
117412
+ * @remarks
117413
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117414
+ * @beta
117415
+ */
117416
+ class SensitivityLabel extends OfficeExtension.ClientObject {
117417
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
117418
+ context: RequestContext;
117419
+ /**
117420
+ * Gets the current label information that exists on the document for the user.
117421
+ *
117422
+ * @remarks
117423
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117424
+ * @beta
117425
+ */
117426
+ getCurrentOrNullObject(): Word.SensitivityLabelDetails;
117427
+ /**
117428
+ * Try to update to the provided sensitivity label on the document for the user.
117429
+ *
117430
+ * @remarks
117431
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117432
+ * @beta
117433
+ *
117434
+ * @param LabelId The label information that needs to be set on the document.
117435
+ * @param Justification Optional. The justification of changing the label.
117436
+ */
117437
+ tryToUpdate(LabelId: string, Justification?: string): OfficeExtension.ClientResult<Word.SensitivityLabelUpdateResult>;
117438
+ /**
117439
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
117440
+ *
117441
+ * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
117442
+ */
117443
+ load(propertyNames?: string | string[]): Word.SensitivityLabel;
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 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.
117448
+ */
117449
+ load(propertyNamesAndPaths?: {
117450
+ select?: string;
117451
+ expand?: string;
117452
+ }): Word.SensitivityLabel;
117453
+ /**
117454
+ * 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.
117455
+ */
117456
+ track(): Word.SensitivityLabel;
117457
+ /**
117458
+ * 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.
117459
+ */
117460
+ untrack(): Word.SensitivityLabel;
117461
+ /**
117462
+ * 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.)
117463
+ * 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.
117464
+ */
117465
+ toJSON(): {
117466
+ [key: string]: string;
117467
+ };
117468
+ }
117469
+ /**
117470
+ * 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.
117471
+ *
117472
+ * @remarks
117473
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117474
+ * @beta
117475
+ */
117476
+ class SensitivityLabelsCatalog extends OfficeExtension.ClientObject {
117477
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
117478
+ context: RequestContext;
117479
+ /**
117480
+ * Gets the labeling capability status of the sensitivity label catalog in Word.
117481
+ *
117482
+ * @remarks
117483
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117484
+ * @beta
117485
+ */
117486
+ readonly getLabelingCapability: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
117487
+ /**
117488
+ * Gets all the sensitivity labels that are enabled in Word.
117489
+ *
117490
+ * @remarks
117491
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117492
+ * @beta
117493
+ */
117494
+ getLabels(): Word.SensitivityLabelDetailsCollection;
117495
+ /**
117496
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
117497
+ *
117498
+ * @param options Provides options for which properties of the object to load.
117499
+ */
117500
+ load(options?: Word.Interfaces.SensitivityLabelsCatalogLoadOptions): Word.SensitivityLabelsCatalog;
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 propertyNames A comma-delimited string or an array of strings that specify the properties to load.
117505
+ */
117506
+ load(propertyNames?: string | string[]): 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 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.
117511
+ */
117512
+ load(propertyNamesAndPaths?: {
117513
+ select?: string;
117514
+ expand?: string;
117515
+ }): Word.SensitivityLabelsCatalog;
117516
+ /**
117517
+ * Create a new instance of the `Word.SensitivityLabelsCatalog` object.
117518
+ */
117519
+ static newObject(context: OfficeExtension.ClientRequestContext): Word.SensitivityLabelsCatalog;
117520
+ /**
117521
+ * 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.
117522
+ */
117523
+ track(): Word.SensitivityLabelsCatalog;
117524
+ /**
117525
+ * 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.
117526
+ */
117527
+ untrack(): Word.SensitivityLabelsCatalog;
117528
+ /**
117529
+ * 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.)
117530
+ * 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.
117531
+ */
117532
+ toJSON(): Word.Interfaces.SensitivityLabelsCatalogData;
117533
+ }
117534
+ /**
117535
+ * Represents the collection of {@link Word.SensitivityLabelDetails} objects.
117536
+ *
117537
+ * @remarks
117538
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117539
+ * @beta
117540
+ */
117541
+ class SensitivityLabelDetailsCollection extends OfficeExtension.ClientObject {
117542
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
117543
+ context: RequestContext;
117544
+ /** Gets the loaded child items in this collection. */
117545
+ readonly items: Word.SensitivityLabelDetails[];
117546
+ /**
117547
+ * Gets the first `SensitivityLabelDetails` object in this collection. Throws an `ItemNotFound` error if this collection is empty.
117548
+ *
117549
+ * @remarks
117550
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117551
+ * @beta
117552
+ */
117553
+ getFirst(): Word.SensitivityLabelDetails;
117554
+ /**
117555
+ * 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}.
117556
+ *
117557
+ * @remarks
117558
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117559
+ * @beta
117560
+ */
117561
+ getFirstOrNullObject(): Word.SensitivityLabelDetails;
117562
+ /**
117563
+ * Gets a `SensitivityLabelDetails` object by its index in the collection.
117564
+ *
117565
+ * @remarks
117566
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117567
+ * @beta
117568
+ *
117569
+ * @param index A number that identifies the index location of a `SensitivityLabelDetails` object.
117570
+ */
117571
+ getItem(index: number): Word.SensitivityLabelDetails;
117572
+ /**
117573
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
117574
+ *
117575
+ * @param options Provides options for which properties of the object to load.
117576
+ */
117577
+ load(options?: Word.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SensitivityLabelDetailsCollection;
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 propertyNames A comma-delimited string or an array of strings that specify the properties to load.
117582
+ */
117583
+ load(propertyNames?: string | string[]): 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 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.
117588
+ */
117589
+ load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SensitivityLabelDetailsCollection;
117590
+ /**
117591
+ * 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.
117592
+ */
117593
+ track(): Word.SensitivityLabelDetailsCollection;
117594
+ /**
117595
+ * 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.
117596
+ */
117597
+ untrack(): Word.SensitivityLabelDetailsCollection;
117598
+ /**
117599
+ * 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.)
117600
+ * 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.
117601
+ */
117602
+ toJSON(): Word.Interfaces.SensitivityLabelDetailsCollectionData;
117603
+ }
117604
+ /**
117605
+ * Represents the properties of available sensitivity labels in Word.
117606
+ *
117607
+ * @remarks
117608
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117609
+ * @beta
117610
+ */
117611
+ class SensitivityLabelDetails extends OfficeExtension.ClientObject {
117612
+ /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
117613
+ context: RequestContext;
117614
+ /**
117615
+ * The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.
117616
+ *
117617
+ * @remarks
117618
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117619
+ * @beta
117620
+ */
117621
+ readonly children: Word.SensitivityLabelDetailsCollection;
117622
+ /**
117623
+ * The color of the sensitivity label.
117624
+ *
117625
+ * @remarks
117626
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117627
+ * @beta
117628
+ */
117629
+ readonly color: string;
117630
+ /**
117631
+ * The unique identifier (GUID) of the sensitivity label.
117632
+ *
117633
+ * @remarks
117634
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117635
+ * @beta
117636
+ */
117637
+ readonly id: string;
117638
+ /**
117639
+ * Gets a value indicating whether the label is enabled.
117640
+ *
117641
+ * @remarks
117642
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117643
+ * @beta
117644
+ */
117645
+ readonly isEnabled: boolean;
117646
+ /**
117647
+ * The name of the sensitivity label.
117648
+ *
117649
+ * @remarks
117650
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117651
+ * @beta
117652
+ */
117653
+ readonly name: string;
117654
+ /**
117655
+ * The order of the sensitivity label.
117656
+ *
117657
+ * @remarks
117658
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117659
+ * @beta
117660
+ */
117661
+ readonly order: number;
117662
+ /**
117663
+ * Gets a value indicating the protection type provided by this label.
117664
+ *
117665
+ * @remarks
117666
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117667
+ * @beta
117668
+ */
117669
+ readonly protectionType: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
117670
+ /**
117671
+ * The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
117672
+ *
117673
+ * @remarks
117674
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117675
+ * @beta
117676
+ */
117677
+ readonly siteId: string;
117678
+ /**
117679
+ * The description of the sensitivity label.
117680
+ *
117681
+ * @remarks
117682
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
117683
+ * @beta
117684
+ */
117685
+ readonly tooltip: string;
117686
+ /**
117687
+ * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
117688
+ *
117689
+ * @param options Provides options for which properties of the object to load.
117690
+ */
117691
+ load(options?: Word.Interfaces.SensitivityLabelDetailsLoadOptions): Word.SensitivityLabelDetails;
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 propertyNames A comma-delimited string or an array of strings that specify the properties to load.
117696
+ */
117697
+ load(propertyNames?: string | string[]): 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 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.
117702
+ */
117703
+ load(propertyNamesAndPaths?: {
117704
+ select?: string;
117705
+ expand?: string;
117706
+ }): Word.SensitivityLabelDetails;
117707
+ /**
117708
+ * 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.
117709
+ */
117710
+ track(): Word.SensitivityLabelDetails;
117711
+ /**
117712
+ * 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.
117713
+ */
117714
+ untrack(): Word.SensitivityLabelDetails;
117715
+ /**
117716
+ * 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.)
117717
+ * 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.
117718
+ */
117719
+ toJSON(): Word.Interfaces.SensitivityLabelDetailsData;
117720
+ }
116633
117721
  /**
116634
117722
  * Represents a setting of the add-in.
116635
117723
  *
@@ -148787,6 +149875,159 @@ declare namespace Word {
148787
149875
  */
148788
149876
  owners = "Owners",
148789
149877
  }
149878
+ /**
149879
+ * Represents the result of updating the sensitivity label on the document.
149880
+ *
149881
+ * @remarks
149882
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149883
+ * @beta
149884
+ */
149885
+ enum SensitivityLabelUpdateResult {
149886
+ /**
149887
+ * The sensitivity label was successfully updated.
149888
+ * @remarks
149889
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149890
+ * @beta
149891
+ */
149892
+ success = "Success",
149893
+ /**
149894
+ * The update failed due to an unspecified error.
149895
+ * @remarks
149896
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149897
+ * @beta
149898
+ */
149899
+ unspecifiedFailure = "UnspecifiedFailure",
149900
+ /**
149901
+ * The specified sensitivity label could not be found.
149902
+ * @remarks
149903
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149904
+ * @beta
149905
+ */
149906
+ labelNotFound = "LabelNotFound",
149907
+ /**
149908
+ * The document is read-only and cannot be modified.
149909
+ * @remarks
149910
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149911
+ * @beta
149912
+ */
149913
+ documentReadOnly = "DocumentReadOnly",
149914
+ /**
149915
+ * The user does not have sufficient permissions to update the label.
149916
+ * @remarks
149917
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149918
+ * @beta
149919
+ */
149920
+ insufficientPermission = "InsufficientPermission",
149921
+ /**
149922
+ * The label update failed due to unsupported Double Key Encryption (DKE).
149923
+ * @remarks
149924
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149925
+ * @beta
149926
+ */
149927
+ unsupportedDoubleKeyEncryption = "UnsupportedDoubleKeyEncryption",
149928
+ /**
149929
+ * The label update failed because native labeling is not enabled for the user or installed SKU.
149930
+ * @remarks
149931
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149932
+ * @beta
149933
+ */
149934
+ labelingDisabled = "LabelingDisabled",
149935
+ /**
149936
+ * The label update failed because the user's identity is not valid for applying a label.
149937
+ * @remarks
149938
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149939
+ * @beta
149940
+ */
149941
+ userNotFound = "UserNotFound",
149942
+ /**
149943
+ * The label update failed due to unsupported Universal Data Protection (UDP).
149944
+ * @remarks
149945
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149946
+ * @beta
149947
+ */
149948
+ unsupportedUdp = "UnsupportedUdp",
149949
+ /**
149950
+ * The label update failed because the specified label is a parent label, which cannot be applied.
149951
+ * @remarks
149952
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149953
+ * @beta
149954
+ */
149955
+ parentLabelNotSupported = "ParentLabelNotSupported",
149956
+ /**
149957
+ * The label update failed because the document doesn't belong to the same tenant as the user.
149958
+ * @remarks
149959
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149960
+ * @beta
149961
+ */
149962
+ crossTenant = "CrossTenant",
149963
+ }
149964
+ /**
149965
+ * Represents the labeling capability status of the sensitivity label catalog.
149966
+ *
149967
+ * @remarks
149968
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149969
+ * @beta
149970
+ */
149971
+ enum LabelingCapability {
149972
+ /**
149973
+ * No valid license is available for sensitivity labeling.
149974
+ * @remarks
149975
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149976
+ * @beta
149977
+ */
149978
+ noLicense = "NoLicense",
149979
+ /**
149980
+ * Sensitivity labeling is disabled for the user or tenant.
149981
+ * @remarks
149982
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149983
+ * @beta
149984
+ */
149985
+ labelingDisabled = "LabelingDisabled",
149986
+ /**
149987
+ * No labeling policy was found for the user.
149988
+ * @remarks
149989
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149990
+ * @beta
149991
+ */
149992
+ labelingPolicyNotFound = "LabelingPolicyNotFound",
149993
+ /**
149994
+ * Sensitivity labeling is fully enabled.
149995
+ * @remarks
149996
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
149997
+ * @beta
149998
+ */
149999
+ labelingEnabled = "LabelingEnabled",
150000
+ }
150001
+ /**
150002
+ * Specifies the type of protection applied by a sensitivity label.
150003
+ *
150004
+ * @remarks
150005
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
150006
+ * @beta
150007
+ */
150008
+ enum SensitivityLabelProtectionType {
150009
+ /**
150010
+ * The label applies no protection.
150011
+ * @remarks
150012
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
150013
+ * @beta
150014
+ */
150015
+ noProtection = "NoProtection",
150016
+ /**
150017
+ * The label applies admin-defined protection.
150018
+ * @remarks
150019
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
150020
+ * @beta
150021
+ */
150022
+ adminDefined = "AdminDefined",
150023
+ /**
150024
+ * The label applies user-defined protection.
150025
+ * @remarks
150026
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
150027
+ * @beta
150028
+ */
150029
+ userDefined = "UserDefined",
150030
+ }
148790
150031
  enum ErrorCodes {
148791
150032
  accessDenied = "AccessDenied",
148792
150033
  generalException = "GeneralException",
@@ -151525,6 +152766,10 @@ declare namespace Word {
151525
152766
  interface SectionCollectionUpdateData {
151526
152767
  items?: Word.Interfaces.SectionData[];
151527
152768
  }
152769
+ /** An interface for updating data on the `SensitivityLabelDetailsCollection` object, for use in `sensitivityLabelDetailsCollection.set({ ... })`. */
152770
+ interface SensitivityLabelDetailsCollectionUpdateData {
152771
+ items?: Word.Interfaces.SensitivityLabelDetailsData[];
152772
+ }
151528
152773
  /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */
151529
152774
  interface SettingUpdateData {
151530
152775
  /**
@@ -158990,6 +160235,96 @@ declare namespace Word {
158990
160235
  interface SectionCollectionData {
158991
160236
  items?: Word.Interfaces.SectionData[];
158992
160237
  }
160238
+ /** An interface describing the data returned by calling `sensitivityLabelsCatalog.toJSON()`. */
160239
+ interface SensitivityLabelsCatalogData {
160240
+ /**
160241
+ * Gets the labeling capability status of the sensitivity label catalog in Word.
160242
+ *
160243
+ * @remarks
160244
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160245
+ * @beta
160246
+ */
160247
+ getLabelingCapability?: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";
160248
+ }
160249
+ /** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */
160250
+ interface SensitivityLabelDetailsCollectionData {
160251
+ items?: Word.Interfaces.SensitivityLabelDetailsData[];
160252
+ }
160253
+ /** An interface describing the data returned by calling `sensitivityLabelDetails.toJSON()`. */
160254
+ interface SensitivityLabelDetailsData {
160255
+ /**
160256
+ * The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.
160257
+ *
160258
+ * @remarks
160259
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160260
+ * @beta
160261
+ */
160262
+ children?: Word.Interfaces.SensitivityLabelDetailsData[];
160263
+ /**
160264
+ * The color of the sensitivity label.
160265
+ *
160266
+ * @remarks
160267
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160268
+ * @beta
160269
+ */
160270
+ color?: string;
160271
+ /**
160272
+ * The unique identifier (GUID) of the sensitivity label.
160273
+ *
160274
+ * @remarks
160275
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160276
+ * @beta
160277
+ */
160278
+ id?: string;
160279
+ /**
160280
+ * Gets a value indicating whether the label is enabled.
160281
+ *
160282
+ * @remarks
160283
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160284
+ * @beta
160285
+ */
160286
+ isEnabled?: boolean;
160287
+ /**
160288
+ * The name of the sensitivity label.
160289
+ *
160290
+ * @remarks
160291
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160292
+ * @beta
160293
+ */
160294
+ name?: string;
160295
+ /**
160296
+ * The order of the sensitivity label.
160297
+ *
160298
+ * @remarks
160299
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160300
+ * @beta
160301
+ */
160302
+ order?: number;
160303
+ /**
160304
+ * Gets a value indicating the protection type provided by this label.
160305
+ *
160306
+ * @remarks
160307
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160308
+ * @beta
160309
+ */
160310
+ protectionType?: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";
160311
+ /**
160312
+ * The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
160313
+ *
160314
+ * @remarks
160315
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160316
+ * @beta
160317
+ */
160318
+ siteId?: string;
160319
+ /**
160320
+ * The description of the sensitivity label.
160321
+ *
160322
+ * @remarks
160323
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
160324
+ * @beta
160325
+ */
160326
+ tooltip?: string;
160327
+ }
158993
160328
  /** An interface describing the data returned by calling `setting.toJSON()`. */
158994
160329
  interface SettingData {
158995
160330
  /**
@@ -170270,6 +171605,181 @@ declare namespace Word {
170270
171605
  */
170271
171606
  protectedForForms?: boolean;
170272
171607
  }
171608
+ /**
171609
+ * 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.
171610
+ *
171611
+ * @remarks
171612
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171613
+ * @beta
171614
+ */
171615
+ interface SensitivityLabelsCatalogLoadOptions {
171616
+ /**
171617
+ 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`).
171618
+ */
171619
+ $all?: boolean;
171620
+ /**
171621
+ * Gets the labeling capability status of the sensitivity label catalog in Word.
171622
+ *
171623
+ * @remarks
171624
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171625
+ * @beta
171626
+ */
171627
+ getLabelingCapability?: boolean;
171628
+ }
171629
+ /**
171630
+ * Represents the collection of {@link Word.SensitivityLabelDetails} objects.
171631
+ *
171632
+ * @remarks
171633
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171634
+ * @beta
171635
+ */
171636
+ interface SensitivityLabelDetailsCollectionLoadOptions {
171637
+ /**
171638
+ 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`).
171639
+ */
171640
+ $all?: boolean;
171641
+ /**
171642
+ * For EACH ITEM in the collection: The color of the sensitivity label.
171643
+ *
171644
+ * @remarks
171645
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171646
+ * @beta
171647
+ */
171648
+ color?: boolean;
171649
+ /**
171650
+ * For EACH ITEM in the collection: The unique identifier (GUID) of the sensitivity label.
171651
+ *
171652
+ * @remarks
171653
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171654
+ * @beta
171655
+ */
171656
+ id?: boolean;
171657
+ /**
171658
+ * For EACH ITEM in the collection: Gets a value indicating whether the label is enabled.
171659
+ *
171660
+ * @remarks
171661
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171662
+ * @beta
171663
+ */
171664
+ isEnabled?: boolean;
171665
+ /**
171666
+ * For EACH ITEM in the collection: The name of the sensitivity label.
171667
+ *
171668
+ * @remarks
171669
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171670
+ * @beta
171671
+ */
171672
+ name?: boolean;
171673
+ /**
171674
+ * For EACH ITEM in the collection: The order of the sensitivity label.
171675
+ *
171676
+ * @remarks
171677
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171678
+ * @beta
171679
+ */
171680
+ order?: boolean;
171681
+ /**
171682
+ * For EACH ITEM in the collection: Gets a value indicating the protection type provided by this label.
171683
+ *
171684
+ * @remarks
171685
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171686
+ * @beta
171687
+ */
171688
+ protectionType?: boolean;
171689
+ /**
171690
+ * For EACH ITEM in the collection: The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
171691
+ *
171692
+ * @remarks
171693
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171694
+ * @beta
171695
+ */
171696
+ siteId?: boolean;
171697
+ /**
171698
+ * For EACH ITEM in the collection: The description of the sensitivity label.
171699
+ *
171700
+ * @remarks
171701
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171702
+ * @beta
171703
+ */
171704
+ tooltip?: boolean;
171705
+ }
171706
+ /**
171707
+ * Represents the properties of available sensitivity labels in Word.
171708
+ *
171709
+ * @remarks
171710
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171711
+ * @beta
171712
+ */
171713
+ interface SensitivityLabelDetailsLoadOptions {
171714
+ /**
171715
+ 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`).
171716
+ */
171717
+ $all?: boolean;
171718
+ /**
171719
+ * The color of the sensitivity label.
171720
+ *
171721
+ * @remarks
171722
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171723
+ * @beta
171724
+ */
171725
+ color?: boolean;
171726
+ /**
171727
+ * The unique identifier (GUID) of the sensitivity label.
171728
+ *
171729
+ * @remarks
171730
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171731
+ * @beta
171732
+ */
171733
+ id?: boolean;
171734
+ /**
171735
+ * Gets a value indicating whether the label is enabled.
171736
+ *
171737
+ * @remarks
171738
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171739
+ * @beta
171740
+ */
171741
+ isEnabled?: boolean;
171742
+ /**
171743
+ * The name of the sensitivity label.
171744
+ *
171745
+ * @remarks
171746
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171747
+ * @beta
171748
+ */
171749
+ name?: boolean;
171750
+ /**
171751
+ * The order of the sensitivity label.
171752
+ *
171753
+ * @remarks
171754
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171755
+ * @beta
171756
+ */
171757
+ order?: boolean;
171758
+ /**
171759
+ * Gets a value indicating the protection type provided by this label.
171760
+ *
171761
+ * @remarks
171762
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171763
+ * @beta
171764
+ */
171765
+ protectionType?: boolean;
171766
+ /**
171767
+ * The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
171768
+ *
171769
+ * @remarks
171770
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171771
+ * @beta
171772
+ */
171773
+ siteId?: boolean;
171774
+ /**
171775
+ * The description of the sensitivity label.
171776
+ *
171777
+ * @remarks
171778
+ * [Api set: WordApi BETA (PREVIEW ONLY)]
171779
+ * @beta
171780
+ */
171781
+ tooltip?: boolean;
171782
+ }
170273
171783
  /**
170274
171784
  * Represents a setting of the add-in.
170275
171785
  *
@@ -177583,6 +179093,7 @@ declare namespace Word {
177583
179093
  constructor(url?: string);
177584
179094
  readonly document: Document;
177585
179095
  readonly application: Application;
179096
+ readonly sensitivityLabelsCatalog: SensitivityLabelsCatalog;
177586
179097
  }
177587
179098
  /**
177588
179099
  * Executes a batch script that performs actions on the Word object model, using the RequestContext of previously created API objects.