@types/office-js-preview 1.0.351 → 1.0.353

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 (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Mon, 07 Nov 2022 20:26:35 GMT
11
+ * Last updated: Fri, 11 Nov 2022 19:32:52 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -8862,11 +8862,15 @@ declare namespace Office {
8862
8862
  */
8863
8863
  enum LocationType {
8864
8864
  /**
8865
- * A custom location.
8865
+ * A custom location. Custom locations don't have an SMTP address.
8866
+ *
8867
+ * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups}
8868
+ * added as appointment locations aren't returned by the
8869
+ * {@link https://learn.microsoft.com/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-getasync-member(1) | EnhancedLocation.getAsync} method.
8866
8870
  */
8867
8871
  Custom = "custom",
8868
8872
  /**
8869
- * A conference room or similar resource.
8873
+ * A conference room or similar resource that has an SMTP address.
8870
8874
  */
8871
8875
  Room = "room"
8872
8876
  }
@@ -13144,6 +13148,9 @@ declare namespace Office {
13144
13148
  addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
13145
13149
  /**
13146
13150
  * Gets the set of locations associated with the appointment.
13151
+ *
13152
+ * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups}
13153
+ * added as appointment locations aren't returned by this method.
13147
13154
  *
13148
13155
  * @remarks
13149
13156
  * [Api set: Mailbox 1.8]
@@ -13161,6 +13168,9 @@ declare namespace Office {
13161
13168
  /**
13162
13169
  * Gets the set of locations associated with the appointment.
13163
13170
  *
13171
+ * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups}
13172
+ * added as appointment locations aren't returned by this method.
13173
+ *
13164
13174
  * @remarks
13165
13175
  * [Api set: Mailbox 1.8]
13166
13176
  *
@@ -112030,8 +112040,7 @@ declare namespace PowerPoint {
112030
112040
  If no shapes are selected, an empty collection is returned.
112031
112041
  *
112032
112042
  * @remarks
112033
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112034
- * @beta
112043
+ * [Api set: PowerPointApi 1.5]
112035
112044
  */
112036
112045
  getSelectedShapes(): PowerPoint.ShapeScopedCollection;
112037
112046
  /**
@@ -112040,8 +112049,7 @@ declare namespace PowerPoint {
112040
112049
  If no slides are selected, an empty collection is returned.
112041
112050
  *
112042
112051
  * @remarks
112043
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112044
- * @beta
112052
+ * [Api set: PowerPointApi 1.5]
112045
112053
  */
112046
112054
  getSelectedSlides(): PowerPoint.SlideScopedCollection;
112047
112055
  /**
@@ -112049,8 +112057,7 @@ declare namespace PowerPoint {
112049
112057
  Throws an exception if no text is selected.
112050
112058
  *
112051
112059
  * @remarks
112052
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112053
- * @beta
112060
+ * [Api set: PowerPointApi 1.5]
112054
112061
  */
112055
112062
  getSelectedTextRange(): PowerPoint.TextRange;
112056
112063
  /**
@@ -112058,8 +112065,7 @@ declare namespace PowerPoint {
112058
112065
  If no text is selected, an object with an `isNullObject` property set to `true` is returned.
112059
112066
  *
112060
112067
  * @remarks
112061
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112062
- * @beta
112068
+ * [Api set: PowerPointApi 1.5]
112063
112069
  */
112064
112070
  getSelectedTextRangeOrNullObject(): PowerPoint.TextRange;
112065
112071
  /**
@@ -112076,8 +112082,7 @@ declare namespace PowerPoint {
112076
112082
  * Selects the slides in the current view of the presentation. Existing slide selection is replaced with the new selection.
112077
112083
  *
112078
112084
  * @remarks
112079
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
112080
- * @beta
112085
+ * [Api set: PowerPointApi 1.5]
112081
112086
  *
112082
112087
  * @param slideIds List of slide IDs to select in the presentation. If the list is empty, selection is cleared.
112083
112088
  */
@@ -113992,8 +113997,7 @@ declare namespace PowerPoint {
113992
113997
  * Selects the specified shapes. Existing shape selection is replaced with the new selection.
113993
113998
  *
113994
113999
  * @remarks
113995
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
113996
- * @beta
114000
+ * [Api set: PowerPointApi 1.5]
113997
114001
  *
113998
114002
  * @param shapeIds List of shape IDs to select in the slide. If the list is empty, the selection is cleared.
113999
114003
  */
@@ -114670,8 +114674,7 @@ declare namespace PowerPoint {
114670
114674
  Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
114671
114675
  *
114672
114676
  * @remarks
114673
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114674
- * @beta
114677
+ * [Api set: PowerPointApi 1.5]
114675
114678
  */
114676
114679
  length: number;
114677
114680
  /**
@@ -114679,8 +114682,7 @@ declare namespace PowerPoint {
114679
114682
  Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
114680
114683
  *
114681
114684
  * @remarks
114682
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114683
- * @beta
114685
+ * [Api set: PowerPointApi 1.5]
114684
114686
  */
114685
114687
  start: number;
114686
114688
  /**
@@ -114694,8 +114696,7 @@ declare namespace PowerPoint {
114694
114696
  * Returns the parent {@link PowerPoint.TextFrame} object that holds this `TextRange`.
114695
114697
  *
114696
114698
  * @remarks
114697
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114698
- * @beta
114699
+ * [Api set: PowerPointApi 1.5]
114699
114700
  */
114700
114701
  getParentTextFrame(): PowerPoint.TextFrame;
114701
114702
  /**
@@ -114712,8 +114713,7 @@ declare namespace PowerPoint {
114712
114713
  * Selects this `TextRange` in the current view.
114713
114714
  *
114714
114715
  * @remarks
114715
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114716
- * @beta
114716
+ * [Api set: PowerPointApi 1.5]
114717
114717
  */
114718
114718
  setSelected(): void;
114719
114719
  /**
@@ -114826,8 +114826,7 @@ declare namespace PowerPoint {
114826
114826
  * Returns the parent {@link PowerPoint.Shape} object that holds this `TextFrame`.
114827
114827
  *
114828
114828
  * @remarks
114829
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114830
- * @beta
114829
+ * [Api set: PowerPointApi 1.5]
114831
114830
  */
114832
114831
  getParentShape(): PowerPoint.Shape;
114833
114832
  /**
@@ -114954,48 +114953,42 @@ declare namespace PowerPoint {
114954
114953
  * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. Throws an exception if this shape does not belong to a `Slide`.
114955
114954
  *
114956
114955
  * @remarks
114957
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114958
- * @beta
114956
+ * [Api set: PowerPointApi 1.5]
114959
114957
  */
114960
114958
  getParentSlide(): PowerPoint.Slide;
114961
114959
  /**
114962
114960
  * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideLayout`.
114963
114961
  *
114964
114962
  * @remarks
114965
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114966
- * @beta
114963
+ * [Api set: PowerPointApi 1.5]
114967
114964
  */
114968
114965
  getParentSlideLayout(): PowerPoint.SlideLayout;
114969
114966
  /**
114970
114967
  * Returns the parent {@link PowerPoint.SlideLayout} object that holds this `Shape`. If this shape does not belong to a `SlideLayout`, an object with an `isNullObject` property set to `true` is returned.
114971
114968
  *
114972
114969
  * @remarks
114973
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114974
- * @beta
114970
+ * [Api set: PowerPointApi 1.5]
114975
114971
  */
114976
114972
  getParentSlideLayoutOrNullObject(): PowerPoint.SlideLayout;
114977
114973
  /**
114978
114974
  * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. Throws an exception if this shape does not belong to a `SlideMaster`.
114979
114975
  *
114980
114976
  * @remarks
114981
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114982
- * @beta
114977
+ * [Api set: PowerPointApi 1.5]
114983
114978
  */
114984
114979
  getParentSlideMaster(): PowerPoint.SlideMaster;
114985
114980
  /**
114986
114981
  * Returns the parent {@link PowerPoint.SlideMaster} object that holds this `Shape`. If this shape does not belong to a `SlideMaster`, an object with an `isNullObject` property set to `true` is returned.
114987
114982
  *
114988
114983
  * @remarks
114989
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114990
- * @beta
114984
+ * [Api set: PowerPointApi 1.5]
114991
114985
  */
114992
114986
  getParentSlideMasterOrNullObject(): PowerPoint.SlideMaster;
114993
114987
  /**
114994
114988
  * Returns the parent {@link PowerPoint.Slide} object that holds this `Shape`. If this shape does not belong to a `Slide`, an object with an `isNullObject` property set to `true` is returned.
114995
114989
  *
114996
114990
  * @remarks
114997
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
114998
- * @beta
114991
+ * [Api set: PowerPointApi 1.5]
114999
114992
  */
115000
114993
  getParentSlideOrNullObject(): PowerPoint.Slide;
115001
114994
  /**
@@ -115029,8 +115022,7 @@ declare namespace PowerPoint {
115029
115022
  * Represents a collection of shapes.
115030
115023
  *
115031
115024
  * @remarks
115032
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115033
- * @beta
115025
+ * [Api set: PowerPointApi 1.5]
115034
115026
  */
115035
115027
  class ShapeScopedCollection extends OfficeExtension.ClientObject {
115036
115028
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -115041,8 +115033,7 @@ declare namespace PowerPoint {
115041
115033
  * Gets the number of shapes in the collection.
115042
115034
  *
115043
115035
  * @remarks
115044
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115045
- * @beta
115036
+ * [Api set: PowerPointApi 1.5]
115046
115037
  * @returns The number of shapes in the collection.
115047
115038
  */
115048
115039
  getCount(): OfficeExtension.ClientResult<number>;
@@ -115050,8 +115041,7 @@ declare namespace PowerPoint {
115050
115041
  * Gets a shape using its unique ID. An error is thrown if the shape does not exist.
115051
115042
  *
115052
115043
  * @remarks
115053
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115054
- * @beta
115044
+ * [Api set: PowerPointApi 1.5]
115055
115045
  *
115056
115046
  * @param key The ID of the shape.
115057
115047
  * @returns The shape with the unique ID. If such a shape does not exist, an error is thrown.
@@ -115061,8 +115051,7 @@ declare namespace PowerPoint {
115061
115051
  * Gets a shape using its zero-based index in the collection. An error is thrown if the index is out of range.
115062
115052
  *
115063
115053
  * @remarks
115064
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115065
- * @beta
115054
+ * [Api set: PowerPointApi 1.5]
115066
115055
  *
115067
115056
  * @param index The index of the shape in the collection.
115068
115057
  * @returns The shape at the given index. An error is thrown if index is out of range.
@@ -115072,8 +115061,7 @@ declare namespace PowerPoint {
115072
115061
  * Gets a shape using its unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
115073
115062
  *
115074
115063
  * @remarks
115075
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115076
- * @beta
115064
+ * [Api set: PowerPointApi 1.5]
115077
115065
  *
115078
115066
  * @param id The ID of the shape.
115079
115067
  * @returns The shape with the unique ID. If such a shape does not exist, an object with an `isNullObject` property set to true is returned.
@@ -115192,8 +115180,7 @@ declare namespace PowerPoint {
115192
115180
  * Represents a collection of slides in the presentation.
115193
115181
  *
115194
115182
  * @remarks
115195
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115196
- * @beta
115183
+ * [Api set: PowerPointApi 1.5]
115197
115184
  */
115198
115185
  class SlideScopedCollection extends OfficeExtension.ClientObject {
115199
115186
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -115204,8 +115191,7 @@ declare namespace PowerPoint {
115204
115191
  * Gets the number of slides in the collection.
115205
115192
  *
115206
115193
  * @remarks
115207
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115208
- * @beta
115194
+ * [Api set: PowerPointApi 1.5]
115209
115195
  * @returns The number of slides in the collection.
115210
115196
  */
115211
115197
  getCount(): OfficeExtension.ClientResult<number>;
@@ -115213,8 +115199,7 @@ declare namespace PowerPoint {
115213
115199
  * Gets a slide using its unique ID.
115214
115200
  *
115215
115201
  * @remarks
115216
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115217
- * @beta
115202
+ * [Api set: PowerPointApi 1.5]
115218
115203
  *
115219
115204
  * @param key The ID of the slide.
115220
115205
  * @returns The slide with the unique ID. If such a slide does not exist, an error is thrown.
@@ -115224,8 +115209,7 @@ declare namespace PowerPoint {
115224
115209
  * Gets a slide using its zero-based index in the collection.
115225
115210
  *
115226
115211
  * @remarks
115227
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115228
- * @beta
115212
+ * [Api set: PowerPointApi 1.5]
115229
115213
  *
115230
115214
  * @param index The index of the slide in the collection.
115231
115215
  * @returns The slide at the given index. An error is thrown if index is out of range.
@@ -115237,8 +115221,7 @@ declare namespace PowerPoint {
115237
115221
  and properties}.
115238
115222
  *
115239
115223
  * @remarks
115240
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115241
- * @beta
115224
+ * [Api set: PowerPointApi 1.5]
115242
115225
  *
115243
115226
  * @param id The ID of the slide.
115244
115227
  * @returns The slide with the unique ID.
@@ -115515,8 +115498,7 @@ declare namespace PowerPoint {
115515
115498
  Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
115516
115499
  *
115517
115500
  * @remarks
115518
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115519
- * @beta
115501
+ * [Api set: PowerPointApi 1.5]
115520
115502
  */
115521
115503
  length?: number;
115522
115504
  /**
@@ -115524,8 +115506,7 @@ declare namespace PowerPoint {
115524
115506
  Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
115525
115507
  *
115526
115508
  * @remarks
115527
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115528
- * @beta
115509
+ * [Api set: PowerPointApi 1.5]
115529
115510
  */
115530
115511
  start?: number;
115531
115512
  /**
@@ -115860,8 +115841,7 @@ declare namespace PowerPoint {
115860
115841
  Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
115861
115842
  *
115862
115843
  * @remarks
115863
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115864
- * @beta
115844
+ * [Api set: PowerPointApi 1.5]
115865
115845
  */
115866
115846
  length?: number;
115867
115847
  /**
@@ -115869,8 +115849,7 @@ declare namespace PowerPoint {
115869
115849
  Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
115870
115850
  *
115871
115851
  * @remarks
115872
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
115873
- * @beta
115852
+ * [Api set: PowerPointApi 1.5]
115874
115853
  */
115875
115854
  start?: number;
115876
115855
  /**
@@ -116480,8 +116459,7 @@ declare namespace PowerPoint {
116480
116459
  Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the available text from the starting point.
116481
116460
  *
116482
116461
  * @remarks
116483
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
116484
- * @beta
116462
+ * [Api set: PowerPointApi 1.5]
116485
116463
  */
116486
116464
  length?: boolean;
116487
116465
  /**
@@ -116489,8 +116467,7 @@ declare namespace PowerPoint {
116489
116467
  Throws an `InvalidArgument` exception when set with a negative value or if the value is greater than the length of the text.
116490
116468
  *
116491
116469
  * @remarks
116492
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
116493
- * @beta
116470
+ * [Api set: PowerPointApi 1.5]
116494
116471
  */
116495
116472
  start?: boolean;
116496
116473
  /**
@@ -116662,8 +116639,7 @@ declare namespace PowerPoint {
116662
116639
  * Represents a collection of shapes.
116663
116640
  *
116664
116641
  * @remarks
116665
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
116666
- * @beta
116642
+ * [Api set: PowerPointApi 1.3]
116667
116643
  */
116668
116644
  interface ShapeScopedCollectionLoadOptions {
116669
116645
  /**
@@ -116778,8 +116754,7 @@ declare namespace PowerPoint {
116778
116754
  * Represents a collection of slides in the presentation.
116779
116755
  *
116780
116756
  * @remarks
116781
- * [Api set: PowerPointApi BETA (PREVIEW ONLY)]
116782
- * @beta
116757
+ * [Api set: PowerPointApi 1.2]
116783
116758
  */
116784
116759
  interface SlideScopedCollectionLoadOptions {
116785
116760
  /**
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.351",
3
+ "version": "1.0.353",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "df74d61455830cbba62b9f1ab887663f47ecd9ecab876a532da96cab927fae65",
48
+ "typesPublisherContentHash": "d68bf7be647e7a31d46e504dd63fb2fa5f2984d7e119a294f8ac1aee58fb1c72",
49
49
  "typeScriptVersion": "4.1"
50
50
  }