@types/office-js-preview 1.0.475 → 1.0.477

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for office-js-preview (https://github.com
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Fri, 31 May 2024 21:07:10 GMT
11
+ * Last updated: Mon, 10 Jun 2024 15:07:29 GMT
12
12
  * Dependencies: none
13
13
 
14
14
  # Credits
@@ -11062,6 +11062,10 @@ declare namespace Office {
11062
11062
  *
11063
11063
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11064
11064
  *
11065
+ * *Important**: The `removeAttachmentAsync` method doesn't remove inline attachments from a mail item.
11066
+ * To remove an inline attachment, first get the item's body, then remove any references of the attachment from its contents.
11067
+ * Use the {@link https://learn.microsoft.com/javascript/api/outlook/office.body | Office.Body} APIs to get and set the body of an item.
11068
+ *
11065
11069
  * **Errors**:
11066
11070
  *
11067
11071
  * - `InvalidAttachmentId`: The attachment identifier does not exist.
@@ -11091,6 +11095,10 @@ declare namespace Office {
11091
11095
  *
11092
11096
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
11093
11097
  *
11098
+ * *Important**: The `removeAttachmentAsync` method doesn't remove inline attachments from a mail item.
11099
+ * To remove an inline attachment, first get the item's body, then remove any references of the attachment from its contents.
11100
+ * Use the {@link https://learn.microsoft.com/javascript/api/outlook/office.body | Office.Body} APIs to get and set the body of an item.
11101
+ *
11094
11102
  * **Errors**:
11095
11103
  *
11096
11104
  * - `InvalidAttachmentId`: The attachment identifier does not exist.
@@ -17242,6 +17250,10 @@ declare namespace Office {
17242
17250
  *
17243
17251
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
17244
17252
  *
17253
+ * *Important**: The `removeAttachmentAsync` method doesn't remove inline attachments from a mail item.
17254
+ * To remove an inline attachment, first get the item's body, then remove any references of the attachment from its contents.
17255
+ * Use the {@link https://learn.microsoft.com/javascript/api/outlook/office.body | Office.Body} APIs to get and set the body of an item.
17256
+ *
17245
17257
  * **Errors**:
17246
17258
  *
17247
17259
  * - `InvalidAttachmentId`: The attachment identifier does not exist.
@@ -17271,6 +17283,10 @@ declare namespace Office {
17271
17283
  *
17272
17284
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
17273
17285
  *
17286
+ * *Important**: The `removeAttachmentAsync` method doesn't remove inline attachments from a mail item.
17287
+ * To remove an inline attachment, first get the item's body, then remove any references of the attachment from its contents.
17288
+ * Use the {@link https://learn.microsoft.com/javascript/api/outlook/office.body | Office.Body} APIs to get and set the body of an item.
17289
+ *
17274
17290
  * **Errors**:
17275
17291
  *
17276
17292
  * - `InvalidAttachmentId`: The attachment identifier does not exist.
@@ -89962,40 +89978,35 @@ declare namespace Word {
89962
89978
  * Properties defining the behavior of the pop-up menu for a given critique.
89963
89979
  *
89964
89980
  * @remarks
89965
- * [Api set: WordApi BETA (PREVIEW ONLY)]
89966
- * @beta
89981
+ * [Api set: WordApi 1.8]
89967
89982
  */
89968
89983
  interface CritiquePopupOptions {
89969
89984
  /**
89970
89985
  * Gets the manifest resource ID of the string to use for branding. This branding text appears next to your add-in icon in the pop-up menu.
89971
89986
  *
89972
89987
  * @remarks
89973
- * [Api set: WordApi BETA (PREVIEW ONLY)]
89974
- * @beta
89988
+ * [Api set: WordApi 1.8]
89975
89989
  */
89976
89990
  brandingTextResourceId: string;
89977
89991
  /**
89978
89992
  * Gets the manifest resource ID of the string to use as the subtitle.
89979
89993
  *
89980
89994
  * @remarks
89981
- * [Api set: WordApi BETA (PREVIEW ONLY)]
89982
- * @beta
89995
+ * [Api set: WordApi 1.8]
89983
89996
  */
89984
89997
  subtitleResourceId: string;
89985
89998
  /**
89986
89999
  * Gets the suggestions to display in the critique pop-up menu.
89987
90000
  *
89988
90001
  * @remarks
89989
- * [Api set: WordApi BETA (PREVIEW ONLY)]
89990
- * @beta
90002
+ * [Api set: WordApi 1.8]
89991
90003
  */
89992
90004
  suggestions: string[];
89993
90005
  /**
89994
90006
  * Gets the manifest resource ID of the string to use as the title.
89995
90007
  *
89996
90008
  * @remarks
89997
- * [Api set: WordApi BETA (PREVIEW ONLY)]
89998
- * @beta
90009
+ * [Api set: WordApi 1.8]
89999
90010
  */
90000
90011
  titleResourceId: string;
90001
90012
  }
@@ -90024,8 +90035,7 @@ declare namespace Word {
90024
90035
  * Specifies the behavior of the pop-up menu for the critique.
90025
90036
  *
90026
90037
  * @remarks
90027
- * [Api set: WordApi BETA (PREVIEW ONLY)]
90028
- * @beta
90038
+ * [Api set: WordApi 1.8]
90029
90039
  */
90030
90040
  popupOptions: Word.CritiquePopupOptions;
90031
90041
  /**
@@ -90285,32 +90295,28 @@ declare namespace Word {
90285
90295
  * Represents action information that's passed back on annotation pop-up action event.
90286
90296
  *
90287
90297
  * @remarks
90288
- * [Api set: WordApi BETA (PREVIEW ONLY)]
90289
- * @beta
90298
+ * [Api set: WordApi 1.8]
90290
90299
  */
90291
90300
  interface AnnotationPopupActionEventArgs {
90292
90301
  /**
90293
90302
  * Specifies the chosen action in the pop-up menu.
90294
90303
  *
90295
90304
  * @remarks
90296
- * [Api set: WordApi BETA (PREVIEW ONLY)]
90297
- * @beta
90305
+ * [Api set: WordApi 1.8]
90298
90306
  */
90299
90307
  action: string;
90300
90308
  /**
90301
90309
  * Specifies the accepted suggestion (only populated when accepting a critique suggestion).
90302
90310
  *
90303
90311
  * @remarks
90304
- * [Api set: WordApi BETA (PREVIEW ONLY)]
90305
- * @beta
90312
+ * [Api set: WordApi 1.8]
90306
90313
  */
90307
90314
  critiqueSuggestion: string;
90308
90315
  /**
90309
90316
  * Specifies the annotation ID for which the event was fired.
90310
90317
  *
90311
90318
  * @remarks
90312
- * [Api set: WordApi BETA (PREVIEW ONLY)]
90313
- * @beta
90319
+ * [Api set: WordApi 1.8]
90314
90320
  */
90315
90321
  id: string;
90316
90322
  }
@@ -90672,10 +90678,11 @@ declare namespace Word {
90672
90678
  * [Api set: WordApi 1.1]
90673
90679
  *
90674
90680
  * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
90681
+ * `DropDownList` support is currently in preview.
90675
90682
  *
90676
- * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
90683
+ * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', or 'DropDownList'. The default is 'RichText'.
90677
90684
  */
90678
- insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
90685
+ insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | "RichText" | "PlainText" | "CheckBox" | "DropDownList"): Word.ContentControl;
90679
90686
  /**
90680
90687
  * Inserts a document into the body at the specified location.
90681
90688
  *
@@ -93457,10 +93464,9 @@ declare namespace Word {
93457
93464
  * Occurs when the user performs an action in an annotation pop-up menu.
93458
93465
  *
93459
93466
  * @remarks
93460
- * [Api set: WordApi BETA (PREVIEW ONLY)]
93467
+ * [Api set: WordApi 1.8]
93461
93468
  *
93462
93469
  * @eventproperty
93463
- * @beta
93464
93470
  */
93465
93471
  readonly onAnnotationPopupAction: OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>;
93466
93472
  /**
@@ -96001,10 +96007,11 @@ declare namespace Word {
96001
96007
  * [Api set: WordApi 1.1]
96002
96008
  *
96003
96009
  * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
96010
+ * `DropDownList` support is currently in preview.
96004
96011
  *
96005
- * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
96012
+ * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', or 'DropDownList'. The default is 'RichText'.
96006
96013
  */
96007
- insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
96014
+ insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | "RichText" | "PlainText" | "CheckBox" | "DropDownList"): Word.ContentControl;
96008
96015
  /**
96009
96016
  * Inserts a document into the paragraph at the specified location.
96010
96017
  *
@@ -96767,8 +96774,7 @@ declare namespace Word {
96767
96774
  To highlight the text permanently, set the range's Font.HighlightColor.
96768
96775
  *
96769
96776
  * @remarks
96770
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96771
- * @beta
96777
+ * [Api set: WordApi 1.8]
96772
96778
  */
96773
96779
  highlight(): void;
96774
96780
  /**
@@ -96809,10 +96815,11 @@ declare namespace Word {
96809
96815
  * [Api set: WordApi 1.1]
96810
96816
  *
96811
96817
  * Note: The `contentControlType` parameter was introduced in WordApi 1.5. `PlainText` support was added in WordApi 1.5. `CheckBox` support was added in WordApi 1.7.
96818
+ * `DropDownList` support is currently in preview.
96812
96819
  *
96813
- * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', or 'CheckBox'. The default is 'RichText'.
96820
+ * @param contentControlType Optional. Content control type to insert. Must be 'RichText', 'PlainText', 'CheckBox', or 'DropDownList'. The default is 'RichText'.
96814
96821
  */
96815
- insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | "RichText" | "PlainText" | "CheckBox"): Word.ContentControl;
96822
+ insertContentControl(contentControlType?: Word.ContentControlType.richText | Word.ContentControlType.plainText | Word.ContentControlType.checkBox | Word.ContentControlType.dropDownList | "RichText" | "PlainText" | "CheckBox" | "DropDownList"): Word.ContentControl;
96816
96823
  /**
96817
96824
  * Inserts an endnote. The endnote reference is placed after the range.
96818
96825
  *
@@ -96979,8 +96986,7 @@ declare namespace Word {
96979
96986
  * Removes the highlight added by the Highlight function if any.
96980
96987
  *
96981
96988
  * @remarks
96982
- * [Api set: WordApi BETA (PREVIEW ONLY)]
96983
- * @beta
96989
+ * [Api set: WordApi 1.8]
96984
96990
  */
96985
96991
  removeHighlight(): void;
96986
96992
  /**
@@ -99928,8 +99934,7 @@ declare namespace Word {
99928
99934
  /**
99929
99935
  * Represents an action in the annotation pop-up.
99930
99936
  * @remarks
99931
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99932
- * @beta
99937
+ * [Api set: WordApi 1.8]
99933
99938
  */
99934
99939
  annotationPopupAction = "AnnotationPopupAction",
99935
99940
  }
@@ -99951,47 +99956,6 @@ declare namespace Word {
99951
99956
  */
99952
99957
  remote = "Remote",
99953
99958
  }
99954
- /**
99955
- * Provides information about the content control that raised an event.
99956
- *
99957
- * @remarks
99958
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99959
- * @beta
99960
- */
99961
- interface ContentControlEventArgs {
99962
- /**
99963
- * The object that raised the event. Load this object to get its properties.
99964
- *
99965
- * @remarks
99966
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99967
- * @beta
99968
- */
99969
- contentControl: Word.ContentControl;
99970
- /**
99971
- * The event type. See Word.EventType for details.
99972
- *
99973
- * @remarks
99974
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99975
- * @beta
99976
- */
99977
- eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction";
99978
- /**
99979
- * Gets the content control IDs.
99980
- *
99981
- * @remarks
99982
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99983
- * @beta
99984
- */
99985
- ids: number[];
99986
- /**
99987
- * The source of the event. It can be local or remote (through coauthoring).
99988
- *
99989
- * @remarks
99990
- * [Api set: WordApi BETA (PREVIEW ONLY)]
99991
- * @beta
99992
- */
99993
- source: Word.EventSource | "Local" | "Remote";
99994
- }
99995
99959
  /**
99996
99960
  * Provides information about the content control that raised contentControlAdded event.
99997
99961
  *
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.475",
3
+ "version": "1.0.477",
4
4
  "description": "TypeScript definitions for office-js-preview",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,7 +45,7 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "a51479e683c9cbb0179ba6026a0cd9e3649da1c1a42f6dc37a75b72d2375f370",
48
+ "typesPublisherContentHash": "701b1495adaafdb8da7ffd9d600dd594ea8999dacb9ec27580935889caf20f1d",
49
49
  "typeScriptVersion": "4.7",
50
50
  "nonNpm": true
51
51
  }