diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index 6f468f67b256dc..8baaa598305b38 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -26021,7 +26021,7 @@ declare namespace OfficeExtension { top?: number; /** * Only usable on collection types. Specifies the number of items in the collection that are to be skipped and not included in the result. - * If top is specified, the result set will start after skipping the specified number of items. + * If `top` is specified, the result set will start after skipping the specified number of items. */ skip?: number; } @@ -104750,6 +104750,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ class CoauthoringLock extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -104788,6 +104790,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ unlock(): void; /** @@ -104830,6 +104834,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ class CoauthoringLockCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -104842,6 +104848,8 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.4] * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. + * * @param options Optional. The options to further configure the coauthoring lock. */ add(options?: Word.CoauthoringLockAddOptions): Word.CoauthoringLock; @@ -104850,6 +104858,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ unlockEphemeralLocks(): void; /** @@ -104889,6 +104899,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ interface CoauthoringLockAddOptions { /** @@ -104920,6 +104932,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ readonly locks: Word.CoauthoringLockCollection; /** @@ -105056,6 +105070,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ readonly locks: Word.CoauthoringLockCollection; /** @@ -117514,6 +117530,14 @@ declare namespace Word { * @beta */ readonly getLabelingCapability: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; + /** + * Gets the attribute-based access control (ABAC) attributes available for sensitivity labels. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getAttributes(): OfficeExtension.ClientResult; /** * Gets all the sensitivity labels that are enabled in Word. * @@ -117561,6 +117585,152 @@ declare namespace Word { */ toJSON(): Word.Interfaces.SensitivityLabelsCatalogData; } + /** + * Represents a single attribute-based access control (ABAC) attribute value for a sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabelAbacAttributeValue extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The display name of the ABAC attribute value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly displayName: string; + /** + * The display order of the ABAC attribute value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly displayOrder: number; + /** + * The unique identifier of the ABAC attribute value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: string; + /** + * Indicates whether the ABAC attribute value is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isActive: boolean; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SensitivityLabelAbacAttributeValueLoadOptions): Word.SensitivityLabelAbacAttributeValue; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabelAbacAttributeValue; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabelAbacAttributeValue; + /** + * 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.) + * Whereas the original `Word.SensitivityLabelAbacAttributeValue` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelAbacAttributeValueData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SensitivityLabelAbacAttributeValueData; + } + /** + * Represents an attribute-based access control (ABAC) attribute for sensitivity labels. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class SensitivityLabelAbacAttribute extends OfficeExtension.ClientObject { + /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ + context: RequestContext; + /** + * The display name of the ABAC attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly displayName: string; + /** + * The display order of the ABAC attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly displayOrder: number; + /** + * Indicates whether the ABAC attribute is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isActive: boolean; + /** + * Indicates whether the ABAC attribute can have multiple values. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isMultiValued: boolean; + /** + * The values available for the ABAC attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly values: Word.SensitivityLabelAbacAttributeValue[]; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.SensitivityLabelAbacAttributeLoadOptions): Word.SensitivityLabelAbacAttribute; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + */ + load(propertyNames?: string | string[]): Word.SensitivityLabelAbacAttribute; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @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. + */ + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.SensitivityLabelAbacAttribute; + /** + * 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.) + * Whereas the original `Word.SensitivityLabelAbacAttribute` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SensitivityLabelAbacAttributeData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SensitivityLabelAbacAttributeData; + } /** * Represents the collection of {@link Word.SensitivityLabelDetails} objects. * @@ -117649,6 +117819,14 @@ declare namespace Word { * @beta */ readonly children: Word.SensitivityLabelDetailsCollection; + /** + * The attribute-based access control (ABAC) attribute values associated with the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly abacAttributeValues: Word.SensitivityLabelAbacAttributeValue[]; /** * The color of the sensitivity label. * @@ -117665,6 +117843,22 @@ declare namespace Word { * @beta */ readonly id: string; + /** + * Indicates whether attribute-based access control (ABAC) attributes are required when applying the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isAbacAttributesRequired: boolean; + /** + * Indicates whether the sensitivity label supports attribute-based access control (ABAC) attributes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isAbacEnabled: boolean; /** * Gets a value indicating whether the label is enabled. * @@ -126797,6 +126991,24 @@ declare namespace Word { * [Api set: WordApi 1.5] */ contentControlAdded = "ContentControlAdded", + /** + * AnnotationAdded represents the event an annotation has been added to the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationAdded = "AnnotationAdded", + /** + * AnnotationChanged represents the event an annotation has been updated in the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationChanged = "AnnotationChanged", + /** + * AnnotationDeleted represents the event an annotation has been deleted from the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationDeleted = "AnnotationDeleted", /** * Represents that one or more comments were deleted. * @remarks @@ -126926,7 +127138,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -126955,7 +127167,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -126984,7 +127196,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -127013,7 +127225,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -127042,7 +127254,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -127157,7 +127369,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -127193,7 +127405,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -127222,7 +127434,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -127251,7 +127463,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -127299,7 +127511,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; } /** * A structure for the ID and reply IDs of this comment. @@ -149846,6 +150058,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ enum CoauthoringLockType { /** @@ -149990,6 +150204,41 @@ declare namespace Word { * @beta */ crossTenant = "CrossTenant", + /** + * Attribute-based access control (ABAC) attribute values were supplied, but the target label is not ABAC-enabled. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + abacAttributesNotAllowed = "AbacAttributesNotAllowed", + /** + * The target label isn't enabled for attribute-based access controls and requires attribute selections, but no ABAC attribute values were supplied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + abacAttributesRequired = "AbacAttributesRequired", + /** + * The label update failed due to unsupported attribute-based access control (ABAC). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unsupportedAbac = "UnsupportedAbac", + /** + * The label update failed because the specified label is disabled or not applicable to the user. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + labelDisabled = "LabelDisabled", + /** + * The label update failed because removing the sensitivity label is not supported. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + removingLabelNotSupported = "RemovingLabelNotSupported", } /** * Represents the labeling capability status of the sensitivity label catalog. @@ -156481,6 +156730,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ locks?: Word.Interfaces.CoauthoringLockData[]; /** @@ -156537,6 +156788,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ locks?: Word.Interfaces.CoauthoringLockData[]; /** @@ -160276,6 +160529,84 @@ declare namespace Word { */ getLabelingCapability?: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"; } + /** An interface describing the data returned by calling `sensitivityLabelAbacAttributeValue.toJSON()`. */ + interface SensitivityLabelAbacAttributeValueData { + /** + * The display name of the ABAC attribute value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + displayName?: string; + /** + * The display order of the ABAC attribute value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + displayOrder?: number; + /** + * The unique identifier of the ABAC attribute value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: string; + /** + * Indicates whether the ABAC attribute value is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isActive?: boolean; + } + /** An interface describing the data returned by calling `sensitivityLabelAbacAttribute.toJSON()`. */ + interface SensitivityLabelAbacAttributeData { + /** + * The display name of the ABAC attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + displayName?: string; + /** + * The display order of the ABAC attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + displayOrder?: number; + /** + * Indicates whether the ABAC attribute is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isActive?: boolean; + /** + * Indicates whether the ABAC attribute can have multiple values. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isMultiValued?: boolean; + /** + * The values available for the ABAC attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + values?: Word.SensitivityLabelAbacAttributeValue[]; + } /** An interface describing the data returned by calling `sensitivityLabelDetailsCollection.toJSON()`. */ interface SensitivityLabelDetailsCollectionData { items?: Word.Interfaces.SensitivityLabelDetailsData[]; @@ -160290,6 +160621,14 @@ declare namespace Word { * @beta */ children?: Word.Interfaces.SensitivityLabelDetailsData[]; + /** + * The ABAC attribute values associated with the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + abacAttributeValues?: Word.SensitivityLabelAbacAttributeValue[]; /** * The color of the sensitivity label. * @@ -160306,6 +160645,22 @@ declare namespace Word { * @beta */ id?: string; + /** + * Indicates whether ABAC attributes are required when applying the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAbacAttributesRequired?: boolean; + /** + * Indicates whether the sensitivity label supports ABAC attributes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAbacEnabled?: boolean; /** * Gets a value indicating whether the label is enabled. * @@ -165411,6 +165766,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ interface CoauthoringLockLoadOptions { /** @@ -165444,6 +165801,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ interface CoauthoringLockCollectionLoadOptions { /** @@ -171656,6 +172015,104 @@ declare namespace Word { */ getLabelingCapability?: boolean; } + /** + * Represents a single ABAC attribute value for a sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SensitivityLabelAbacAttributeValueLoadOptions { + /** + 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`). + */ + $all?: boolean; + /** + * The display name of the ABAC attribute value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + displayName?: boolean; + /** + * The display order of the ABAC attribute value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + displayOrder?: boolean; + /** + * The unique identifier of the ABAC attribute value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Indicates whether the ABAC attribute value is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isActive?: boolean; + } + /** + * Represents an ABAC attribute for sensitivity labels. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SensitivityLabelAbacAttributeLoadOptions { + /** + 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`). + */ + $all?: boolean; + /** + * The display name of the ABAC attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + displayName?: boolean; + /** + * The display order of the ABAC attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + displayOrder?: boolean; + /** + * Indicates whether the ABAC attribute is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isActive?: boolean; + /** + * Indicates whether the ABAC attribute can have multiple values. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isMultiValued?: boolean; + /** + * The values available for the ABAC attribute. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + values?: boolean; + } /** * Represents the collection of {@link Word.SensitivityLabelDetails} objects. * @@ -171668,6 +172125,14 @@ declare namespace Word { 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`). */ $all?: boolean; + /** + * For EACH ITEM in the collection: The ABAC attribute values associated with the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + abacAttributeValues?: boolean; /** * For EACH ITEM in the collection: The color of the sensitivity label. * @@ -171684,6 +172149,22 @@ declare namespace Word { * @beta */ id?: boolean; + /** + * For EACH ITEM in the collection: Indicates whether ABAC attributes are required when applying the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAbacAttributesRequired?: boolean; + /** + * For EACH ITEM in the collection: Indicates whether the sensitivity label supports ABAC attributes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAbacEnabled?: boolean; /** * For EACH ITEM in the collection: Gets a value indicating whether the label is enabled. * @@ -171745,6 +172226,14 @@ declare namespace Word { 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`). */ $all?: boolean; + /** + * The ABAC attribute values associated with the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + abacAttributeValues?: boolean; /** * The color of the sensitivity label. * @@ -171761,6 +172250,22 @@ declare namespace Word { * @beta */ id?: boolean; + /** + * Indicates whether ABAC attributes are required when applying the sensitivity label. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAbacAttributesRequired?: boolean; + /** + * Indicates whether the sensitivity label supports ABAC attributes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAbacEnabled?: boolean; /** * Gets a value indicating whether the label is enabled. * @@ -183345,7 +183850,7 @@ declare namespace OneNote { */ $top?: number; /** - * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items. + * Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the selection of result will start after skipping the specified number of items. */ $skip?: number; } @@ -188275,7 +188780,7 @@ declare namespace Visio { */ $top?: number; /** - * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items. + * Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the selection of result will start after skipping the specified number of items. */ $skip?: number; } diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 8ecea99b7a9ce4..3cebcd299ae3ac 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -25647,7 +25647,7 @@ declare namespace OfficeExtension { top?: number; /** * Only usable on collection types. Specifies the number of items in the collection that are to be skipped and not included in the result. - * If top is specified, the result set will start after skipping the specified number of items. + * If `top` is specified, the result set will start after skipping the specified number of items. */ skip?: number; } @@ -70108,7 +70108,7 @@ declare namespace Excel { */ $top?: number; /** - * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items. + * Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the selection of result will start after skipping the specified number of items. */ $skip?: number; } @@ -97834,6 +97834,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ class CoauthoringLock extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -97872,6 +97874,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ unlock(): void; /** @@ -97914,6 +97918,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ class CoauthoringLockCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -97926,6 +97932,8 @@ declare namespace Word { * @remarks * [Api set: WordApiDesktop 1.4] * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. + * * @param options Optional. The options to further configure the coauthoring lock. */ add(options?: Word.CoauthoringLockAddOptions): Word.CoauthoringLock; @@ -97934,6 +97942,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ unlockEphemeralLocks(): void; /** @@ -97973,6 +97983,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ interface CoauthoringLockAddOptions { /** @@ -98004,6 +98016,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ readonly locks: Word.CoauthoringLockCollection; /** @@ -98140,6 +98154,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ readonly locks: Word.CoauthoringLockCollection; /** @@ -118839,6 +118855,24 @@ declare namespace Word { * [Api set: WordApi 1.5] */ contentControlAdded = "ContentControlAdded", + /** + * AnnotationAdded represents the event an annotation has been added to the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationAdded = "AnnotationAdded", + /** + * AnnotationChanged represents the event an annotation has been updated in the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationChanged = "AnnotationChanged", + /** + * AnnotationDeleted represents the event an annotation has been deleted from the document. + * @remarks + * [Api set: WordApiOnline 1.1] + */ + annotationDeleted = "AnnotationDeleted", /** * Represents that a content control has been entered. * @remarks @@ -118933,7 +118967,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -118962,7 +118996,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -118991,7 +119025,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -119020,7 +119054,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -119049,7 +119083,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -119164,7 +119198,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.5] */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the content control IDs. * @@ -119200,7 +119234,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -119229,7 +119263,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -119258,7 +119292,7 @@ declare namespace Word { * @remarks * [Api set: WordApi 1.6] */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "AnnotationAdded" | "AnnotationChanged" | "AnnotationDeleted" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. * @@ -140326,6 +140360,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ enum CoauthoringLockType { /** @@ -146765,6 +146801,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ locks?: Word.Interfaces.CoauthoringLockData[]; /** @@ -146821,6 +146859,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ locks?: Word.Interfaces.CoauthoringLockData[]; /** @@ -155502,6 +155542,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ interface CoauthoringLockLoadOptions { /** @@ -155535,6 +155577,8 @@ declare namespace Word { * * @remarks * [Api set: WordApiDesktop 1.4] + * + * This API works only with legacy coauthoring locks. It doesn't apply to modern OneDrive or SharePoint coauthoring, where lock management is handled automatically by the service. Calls on a modern document will fail with a `GeneralException` error. */ interface CoauthoringLockCollectionLoadOptions { /** @@ -173053,7 +173097,7 @@ declare namespace OneNote { */ $top?: number; /** - * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items. + * Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the selection of result will start after skipping the specified number of items. */ $skip?: number; } @@ -177966,7 +178010,7 @@ declare namespace Visio { */ $top?: number; /** - * Specify the number of items in the collection that are to be skipped and not included in the result. If top is specified, the selection of result will start after skipping the specified number of items. + * Specify the number of items in the collection that are to be skipped and not included in the result. If `top` is specified, the selection of result will start after skipping the specified number of items. */ $skip?: number; }