@types/office-js-preview 1.0.321 → 1.0.324

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.
@@ -8533,7 +8533,7 @@ declare namespace Office {
8533
8533
  Preset24
8534
8534
  }
8535
8535
  /**
8536
- * Compose type.
8536
+ * Specifies a message's compose type.
8537
8537
  *
8538
8538
  * @remarks
8539
8539
  * [Api set: Mailbox 1.10]
@@ -19908,7 +19908,7 @@ declare namespace Excel {
19908
19908
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19909
19909
  * @beta
19910
19910
  */
19911
- icon?: string;
19911
+ icon?: string | EntityCompactLayoutIcons;
19912
19912
  }
19913
19913
  /**
19914
19914
  * Represents the layout used when there is limited space to represent the entity.
@@ -19919,6 +19919,455 @@ declare namespace Excel {
19919
19919
  */
19920
19920
  type CompactLayout = EntityCompactLayout;
19921
19921
  /**
19922
+ * The list of icons available for `EntityCompactLayout`. An icon displays in the Excel UI, either to the left of the title in a cell that contains an entity card, or to the left of the title of a referenced entity inside an entity card. Selecting the icon opens the entity card.
19923
+ *
19924
+ * @remarks
19925
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19926
+ * @beta
19927
+ */
19928
+ enum EntityCompactLayoutIcons {
19929
+ /**
19930
+ * The default icon.
19931
+ *
19932
+ * @remarks
19933
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19934
+ * @beta
19935
+ */
19936
+ generic = "Generic",
19937
+ /**
19938
+ * Airplane icon.
19939
+ *
19940
+ * @remarks
19941
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19942
+ * @beta
19943
+ */
19944
+ airplane = "Airplane",
19945
+ /**
19946
+ * Animal icon. Displays as a pawprint.
19947
+ *
19948
+ * @remarks
19949
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19950
+ * @beta
19951
+ */
19952
+ animal = "Animal",
19953
+ /**
19954
+ * Apple icon.
19955
+ *
19956
+ * @remarks
19957
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19958
+ * @beta
19959
+ */
19960
+ apple = "Apple",
19961
+ /**
19962
+ * Art icon. Displays as a paint palette.
19963
+ *
19964
+ * @remarks
19965
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19966
+ * @beta
19967
+ */
19968
+ art = "Art",
19969
+ /**
19970
+ * Atom icon.
19971
+ *
19972
+ * @remarks
19973
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19974
+ * @beta
19975
+ */
19976
+ atom = "Atom",
19977
+ /**
19978
+ * Bank icon. Displays as a building with pillars and a triangular roof.
19979
+ *
19980
+ * @remarks
19981
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19982
+ * @beta
19983
+ */
19984
+ bank = "Bank",
19985
+ /**
19986
+ * Basketball icon.
19987
+ *
19988
+ * @remarks
19989
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19990
+ * @beta
19991
+ */
19992
+ basketball = "Basketball",
19993
+ /**
19994
+ * Beaker icon.
19995
+ *
19996
+ * @remarks
19997
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
19998
+ * @beta
19999
+ */
20000
+ beaker = "Beaker",
20001
+ /**
20002
+ * Bird icon.
20003
+ *
20004
+ * @remarks
20005
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20006
+ * @beta
20007
+ */
20008
+ bird = "Bird",
20009
+ /**
20010
+ * Book icon.
20011
+ *
20012
+ * @remarks
20013
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20014
+ * @beta
20015
+ */
20016
+ book = "Book",
20017
+ /**
20018
+ * Bridge icon.
20019
+ *
20020
+ * @remarks
20021
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20022
+ * @beta
20023
+ */
20024
+ bridge = "Bridge",
20025
+ /**
20026
+ * Briefcase icon.
20027
+ *
20028
+ * @remarks
20029
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20030
+ * @beta
20031
+ */
20032
+ briefcase = "Briefcase",
20033
+ /**
20034
+ * Car icon.
20035
+ *
20036
+ * @remarks
20037
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20038
+ * @beta
20039
+ */
20040
+ car = "Car",
20041
+ /**
20042
+ * Cat icon.
20043
+ *
20044
+ * @remarks
20045
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20046
+ * @beta
20047
+ */
20048
+ cat = "Cat",
20049
+ /**
20050
+ * City icon. Displays as multiple tall buildings.
20051
+ *
20052
+ * @remarks
20053
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20054
+ * @beta
20055
+ */
20056
+ city = "City",
20057
+ /**
20058
+ * Cloud icon.
20059
+ *
20060
+ * @remarks
20061
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20062
+ * @beta
20063
+ */
20064
+ cloud = "Cloud",
20065
+ /**
20066
+ * Constellation icon. Displays dots in the shape of Ursa Major.
20067
+ *
20068
+ * @remarks
20069
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20070
+ * @beta
20071
+ */
20072
+ constellation = "Constellation",
20073
+ /**
20074
+ * Dinosaur icon. Displays as a long-necked dinosaur, similar to a Brachiosaurus.
20075
+ *
20076
+ * @remarks
20077
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20078
+ * @beta
20079
+ */
20080
+ dinosaur = "Dinosaur",
20081
+ /**
20082
+ * Disaster icon. Displays as a house sinking in a flood.
20083
+ *
20084
+ * @remarks
20085
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20086
+ * @beta
20087
+ */
20088
+ disaster = "Disaster",
20089
+ /**
20090
+ * DNA icon.
20091
+ *
20092
+ * @remarks
20093
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20094
+ * @beta
20095
+ */
20096
+ dNA = "DNA",
20097
+ /**
20098
+ * Dog icon.
20099
+ *
20100
+ * @remarks
20101
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20102
+ * @beta
20103
+ */
20104
+ dog = "Dog",
20105
+ /**
20106
+ * Drama icon. Displays as a pair of theatre masks.
20107
+ *
20108
+ * @remarks
20109
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20110
+ * @beta
20111
+ */
20112
+ drama = "Drama",
20113
+ /**
20114
+ * First aid icon. Displays as a briefcase with a medical cross symbol.
20115
+ *
20116
+ * @remarks
20117
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20118
+ * @beta
20119
+ */
20120
+ firstAid = "FirstAid",
20121
+ /**
20122
+ * Galaxy icon.
20123
+ *
20124
+ * @remarks
20125
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20126
+ * @beta
20127
+ */
20128
+ galaxy = "Galaxy",
20129
+ /**
20130
+ * Graduation hat icon. Displays as a hat with a tassel.
20131
+ *
20132
+ * @remarks
20133
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20134
+ * @beta
20135
+ */
20136
+ hatGraduation = "HatGraduation",
20137
+ /**
20138
+ * Human heart icon.
20139
+ *
20140
+ * @remarks
20141
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20142
+ * @beta
20143
+ */
20144
+ heartHuman = "HeartHuman",
20145
+ /**
20146
+ * Justice icon. Displays as the scales of justice.
20147
+ *
20148
+ * @remarks
20149
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20150
+ * @beta
20151
+ */
20152
+ justice = "Justice",
20153
+ /**
20154
+ * Languages icon. Displays as a document and a globe.
20155
+ *
20156
+ * @remarks
20157
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20158
+ * @beta
20159
+ */
20160
+ languages = "Languages",
20161
+ /**
20162
+ * Leaf icon.
20163
+ *
20164
+ * @remarks
20165
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20166
+ * @beta
20167
+ */
20168
+ leaf = "Leaf",
20169
+ /**
20170
+ * Location icon. Displays as a map marker.
20171
+ *
20172
+ * @remarks
20173
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20174
+ * @beta
20175
+ */
20176
+ location = "Location",
20177
+ /**
20178
+ * Map icon.
20179
+ *
20180
+ * @remarks
20181
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20182
+ * @beta
20183
+ */
20184
+ map = "Map",
20185
+ /**
20186
+ * Map pin icon.
20187
+ *
20188
+ * @remarks
20189
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20190
+ * @beta
20191
+ */
20192
+ mapPin = "MapPin",
20193
+ /**
20194
+ * Microscope icon.
20195
+ *
20196
+ * @remarks
20197
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20198
+ * @beta
20199
+ */
20200
+ microscope = "Microscope",
20201
+ /**
20202
+ * Money icon. Displays as paper money and coins.
20203
+ *
20204
+ * @remarks
20205
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20206
+ * @beta
20207
+ */
20208
+ money = "Money",
20209
+ /**
20210
+ * Mountain icon.
20211
+ *
20212
+ * @remarks
20213
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20214
+ * @beta
20215
+ */
20216
+ mountain = "Mountain",
20217
+ /**
20218
+ * Movie camera icon. Displays as a video camera.
20219
+ *
20220
+ * @remarks
20221
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20222
+ * @beta
20223
+ */
20224
+ movieCamera = "MovieCamera",
20225
+ /**
20226
+ * Music note icon.
20227
+ *
20228
+ * @remarks
20229
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20230
+ * @beta
20231
+ */
20232
+ musicNote = "MusicNote",
20233
+ /**
20234
+ * N by one icon. Displays as a three by one grid.
20235
+ *
20236
+ * @remarks
20237
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20238
+ * @beta
20239
+ */
20240
+ nByOne = "NByOne",
20241
+ /**
20242
+ * N by N icon. Displays as a three by three grid.
20243
+ *
20244
+ * @remarks
20245
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20246
+ * @beta
20247
+ */
20248
+ nByN = "NByN",
20249
+ /**
20250
+ * Notable people icon.
20251
+ *
20252
+ * @remarks
20253
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20254
+ * @beta
20255
+ */
20256
+ notablePeople = "NotablePeople",
20257
+ /**
20258
+ * Notebook icon.
20259
+ *
20260
+ * @remarks
20261
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20262
+ * @beta
20263
+ */
20264
+ notebook = "Notebook",
20265
+ /**
20266
+ * One by one icon. Displays as a one by one grid.
20267
+ *
20268
+ * @remarks
20269
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20270
+ * @beta
20271
+ */
20272
+ oneByOne = "OneByOne",
20273
+ /**
20274
+ * One by N icon. Displays as a one by three grid.
20275
+ *
20276
+ * @remarks
20277
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20278
+ * @beta
20279
+ */
20280
+ oneByN = "OneByN",
20281
+ /**
20282
+ * Partly sunny weather icon.
20283
+ *
20284
+ * @remarks
20285
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20286
+ * @beta
20287
+ */
20288
+ partlySunnyWeather = "PartlySunnyWeather",
20289
+ /**
20290
+ * Person icon.
20291
+ *
20292
+ * @remarks
20293
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20294
+ * @beta
20295
+ */
20296
+ person = "Person",
20297
+ /**
20298
+ * Pilates icon.
20299
+ *
20300
+ * @remarks
20301
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20302
+ * @beta
20303
+ */
20304
+ pilates = "Pilates",
20305
+ /**
20306
+ * Planet icon.
20307
+ *
20308
+ * @remarks
20309
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20310
+ * @beta
20311
+ */
20312
+ planet = "Planet",
20313
+ /**
20314
+ * Point scan icon. Displays as a target focus symbol.
20315
+ *
20316
+ * @remarks
20317
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20318
+ * @beta
20319
+ */
20320
+ pointScan = "PointScan",
20321
+ /**
20322
+ * Running icon.
20323
+ *
20324
+ * @remarks
20325
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20326
+ * @beta
20327
+ */
20328
+ running = "Running",
20329
+ /**
20330
+ * Satellite icon.
20331
+ *
20332
+ * @remarks
20333
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20334
+ * @beta
20335
+ */
20336
+ satellite = "Satellite",
20337
+ /**
20338
+ * Syringe icon.
20339
+ *
20340
+ * @remarks
20341
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20342
+ * @beta
20343
+ */
20344
+ syringe = "Syringe",
20345
+ /**
20346
+ * Violin icon.
20347
+ *
20348
+ * @remarks
20349
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20350
+ * @beta
20351
+ */
20352
+ violin = "Violin",
20353
+ /**
20354
+ * Wand icon.
20355
+ *
20356
+ * @remarks
20357
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20358
+ * @beta
20359
+ */
20360
+ wand = "Wand",
20361
+ /**
20362
+ * Yoga icon.
20363
+ *
20364
+ * @remarks
20365
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20366
+ * @beta
20367
+ */
20368
+ yoga = "Yoga"
20369
+ }
20370
+ /**
19922
20371
  * Represents a reference into `referencedValues`. One scenario for using this reference is to avoid duplicating cell value objects (such as an `EntityCellValue`). Define a cell value object once in `referencedValues`, and then refer to that cell value from many places by using a `ReferenceCellValue` where the duplicated value would have appeared.
19923
20372
  *
19924
20373
  * @remarks
@@ -20994,15 +21443,7 @@ declare namespace Excel {
20994
21443
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
20995
21444
  * @beta
20996
21445
  */
20997
- unknown = "Unknown",
20998
- /**
20999
- * An error returned by the Python interpreter as a result of running the Python code. Displays as error type #EXTERNAL! in Excel.
21000
- *
21001
- * @remarks
21002
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
21003
- * @beta
21004
- */
21005
- pythonError = "PythonError"
21446
+ unknown = "Unknown"
21006
21447
  }
21007
21448
  /**
21008
21449
  * Represents the value of a cell containing an #EXTERNAL! error.
@@ -21053,7 +21494,7 @@ declare namespace Excel {
21053
21494
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
21054
21495
  * @beta
21055
21496
  */
21056
- errorSubType?: ExternalErrorCellValueSubType | "Unknown" | "PythonError";
21497
+ errorSubType?: ExternalErrorCellValueSubType | "Unknown";
21057
21498
  }
21058
21499
  /**
21059
21500
  * Represents types of #FIELD! errors.
@@ -22865,8 +23306,7 @@ declare namespace Excel {
22865
23306
  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.
22866
23307
  *
22867
23308
  * @remarks
22868
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
22869
- * @beta
23309
+ * [Api set: ExcelApiOnline 1.1]
22870
23310
  */
22871
23311
  class AllowEditRange extends OfficeExtension.ClientObject {
22872
23312
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -22877,16 +23317,14 @@ declare namespace Excel {
22877
23317
  If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
22878
23318
  *
22879
23319
  * @remarks
22880
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
22881
- * @beta
23320
+ * [Api set: ExcelApiOnline 1.1]
22882
23321
  */
22883
23322
  address: string;
22884
23323
  /**
22885
- * Specifies if the `AllowEditRange` is password protected.
23324
+ * Specifies if the object is password protected.
22886
23325
  *
22887
23326
  * @remarks
22888
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
22889
- * @beta
23327
+ * [Api set: ExcelApiOnline 1.1]
22890
23328
  */
22891
23329
  readonly isPasswordProtected: boolean;
22892
23330
  /**
@@ -22896,8 +23334,7 @@ declare namespace Excel {
22896
23334
  If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
22897
23335
  *
22898
23336
  * @remarks
22899
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
22900
- * @beta
23337
+ * [Api set: ExcelApiOnline 1.1]
22901
23338
  */
22902
23339
  title: string;
22903
23340
  /**
@@ -22909,37 +23346,35 @@ declare namespace Excel {
22909
23346
  /** Sets multiple properties on the object at the same time, based on an existing loaded object. */
22910
23347
  set(properties: Excel.AllowEditRange): void;
22911
23348
  /**
22912
- * Deletes this object from the `AllowEditRangeCollection`.
23349
+ * Deletes the object from the `AllowEditRangeCollection`.
22913
23350
  Worksheet protection must be disabled or paused for this method to work properly.
22914
23351
  If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails the delete operation.
22915
23352
  *
22916
23353
  * @remarks
22917
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
22918
- * @beta
23354
+ * [Api set: ExcelApiOnline 1.1]
22919
23355
  */
22920
23356
  delete(): void;
22921
23357
  /**
22922
- * Pauses worksheet protection for the given `AllowEditRange` object for the user in a given session.
22923
- This method only pauses protection for the `AllowEditRange` object if worksheet protection is enabled and not paused.
22924
- If worksheet protection cannot be paused, this method throws an `UnsupportedOperation` error and fails to pause protection for the range.
22925
- If the password is incorrect, then this method throws an `InvalidArgument` error and fails to pause protection for the range.
23358
+ * Pauses worksheet protection for the object for the user in the current session.
23359
+ This method does nothing if worksheet protection isn't enabled or is already paused.
23360
+ If worksheet protection cannot be paused, this method throws an `UnsupportedOperation` error and fails to pause protection for the object.
23361
+ If the password is incorrect, then this method throws a `BadPassword` error and fails to pause protection for the object.
23362
+ If a password is supplied but the object does not require a password, the inputted password will be ignored and the operation will succeed.
22926
23363
  *
22927
23364
  * @remarks
22928
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
22929
- * @beta
23365
+ * [Api set: ExcelApiOnline 1.1]
22930
23366
  *
22931
23367
  * @param password The password associated with the `AllowEditRange` object.
22932
23368
  */
22933
23369
  pauseProtection(password?: string): void;
22934
23370
  /**
22935
- * Changes the password associated with the `AllowEditRange`.
22936
- Setting the password string as empty ("") or `null` will remove password protection from the `AllowEditRange`.
23371
+ * Changes the password associated with the object.
23372
+ Setting the password string as empty ("") or `null` will remove password protection from the object.
22937
23373
  Worksheet protection must be disabled or paused for this method to work properly.
22938
23374
  If worksheet protection is enabled and not paused, then this method throws an `AccessDenied` error and the set operation fails.
22939
23375
  *
22940
23376
  * @remarks
22941
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
22942
- * @beta
23377
+ * [Api set: ExcelApiOnline 1.1]
22943
23378
  *
22944
23379
  * @param password The password associated with the `AllowEditRange` object.
22945
23380
  */
@@ -22976,8 +23411,7 @@ declare namespace Excel {
22976
23411
  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.
22977
23412
  *
22978
23413
  * @remarks
22979
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
22980
- * @beta
23414
+ * [Api set: ExcelApiOnline 1.1]
22981
23415
  */
22982
23416
  class AllowEditRangeCollection extends OfficeExtension.ClientObject {
22983
23417
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
@@ -22985,13 +23419,12 @@ declare namespace Excel {
22985
23419
  /** Gets the loaded child items in this collection. */
22986
23420
  readonly items: Excel.AllowEditRange[];
22987
23421
  /**
22988
- * Adds an `AllowEditRange` object to the collection.
23422
+ * Adds an `AllowEditRange` object to the worksheet.
22989
23423
  Worksheet protection must be disabled or paused for this method to work properly.
22990
23424
  If worksheet protection is enabled and not paused, then this method throws an `AccessDenied` error and the add operation fails.
22991
23425
  *
22992
23426
  * @remarks
22993
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
22994
- * @beta
23427
+ * [Api set: ExcelApiOnline 1.1]
22995
23428
  *
22996
23429
  * @param title The title string of the `AllowEditRange` object to be added.
22997
23430
  * @param rangeAddress The range address of the `AllowEditRange` object to be added.
@@ -23002,16 +23435,14 @@ declare namespace Excel {
23002
23435
  * Returns the number of `AllowEditRange` objects in the collection.
23003
23436
  *
23004
23437
  * @remarks
23005
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23006
- * @beta
23438
+ * [Api set: ExcelApiOnline 1.1]
23007
23439
  */
23008
23440
  getCount(): OfficeExtension.ClientResult<number>;
23009
23441
  /**
23010
23442
  * Gets the `AllowEditRange` object by its title.
23011
23443
  *
23012
23444
  * @remarks
23013
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23014
- * @beta
23445
+ * [Api set: ExcelApiOnline 1.1]
23015
23446
  *
23016
23447
  * @param key The title of the `AllowEditRange`.
23017
23448
  * @returns The `AllowEditRange` with the title. If there is no `AllowEditRange` with the given title, then an `ItemNotFound` error is thrown.
@@ -23021,8 +23452,7 @@ declare namespace Excel {
23021
23452
  * Returns an `AllowEditRange` object by its index in the collection.
23022
23453
  *
23023
23454
  * @remarks
23024
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23025
- * @beta
23455
+ * [Api set: ExcelApiOnline 1.1]
23026
23456
  *
23027
23457
  * @param index The index of the `AllowEditRange` object in the collection.
23028
23458
  * @returns The `AllowEditRange` at the given index.
@@ -23032,22 +23462,20 @@ declare namespace Excel {
23032
23462
  * Gets the `AllowEditRange` object by its title.
23033
23463
  *
23034
23464
  * @remarks
23035
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23036
- * @beta
23465
+ * [Api set: ExcelApiOnline 1.1]
23037
23466
  *
23038
23467
  * @param key The title of the `AllowEditRange`.
23039
23468
  * @returns The `AllowEditRange` with the title. If there is no `AllowEditRange` with the given title, then this method returns an object with its `isNullObject` property set to `true`. For further information, see {@link https://docs.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties | *OrNullObject methods and properties}.
23040
23469
  */
23041
23470
  getItemOrNullObject(key: string): Excel.AllowEditRange;
23042
23471
  /**
23043
- * Pauses worksheet protection for all `AllowEditRange` objects in the collection that have the given password for the user in a given session.
23044
- This method only pauses protection for the `AllowEditRange` objects if worksheet protection is enabled and not paused.
23472
+ * Pauses worksheet protection for all `AllowEditRange` objects found in this worksheet that have the given password for the user in the current session.
23473
+ This method does nothing if worksheet protection isn't enabled or is paused.
23045
23474
  If worksheet protection cannot be paused, this method throws an `UnsupportedOperation` error and fails to pause protection for the range.
23046
23475
  If the password does not match any `AllowEditRange` objects in the collection, then this method throws a `BadPassword` error and fails to pause protection for any range in the collection.
23047
23476
  *
23048
23477
  * @remarks
23049
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23050
- * @beta
23478
+ * [Api set: ExcelApiOnline 1.1]
23051
23479
  *
23052
23480
  * @param password The password to pause protection on the `AllowEditRange` objects.
23053
23481
  */
@@ -23080,16 +23508,14 @@ declare namespace Excel {
23080
23508
  * The interface used to construct optional fields of the `AllowEditRange` object.
23081
23509
  *
23082
23510
  * @remarks
23083
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23084
- * @beta
23511
+ * [Api set: ExcelApiOnline 1.1]
23085
23512
  */
23086
23513
  interface AllowEditRangeOptions {
23087
23514
  /**
23088
23515
  * The password associated with the `AllowEditRange`.
23089
23516
  *
23090
23517
  * @remarks
23091
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23092
- * @beta
23518
+ * [Api set: ExcelApiOnline 1.1]
23093
23519
  */
23094
23520
  password?: string;
23095
23521
  }
@@ -23596,112 +24022,97 @@ declare namespace Excel {
23596
24022
  automatic = "Automatic"
23597
24023
  }
23598
24024
  /**
23599
- * Represents information about a task's schedule.
24025
+ * Represents the type of change recorded in the task change record.
23600
24026
  *
23601
24027
  * @remarks
23602
24028
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23603
24029
  * @beta
23604
24030
  */
23605
- interface DocumentTaskSchedule {
24031
+ enum DocumentTaskChangeAction {
23606
24032
  /**
23607
- * Gets the date and time that the task is due. All dates are in UTC.
23608
- *
24033
+ * Represents an unknown change type. This value will be returned when the version of Excel running doesn't understand the type of the change record that is in the loaded file.
23609
24034
  * @remarks
23610
24035
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23611
24036
  * @beta
23612
24037
  */
23613
- dueDateTime: Date;
24038
+ unknown = "unknown",
23614
24039
  /**
23615
- * Gets the date and time that the task should start. All dates are in UTC.
23616
- *
24040
+ * Represents the creation of a new task.
23617
24041
  * @remarks
23618
24042
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23619
24043
  * @beta
23620
24044
  */
23621
- startDateTime: Date;
23622
- }
23623
- /**
23624
- * Represents a collection of user identities.
23625
- *
23626
- * @remarks
23627
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23628
- * @beta
23629
- */
23630
- class IdentityCollection extends OfficeExtension.ClientObject {
23631
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
23632
- context: RequestContext;
23633
- /** Gets the loaded child items in this collection. */
23634
- readonly items: Excel.IdentityEntity[];
24045
+ create = "create",
23635
24046
  /**
23636
- * Adds a user identity to the collection.
23637
- *
24047
+ * Represents a user being assigned to a task.
23638
24048
  * @remarks
23639
24049
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23640
24050
  * @beta
23641
- *
23642
- * @param assignee The identity to add to the collection.
23643
24051
  */
23644
- add(assignee: Identity): void;
24052
+ assign = "assign",
23645
24053
  /**
23646
- * Removes all user identities from the collection.
23647
- *
24054
+ * Represents a user being unassigned from a task.
23648
24055
  * @remarks
23649
24056
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23650
24057
  * @beta
23651
24058
  */
23652
- clear(): void;
24059
+ unassign = "unassign",
23653
24060
  /**
23654
- * Gets the number of items in the collection.
23655
- *
24061
+ * Represents all users being unassigned from a task.
23656
24062
  * @remarks
23657
24063
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23658
24064
  * @beta
23659
24065
  */
23660
- getCount(): OfficeExtension.ClientResult<number>;
24066
+ unassignAll = "unassignAll",
23661
24067
  /**
23662
- * Gets a document user identity by using its index in the collection.
23663
- *
24068
+ * Represents an update to a task's `startDateTime` or `dueDateTime`.
23664
24069
  * @remarks
23665
24070
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23666
24071
  * @beta
23667
- *
23668
- * @param index The items in the document user identity collection do not have a particular order.
23669
- * @returns The document user identity at the given index.
23670
24072
  */
23671
- getItemAt(index: number): Excel.IdentityEntity;
24073
+ setSchedule = "setSchedule",
23672
24074
  /**
23673
- * Removes a user identity from the collection.
23674
- *
24075
+ * Represents an update to a task's percentage complete.
23675
24076
  * @remarks
23676
24077
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23677
24078
  * @beta
23678
- *
23679
- * @param assignee The identity to remove from the collection.
23680
24079
  */
23681
- remove(assignee: Identity): void;
24080
+ setPercentComplete = "setPercentComplete",
23682
24081
  /**
23683
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
23684
- *
23685
- * @param options Provides options for which properties of the object to load.
24082
+ * Represents an update to a task's priority.
24083
+ * @remarks
24084
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24085
+ * @beta
23686
24086
  */
23687
- load(options?: Excel.Interfaces.IdentityCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.IdentityCollection;
24087
+ setPriority = "setPriority",
23688
24088
  /**
23689
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
23690
- *
23691
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
24089
+ * Represents the deletion of a task.
24090
+ * @remarks
24091
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24092
+ * @beta
23692
24093
  */
23693
- load(propertyNames?: string | string[]): Excel.IdentityCollection;
24094
+ remove = "remove",
23694
24095
  /**
23695
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
23696
- *
23697
- * @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.
24096
+ * Represents the restoration of a task.
24097
+ * @remarks
24098
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24099
+ * @beta
23698
24100
  */
23699
- load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.IdentityCollection;
24101
+ restore = "restore",
23700
24102
  /**
23701
- * 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 is passed to it.)
23702
- * Whereas the original `Excel.IdentityCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.IdentityCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
23703
- */
23704
- toJSON(): Excel.Interfaces.IdentityCollectionData;
24103
+ * Represents a change in the title of a task.
24104
+ * @remarks
24105
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24106
+ * @beta
24107
+ */
24108
+ setTitle = "setTitle",
24109
+ /**
24110
+ * Represents a previous task action being undone.
24111
+ * @remarks
24112
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24113
+ * @beta
24114
+ */
24115
+ undo = "undo"
23705
24116
  }
23706
24117
  /**
23707
24118
  * Represents a recorded change to the task.
@@ -23714,29 +24125,29 @@ declare namespace Excel {
23714
24125
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
23715
24126
  context: RequestContext;
23716
24127
  /**
23717
- * Represents the user assigned to the task for an `assign` change record type, or the user unassigned from the task for an `unassign` change record type.
24128
+ * Represents the user assigned to the task for an `assign` change action, or the user unassigned from the task for an `unassign` change action.
23718
24129
  *
23719
24130
  * @remarks
23720
24131
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23721
24132
  * @beta
23722
24133
  */
23723
- assignee: Excel.Identity;
24134
+ readonly assignee: Excel.Identity;
23724
24135
  /**
23725
- * Represents the user who created or changed the task.
24136
+ * Represents the identity of the user who made the task change.
23726
24137
  *
23727
24138
  * @remarks
23728
24139
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23729
24140
  * @beta
23730
24141
  */
23731
- changedBy: Excel.Identity;
24142
+ readonly changedBy: Excel.Identity;
23732
24143
  /**
23733
- * Represents the ID of the `Comment` or `CommentReply` to which the task change is anchored.
24144
+ * Represents the ID of the `comment` or `commentReply` to which the task change is anchored.
23734
24145
  *
23735
24146
  * @remarks
23736
24147
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23737
24148
  * @beta
23738
24149
  */
23739
- commentId: string;
24150
+ readonly commentId: string;
23740
24151
  /**
23741
24152
  * Represents the creation date and time of the task change record. All dates are in UTC.
23742
24153
  *
@@ -23744,75 +24155,75 @@ declare namespace Excel {
23744
24155
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23745
24156
  * @beta
23746
24157
  */
23747
- createdDateTime: Date;
24158
+ readonly createdDateTime: Date;
23748
24159
  /**
23749
- * Represents the task's due date and time, in UTC time zone. It is used for the `setSchedule` change record type.
23750
- Can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
24160
+ * Represents the task's due date and time. It is used for the `setSchedule` change action.
24161
+ It is in UTC time zone. It can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
23751
24162
  *
23752
24163
  * @remarks
23753
24164
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23754
24165
  * @beta
23755
24166
  */
23756
- dueDateTime: Date;
24167
+ readonly dueDateTime: Date;
23757
24168
  /**
23758
- * ID for the task change record.
24169
+ * The unique GUID of the task change.
23759
24170
  *
23760
24171
  * @remarks
23761
24172
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23762
24173
  * @beta
23763
24174
  */
23764
- id: string;
24175
+ readonly id: string;
23765
24176
  /**
23766
- * Represents the task's completion percentage. It is used for the `setPercentComplete` change record type.
24177
+ * Represents the task's completion percentage. It is used for the `setPercentComplete` change action.
23767
24178
  This is a value between 0 and 100, where 100 represents a completed task. Changing this value to 100 also completes the associated comment. Changing the completion from 100 to a lower value reactivates the associated comment.
23768
24179
  *
23769
24180
  * @remarks
23770
24181
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23771
24182
  * @beta
23772
24183
  */
23773
- percentComplete: number;
24184
+ readonly percentComplete: number;
23774
24185
  /**
23775
- * Represents the task's priority. It is used for the `setPriority` change record type.
24186
+ * Represents the task's priority. It is used for the `setPriority` change action.
23776
24187
  This is a value between 0 and 10, with 5 being the default priority if not set, and where 0 represents the highest priority.
23777
24188
  *
23778
24189
  * @remarks
23779
24190
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23780
24191
  * @beta
23781
24192
  */
23782
- priority: number;
24193
+ readonly priority: number;
23783
24194
  /**
23784
- * Represents the task's start date and time, in UTC time zone. It is used for the `setSchedule` change record type.
23785
- Can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
24195
+ * Represents the task's start date and time. It is used for the `setSchedule` change action.
24196
+ It is in UTC time zone. It can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
23786
24197
  *
23787
24198
  * @remarks
23788
24199
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23789
24200
  * @beta
23790
24201
  */
23791
- startDateTime: Date;
24202
+ readonly startDateTime: Date;
23792
24203
  /**
23793
- * Represents the task's title. It is used for the `setTitle` change record type.
24204
+ * Represents the task's title. It is used for the `setTitle` change action.
23794
24205
  *
23795
24206
  * @remarks
23796
24207
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23797
24208
  * @beta
23798
24209
  */
23799
- title: string;
24210
+ readonly title: string;
23800
24211
  /**
23801
- * Represents the action type of the task change record. Some examples of action types are `assign`, `undo`, and `setPriority`.
24212
+ * Represents the action type of the task change record. Some examples of action types are assign, undo, and setPriority.
23802
24213
  *
23803
24214
  * @remarks
23804
24215
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23805
24216
  * @beta
23806
24217
  */
23807
- type: Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo";
24218
+ readonly type: Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo";
23808
24219
  /**
23809
- * Represents the `DocumentTaskChange.id` property that was undone for the `undo` change record type.
24220
+ * Represents the `DocumentTaskChange.id` property that was undone for the `undo` change action.
23810
24221
  *
23811
24222
  * @remarks
23812
24223
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23813
24224
  * @beta
23814
24225
  */
23815
- undoHistoryId: string;
24226
+ readonly undoChangeId: string;
23816
24227
  /**
23817
24228
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
23818
24229
  *
@@ -23899,99 +24310,6 @@ declare namespace Excel {
23899
24310
  */
23900
24311
  toJSON(): Excel.Interfaces.DocumentTaskChangeCollectionData;
23901
24312
  }
23902
- /**
23903
- * Represents the type of change recorded in the task change record.
23904
- *
23905
- * @remarks
23906
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23907
- * @beta
23908
- */
23909
- enum DocumentTaskChangeAction {
23910
- /**
23911
- * Represents an unknown change type. This value will be returned when the version of Excel running doesn't understand the type of the change record that is in the loaded file.
23912
- * @remarks
23913
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23914
- * @beta
23915
- */
23916
- unknown = "unknown",
23917
- /**
23918
- * Represents the creation of a new task.
23919
- * @remarks
23920
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23921
- * @beta
23922
- */
23923
- create = "create",
23924
- /**
23925
- * Represents a user being assigned to a task.
23926
- * @remarks
23927
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23928
- * @beta
23929
- */
23930
- assign = "assign",
23931
- /**
23932
- * Represents a user being unassigned from a task.
23933
- * @remarks
23934
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23935
- * @beta
23936
- */
23937
- unassign = "unassign",
23938
- /**
23939
- * Represents all users being unassigned from a task.
23940
- * @remarks
23941
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23942
- * @beta
23943
- */
23944
- unassignAll = "unassignAll",
23945
- /**
23946
- * Represents an update to a task's `startDateTime` or `dueDateTime`.
23947
- * @remarks
23948
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23949
- * @beta
23950
- */
23951
- setSchedule = "setSchedule",
23952
- /**
23953
- * Represents an update to a task's percentage complete.
23954
- * @remarks
23955
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23956
- * @beta
23957
- */
23958
- setPercentComplete = "setPercentComplete",
23959
- /**
23960
- * Represents an update to a task's priority.
23961
- * @remarks
23962
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23963
- * @beta
23964
- */
23965
- setPriority = "setPriority",
23966
- /**
23967
- * Represents the deletion of a task.
23968
- * @remarks
23969
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23970
- * @beta
23971
- */
23972
- remove = "remove",
23973
- /**
23974
- * Represents the restoration of a task.
23975
- * @remarks
23976
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23977
- * @beta
23978
- */
23979
- restore = "restore",
23980
- /**
23981
- * Represents a change in the title of a task.
23982
- * @remarks
23983
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23984
- * @beta
23985
- */
23986
- setTitle = "setTitle",
23987
- /**
23988
- * Represents a previous task action being undone.
23989
- * @remarks
23990
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
23991
- * @beta
23992
- */
23993
- undo = "undo"
23994
- }
23995
24313
  /**
23996
24314
  * Represents information about a user's identity.
23997
24315
  *
@@ -24008,14 +24326,6 @@ declare namespace Excel {
24008
24326
  * @beta
24009
24327
  */
24010
24328
  displayName?: string;
24011
- /**
24012
- * Represents the user's email address.
24013
- *
24014
- * @remarks
24015
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24016
- * @beta
24017
- */
24018
- email?: string;
24019
24329
  /**
24020
24330
  * Represents the user's unique ID.
24021
24331
  *
@@ -24025,71 +24335,6 @@ declare namespace Excel {
24025
24335
  */
24026
24336
  id: string;
24027
24337
  }
24028
- /**
24029
- * Represents information about a user's identity.
24030
- *
24031
- * @remarks
24032
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24033
- * @beta
24034
- */
24035
- class IdentityEntity extends OfficeExtension.ClientObject {
24036
- /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
24037
- context: RequestContext;
24038
- /**
24039
- * Represents the user's display name.
24040
- *
24041
- * @remarks
24042
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24043
- * @beta
24044
- */
24045
- displayName: string;
24046
- /**
24047
- * Represents the user's email address.
24048
- *
24049
- * @remarks
24050
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24051
- * @beta
24052
- */
24053
- email: string;
24054
- /**
24055
- * Represents the user's unique ID.
24056
- *
24057
- * @remarks
24058
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24059
- * @beta
24060
- */
24061
- id: string;
24062
- /**
24063
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
24064
- *
24065
- * @param options Provides options for which properties of the object to load.
24066
- */
24067
- load(options?: Excel.Interfaces.IdentityEntityLoadOptions): Excel.IdentityEntity;
24068
- /**
24069
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
24070
- *
24071
- * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load.
24072
- */
24073
- load(propertyNames?: string | string[]): Excel.IdentityEntity;
24074
- /**
24075
- * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
24076
- *
24077
- * @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.
24078
- */
24079
- load(propertyNamesAndPaths?: {
24080
- select?: string;
24081
- expand?: string;
24082
- }): Excel.IdentityEntity;
24083
- /**
24084
- * Create a new instance of Excel.IdentityEntity object
24085
- */
24086
- static newObject(context: OfficeExtension.ClientRequestContext): Excel.IdentityEntity;
24087
- /**
24088
- * 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 is passed to it.)
24089
- * Whereas the original Excel.IdentityEntity object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Excel.Interfaces.IdentityEntityData`) that contains shallow copies of any loaded child properties from the original object.
24090
- */
24091
- toJSON(): Excel.Interfaces.IdentityEntityData;
24092
- }
24093
24338
  /**
24094
24339
  * Represents a task.
24095
24340
  *
@@ -24101,29 +24346,29 @@ declare namespace Excel {
24101
24346
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
24102
24347
  context: RequestContext;
24103
24348
  /**
24104
- * Returns a collection of assignees of the task.
24349
+ * Gets the change records of the task.
24105
24350
  *
24106
24351
  * @remarks
24107
24352
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24108
24353
  * @beta
24109
24354
  */
24110
- readonly assignees: Excel.IdentityCollection;
24355
+ readonly changes: Excel.DocumentTaskChangeCollection;
24111
24356
  /**
24112
- * Gets the change records of the task.
24357
+ * Gets the comment associated with the task.
24113
24358
  *
24114
24359
  * @remarks
24115
24360
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24116
24361
  * @beta
24117
24362
  */
24118
- readonly changes: Excel.DocumentTaskChangeCollection;
24363
+ readonly comment: Excel.Comment;
24119
24364
  /**
24120
- * Gets the comment associated with the task.
24365
+ * Returns a collection of assignees of the task.
24121
24366
  *
24122
24367
  * @remarks
24123
24368
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24124
24369
  * @beta
24125
24370
  */
24126
- readonly comment: Excel.Comment;
24371
+ readonly assignees: Excel.Identity[];
24127
24372
  /**
24128
24373
  * Gets the most recent user to have completed the task.
24129
24374
  *
@@ -24156,6 +24401,15 @@ declare namespace Excel {
24156
24401
  * @beta
24157
24402
  */
24158
24403
  readonly createdDateTime: Date;
24404
+ /**
24405
+ * Gets or sets the date and time the task is due.
24406
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
24407
+ *
24408
+ * @remarks
24409
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24410
+ * @beta
24411
+ */
24412
+ dueDateTime: Date;
24159
24413
  /**
24160
24414
  * Gets the ID of the task.
24161
24415
  *
@@ -24181,13 +24435,14 @@ declare namespace Excel {
24181
24435
  */
24182
24436
  priority: number;
24183
24437
  /**
24184
- * Gets or sets the date and time the task should start and is due.
24438
+ * Gets or sets the date and time the task starts.
24439
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
24185
24440
  *
24186
24441
  * @remarks
24187
24442
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24188
24443
  * @beta
24189
24444
  */
24190
- startAndDueDateTime: Excel.DocumentTaskSchedule;
24445
+ startDateTime: Date;
24191
24446
  /**
24192
24447
  * Specifies title of the task.
24193
24448
  *
@@ -24197,16 +24452,33 @@ declare namespace Excel {
24197
24452
  */
24198
24453
  title: string;
24199
24454
  /**
24200
- * Changes the start and the due dates of the task.
24455
+ * Adds the given user to the list of assignees attached to the task.
24456
+ *
24457
+ * @remarks
24458
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24459
+ * @beta
24460
+ *
24461
+ * @param assignee The identity of the user to add to the assignee list.
24462
+ */
24463
+ assign(assignee: Excel.Identity): void;
24464
+ /**
24465
+ * Removes the given user from the list of assignees attached to the task.
24201
24466
  *
24202
24467
  * @remarks
24203
24468
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24204
24469
  * @beta
24205
24470
  *
24206
- * @param startDateTime Represents the start date and time of the task in UTC time zone. Can be set to `null` to remove the start date and time.
24207
- * @param dueDateTime Represents the due date and time of the task in UTC time zone. Can be set to `null` to remove the due date and time.
24471
+ * @param assignee The identity of the user to remove from the assignee list.
24472
+ */
24473
+ unassign(assignee: Excel.Identity): void;
24474
+ /**
24475
+ * Removes all users from the list of assignees attached to the task.
24476
+ *
24477
+ * @remarks
24478
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
24479
+ * @beta
24208
24480
  */
24209
- setStartAndDueDateTime(startDateTime: Date, dueDateTime: Date): void;
24481
+ unassignAll(): void;
24210
24482
  /**
24211
24483
  * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties.
24212
24484
  *
@@ -26413,6 +26685,24 @@ declare namespace Excel {
26413
26685
  * [Api set: ExcelApi 1.9]
26414
26686
  */
26415
26687
  valueAfter: any;
26688
+ /**
26689
+ * Represents the type of value after the change.
26690
+ Unlike `valueAfter`, `valueAsJsonAfter` can represent all cell values, such as formatted number, web image, and entity data types.
26691
+ *
26692
+ * @remarks
26693
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
26694
+ * @beta
26695
+ */
26696
+ valueAsJsonAfter: CellValue;
26697
+ /**
26698
+ * Represents the type of value before the change.
26699
+ Unlike `valueBefore`, `valueAsJsonBefore` can represent all cell values, such as formatted number, web image, and entity data types.
26700
+ *
26701
+ * @remarks
26702
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
26703
+ * @beta
26704
+ */
26705
+ valueAsJsonBefore: CellValue;
26416
26706
  /**
26417
26707
  * Represents the value before the change. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string.
26418
26708
  *
@@ -26748,8 +27038,7 @@ declare namespace Excel {
26748
27038
  * Specifies if any of the `AllowEditRange` objects have changed.
26749
27039
  *
26750
27040
  * @remarks
26751
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
26752
- * @beta
27041
+ * [Api set: ExcelApiOnline 1.1]
26753
27042
  */
26754
27043
  allowEditRangesChanged: boolean;
26755
27044
  /**
@@ -26763,16 +27052,14 @@ declare namespace Excel {
26763
27052
  * Specifies if the `WorksheetProtectionOptions` have changed.
26764
27053
  *
26765
27054
  * @remarks
26766
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
26767
- * @beta
27055
+ * [Api set: ExcelApiOnline 1.1]
26768
27056
  */
26769
27057
  protectionOptionsChanged: boolean;
26770
27058
  /**
26771
27059
  * Specifies if the worksheet password has changed.
26772
27060
  *
26773
27061
  * @remarks
26774
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
26775
- * @beta
27062
+ * [Api set: ExcelApiOnline 1.1]
26776
27063
  */
26777
27064
  sheetPasswordChanged: boolean;
26778
27065
  /**
@@ -29227,32 +29514,28 @@ declare namespace Excel {
29227
29514
  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.
29228
29515
  *
29229
29516
  * @remarks
29230
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29231
- * @beta
29517
+ * [Api set: ExcelApiOnline 1.1]
29232
29518
  */
29233
29519
  readonly allowEditRanges: Excel.AllowEditRangeCollection;
29234
29520
  /**
29235
29521
  * Specifies if protection can be paused for this worksheet.
29236
29522
  *
29237
29523
  * @remarks
29238
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29239
- * @beta
29524
+ * [Api set: ExcelApiOnline 1.1]
29240
29525
  */
29241
29526
  readonly canPauseProtection: boolean;
29242
29527
  /**
29243
29528
  * Specifies if the sheet is password protected.
29244
29529
  *
29245
29530
  * @remarks
29246
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29247
- * @beta
29531
+ * [Api set: ExcelApiOnline 1.1]
29248
29532
  */
29249
29533
  readonly isPasswordProtected: boolean;
29250
29534
  /**
29251
29535
  * Specifies if worksheet protection is paused.
29252
29536
  *
29253
29537
  * @remarks
29254
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29255
- * @beta
29538
+ * [Api set: ExcelApiOnline 1.1]
29256
29539
  */
29257
29540
  readonly isPaused: boolean;
29258
29541
  /**
@@ -29270,34 +29553,33 @@ declare namespace Excel {
29270
29553
  */
29271
29554
  readonly protected: boolean;
29272
29555
  /**
29273
- * Specifies the protection options settings saved in the worksheet.
29556
+ * Specifies the protection options saved in the worksheet.
29274
29557
  This will return the same `WorksheetProtectionOptions` object regardless of the worksheet protection state.
29275
29558
  *
29276
29559
  * @remarks
29277
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29278
- * @beta
29560
+ * [Api set: ExcelApiOnline 1.1]
29279
29561
  */
29280
29562
  readonly savedOptions: Excel.WorksheetProtectionOptions;
29281
29563
  /**
29282
29564
  * Specifies if the password can be used to unlock worksheet protection.
29283
- This method does not change the worksheet protection state.
29565
+ This method doesn't change the worksheet protection state.
29566
+ If a password is input but no password is required to unlock worksheet protection, this method will return false.
29284
29567
  *
29285
29568
  * @remarks
29286
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29287
- * @beta
29569
+ * [Api set: ExcelApiOnline 1.1]
29288
29570
  *
29289
- * @param password The password associated with the protected worksheet.
29571
+ * @param password The password to check against the protected worksheet.
29290
29572
  * @returns Returns `true` if the password can be used to unlock worksheet protection. Otherwise, returns `false`.
29291
29573
  */
29292
29574
  checkPassword(password?: string): OfficeExtension.ClientResult<boolean>;
29293
29575
  /**
29294
- * Pauses worksheet protection for the given worksheet object for the user in a given session.
29295
- If the password is incorrect, then this method throws an `UnsupportedOperation` error and fails to pause protection.
29576
+ * Pauses worksheet protection for the given worksheet object for the user in the current session.
29577
+ This method does nothing if worksheet protection isn't enabled or is already paused.
29578
+ If the password is incorrect, then this method throws an `InvalidArgument` error and fails to pause protection.
29296
29579
  This method does not change the protection state if worksheet protection is not enabled or already paused.
29297
29580
  *
29298
29581
  * @remarks
29299
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29300
- * @beta
29582
+ * [Api set: ExcelApiOnline 1.1]
29301
29583
  *
29302
29584
  * @param password The password associated with the protected worksheet.
29303
29585
  */
@@ -29317,8 +29599,7 @@ declare namespace Excel {
29317
29599
  Worksheet protection must be paused for this method to work. If worksheet protection is not paused, then this method will not change the protection state of the worksheet.
29318
29600
  *
29319
29601
  * @remarks
29320
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29321
- * @beta
29602
+ * [Api set: ExcelApiOnline 1.1]
29322
29603
  */
29323
29604
  resumeProtection(): void;
29324
29605
  /**
@@ -29329,8 +29610,7 @@ declare namespace Excel {
29329
29610
  If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to change the password.
29330
29611
  *
29331
29612
  * @remarks
29332
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29333
- * @beta
29613
+ * [Api set: ExcelApiOnline 1.1]
29334
29614
  *
29335
29615
  * @param password The password associated with the `WorksheetProtection` object.
29336
29616
  */
@@ -29345,13 +29625,12 @@ declare namespace Excel {
29345
29625
  */
29346
29626
  unprotect(password?: string): void;
29347
29627
  /**
29348
- * Change the worksheet protection options associated to the `WorksheetProtection` object.
29628
+ * Change the worksheet protection options associated with the `WorksheetProtection` object.
29349
29629
  Worksheet protection must be disabled or paused for this method to work properly.
29350
29630
  If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to change the worksheet protection options.
29351
29631
  *
29352
29632
  * @remarks
29353
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
29354
- * @beta
29633
+ * [Api set: ExcelApiOnline 1.1]
29355
29634
  *
29356
29635
  * @param options The options interface associated with the `WorksheetProtection` object.
29357
29636
  */
@@ -29753,7 +30032,7 @@ declare namespace Excel {
29753
30032
  */
29754
30033
  readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];
29755
30034
  /**
29756
- * Represents Excel's number format code for the given range.
30035
+ * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
29757
30036
  *
29758
30037
  * @remarks
29759
30038
  * [Api set: ExcelApi 1.1]
@@ -30641,11 +30920,11 @@ declare namespace Excel {
30641
30920
  expand?: string;
30642
30921
  }): Excel.Range;
30643
30922
  /**
30644
- * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
30923
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are 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.
30645
30924
  */
30646
30925
  track(): Excel.Range;
30647
30926
  /**
30648
- * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
30927
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.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 will need to call `context.sync()` before the memory release takes effect.
30649
30928
  */
30650
30929
  untrack(): Excel.Range;
30651
30930
  /**
@@ -31021,11 +31300,11 @@ declare namespace Excel {
31021
31300
  expand?: string;
31022
31301
  }): Excel.RangeAreas;
31023
31302
  /**
31024
- * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
31303
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are 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.
31025
31304
  */
31026
31305
  track(): Excel.RangeAreas;
31027
31306
  /**
31028
- * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
31307
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.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 will need to call `context.sync()` before the memory release takes effect.
31029
31308
  */
31030
31309
  untrack(): Excel.RangeAreas;
31031
31310
  /**
@@ -31105,11 +31384,11 @@ declare namespace Excel {
31105
31384
  expand?: string;
31106
31385
  }): Excel.WorkbookRangeAreas;
31107
31386
  /**
31108
- * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for `context.trackedObjects.add(thisObject)`. If you are 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 needed to have added the object to the tracked object collection when the object was first created.
31387
+ * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://docs.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you are 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.
31109
31388
  */
31110
31389
  track(): Excel.WorkbookRangeAreas;
31111
31390
  /**
31112
- * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for `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 will need to call `context.sync()` before the memory release takes effect.
31391
+ * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://docs.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 will need to call `context.sync()` before the memory release takes effect.
31113
31392
  */
31114
31393
  untrack(): Excel.WorkbookRangeAreas;
31115
31394
  /**
@@ -35454,7 +35733,7 @@ declare namespace Excel {
35454
35733
  */
35455
35734
  delete(): void;
35456
35735
  /**
35457
- * Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
35736
+ * Gets the string representation of the data source of the chart series. The string representation could be information such as a cell address.
35458
35737
  *
35459
35738
  * @remarks
35460
35739
  * [Api set: ExcelApi 1.15]
@@ -35463,7 +35742,7 @@ declare namespace Excel {
35463
35742
  */
35464
35743
  getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension): OfficeExtension.ClientResult<string>;
35465
35744
  /**
35466
- * Gets the string representation of the data source of the chart series.The string representation could be information such as a cell address.
35745
+ * Gets the string representation of the data source of the chart series. The string representation could be information such as a cell address.
35467
35746
  *
35468
35747
  * @remarks
35469
35748
  * [Api set: ExcelApi 1.15]
@@ -39484,8 +39763,8 @@ declare namespace Excel {
39484
39763
  * [Api set: ExcelApi 1.14]
39485
39764
  *
39486
39765
  * @param columnIndex The zero-based column index, which represents which column filter needs to be cleared.
39487
- If the index value is not supported(for example, if the value is a negative number, or if the value is greater than the number of available columns in the range),
39488
- then an `InvalidArgument` exception will be thrown.
39766
+ If the index value is not supported (for example, if the value is a negative number, or if the value is greater than the number of available columns in the range),
39767
+ then an `InvalidArgument` error will be thrown.
39489
39768
  */
39490
39769
  clearColumnCriteria(columnIndex: number): void;
39491
39770
  /**
@@ -43666,7 +43945,8 @@ declare namespace Excel {
43666
43945
  */
43667
43946
  readonly font: Excel.ConditionalRangeFont;
43668
43947
  /**
43669
- * Represents Excel's number format code for the given range. Cleared if `null` is passed in.
43948
+ * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
43949
+ Cleared if `null` is passed in.
43670
43950
  *
43671
43951
  * @remarks
43672
43952
  * [Api set: ExcelApi 1.6]
@@ -44406,7 +44686,7 @@ declare namespace Excel {
44406
44686
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
44407
44687
  context: RequestContext;
44408
44688
  /**
44409
- * Gets the name of the table style.
44689
+ * Specifies the name of the table style.
44410
44690
  *
44411
44691
  * @remarks
44412
44692
  * [Api set: ExcelApi 1.10]
@@ -44570,7 +44850,7 @@ declare namespace Excel {
44570
44850
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
44571
44851
  context: RequestContext;
44572
44852
  /**
44573
- * Gets the name of the PivotTable style.
44853
+ * Specifies the name of the PivotTable style.
44574
44854
  *
44575
44855
  * @remarks
44576
44856
  * [Api set: ExcelApi 1.10]
@@ -44734,7 +45014,7 @@ declare namespace Excel {
44734
45014
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
44735
45015
  context: RequestContext;
44736
45016
  /**
44737
- * Gets the name of the slicer style.
45017
+ * Specifies the name of the slicer style.
44738
45018
  *
44739
45019
  * @remarks
44740
45020
  * [Api set: ExcelApi 1.10]
@@ -44898,7 +45178,7 @@ declare namespace Excel {
44898
45178
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
44899
45179
  context: RequestContext;
44900
45180
  /**
44901
- * Gets the name of the timeline style.
45181
+ * Specifies the name of the timeline style.
44902
45182
  *
44903
45183
  * @remarks
44904
45184
  * [Api set: ExcelApi 1.10]
@@ -45635,7 +45915,8 @@ declare namespace Excel {
45635
45915
  /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */
45636
45916
  context: RequestContext;
45637
45917
  /**
45638
- * Refreshes all the data connections in the collection.
45918
+ * Refreshes data connections in the collection, such as from a PivotTable to a Power BI dataset, or a Data Model to a table or range in the same workbook.
45919
+ Data connections unsupported by this method are: Power Query connections, data connections outside the original workbook (except Power BI connections), and connections to data protected by a firewall.
45639
45920
  *
45640
45921
  * @remarks
45641
45922
  * [Api set: ExcelApi 1.7]
@@ -46034,7 +46315,7 @@ declare namespace Excel {
46034
46315
  *
46035
46316
  * @param assignee The assignee's user identity information.
46036
46317
  */
46037
- assignTask(assignee: Identity): Excel.DocumentTask;
46318
+ assignTask(assignee: Excel.Identity): Excel.DocumentTask;
46038
46319
  /**
46039
46320
  * Deletes the comment and all the connected replies.
46040
46321
  *
@@ -46282,7 +46563,7 @@ declare namespace Excel {
46282
46563
  *
46283
46564
  * @param assignee The assignee's user identity information.
46284
46565
  */
46285
- assignTask(assignee: Identity): Excel.DocumentTask;
46566
+ assignTask(assignee: Excel.Identity): Excel.DocumentTask;
46286
46567
  /**
46287
46568
  * Deletes the comment reply.
46288
46569
  *
@@ -50824,7 +51105,7 @@ declare namespace Excel {
50824
51105
  }
50825
51106
  /**
50826
51107
  * @remarks
50827
- * [Api set: ExcelApi 1.1 for All, Formats, and Contents. 1.7 for Hyperlinks and RemoveHyperlinks.]
51108
+ * [Api set: ExcelApi 1.1]
50828
51109
  */
50829
51110
  enum ClearApplyTo {
50830
51111
  /**
@@ -52226,7 +52507,7 @@ declare namespace Excel {
52226
52507
  }
52227
52508
  /**
52228
52509
  * @remarks
52229
- * [Api set: ExcelApi 1.1 for Unknown, Empty, String, Integer, Double, Boolean, Error. 1.7 for RichValue]
52510
+ * [Api set: ExcelApi 1.1]
52230
52511
  */
52231
52512
  enum RangeValueType {
52232
52513
  /**
@@ -52478,7 +52759,7 @@ declare namespace Excel {
52478
52759
  /**
52479
52760
  * `Unknown` indicates that the type of data change is not one of the listed types.
52480
52761
  * @remarks
52481
- * [Api set: ExcelApi The name of this value was 'Others' in ExcelApi 1.7]
52762
+ * [Api set: ExcelApi 1.8. The name of this value was 'Others' in ExcelApi 1.7]
52482
52763
  */
52483
52764
  unknown = "Unknown",
52484
52765
  /**
@@ -59507,6 +59788,7 @@ declare namespace Excel {
59507
59788
  requestAborted = "RequestAborted",
59508
59789
  responsePayloadSizeLimitExceeded = "ResponsePayloadSizeLimitExceeded",
59509
59790
  unsupportedFeature = "UnsupportedFeature",
59791
+ unsupportedFillType = "UnsupportedFillType",
59510
59792
  unsupportedOperation = "UnsupportedOperation",
59511
59793
  unsupportedSheet = "UnsupportedSheet",
59512
59794
  invalidOperationInCellEditMode = "InvalidOperationInCellEditMode"
@@ -59533,8 +59815,7 @@ declare namespace Excel {
59533
59815
  If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
59534
59816
  *
59535
59817
  * @remarks
59536
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59537
- * @beta
59818
+ * [Api set: ExcelApiOnline 1.1]
59538
59819
  */
59539
59820
  address?: string;
59540
59821
  /**
@@ -59544,8 +59825,7 @@ declare namespace Excel {
59544
59825
  If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
59545
59826
  *
59546
59827
  * @remarks
59547
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59548
- * @beta
59828
+ * [Api set: ExcelApiOnline 1.1]
59549
59829
  */
59550
59830
  title?: string;
59551
59831
  }
@@ -59568,146 +59848,21 @@ declare namespace Excel {
59568
59848
  workbookLinksRefreshMode?: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";
59569
59849
  items?: Excel.Interfaces.LinkedWorkbookData[];
59570
59850
  }
59571
- /** An interface for updating data on the IdentityCollection object, for use in `identityCollection.set({ ... })`. */
59572
- interface IdentityCollectionUpdateData {
59573
- items?: Excel.Interfaces.IdentityEntityData[];
59574
- }
59575
- /** An interface for updating data on the DocumentTaskChange object, for use in `documentTaskChange.set({ ... })`. */
59576
- interface DocumentTaskChangeUpdateData {
59577
- /**
59578
- * Represents the user assigned to the task for an `assign` change record type, or the user unassigned from the task for an `unassign` change record type.
59579
- *
59580
- * @remarks
59581
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59582
- * @beta
59583
- */
59584
- assignee?: Excel.Identity;
59585
- /**
59586
- * Represents the user who created or changed the task.
59587
- *
59588
- * @remarks
59589
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59590
- * @beta
59591
- */
59592
- changedBy?: Excel.Identity;
59593
- /**
59594
- * Represents the ID of the `Comment` or `CommentReply` to which the task change is anchored.
59595
- *
59596
- * @remarks
59597
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59598
- * @beta
59599
- */
59600
- commentId?: string;
59601
- /**
59602
- * Represents the creation date and time of the task change record. All dates are in UTC.
59603
- *
59604
- * @remarks
59605
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59606
- * @beta
59607
- */
59608
- createdDateTime?: Date;
59609
- /**
59610
- * Represents the task's due date and time, in UTC time zone. It is used for the `setSchedule` change record type.
59611
- Can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
59612
- *
59613
- * @remarks
59614
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59615
- * @beta
59616
- */
59617
- dueDateTime?: Date;
59618
- /**
59619
- * ID for the task change record.
59620
- *
59621
- * @remarks
59622
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59623
- * @beta
59624
- */
59625
- id?: string;
59626
- /**
59627
- * Represents the task's completion percentage. It is used for the `setPercentComplete` change record type.
59628
- This is a value between 0 and 100, where 100 represents a completed task. Changing this value to 100 also completes the associated comment. Changing the completion from 100 to a lower value reactivates the associated comment.
59629
- *
59630
- * @remarks
59631
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59632
- * @beta
59633
- */
59634
- percentComplete?: number;
59635
- /**
59636
- * Represents the task's priority. It is used for the `setPriority` change record type.
59637
- This is a value between 0 and 10, with 5 being the default priority if not set, and where 0 represents the highest priority.
59638
- *
59639
- * @remarks
59640
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59641
- * @beta
59642
- */
59643
- priority?: number;
59644
- /**
59645
- * Represents the task's start date and time, in UTC time zone. It is used for the `setSchedule` change record type.
59646
- Can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
59647
- *
59648
- * @remarks
59649
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59650
- * @beta
59651
- */
59652
- startDateTime?: Date;
59653
- /**
59654
- * Represents the task's title. It is used for the `setTitle` change record type.
59655
- *
59656
- * @remarks
59657
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59658
- * @beta
59659
- */
59660
- title?: string;
59661
- /**
59662
- * Represents the action type of the task change record. Some examples of action types are `assign`, `undo`, and `setPriority`.
59663
- *
59664
- * @remarks
59665
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59666
- * @beta
59667
- */
59668
- type?: Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo";
59669
- /**
59670
- * Represents the `DocumentTaskChange.id` property that was undone for the `undo` change record type.
59671
- *
59672
- * @remarks
59673
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59674
- * @beta
59675
- */
59676
- undoHistoryId?: string;
59677
- }
59678
59851
  /** An interface for updating data on the DocumentTaskChangeCollection object, for use in `documentTaskChangeCollection.set({ ... })`. */
59679
59852
  interface DocumentTaskChangeCollectionUpdateData {
59680
59853
  items?: Excel.Interfaces.DocumentTaskChangeData[];
59681
59854
  }
59682
- /** An interface for updating data on the IdentityEntity object, for use in `identityEntity.set({ ... })`. */
59683
- interface IdentityEntityUpdateData {
59684
- /**
59685
- * Represents the user's display name.
59686
- *
59687
- * @remarks
59688
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59689
- * @beta
59690
- */
59691
- displayName?: string;
59692
- /**
59693
- * Represents the user's email address.
59694
- *
59695
- * @remarks
59696
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59697
- * @beta
59698
- */
59699
- email?: string;
59855
+ /** An interface for updating data on the DocumentTask object, for use in `documentTask.set({ ... })`. */
59856
+ interface DocumentTaskUpdateData {
59700
59857
  /**
59701
- * Represents the user's unique ID.
59858
+ * Gets or sets the date and time the task is due.
59859
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
59702
59860
  *
59703
59861
  * @remarks
59704
59862
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59705
59863
  * @beta
59706
59864
  */
59707
- id?: string;
59708
- }
59709
- /** An interface for updating data on the DocumentTask object, for use in `documentTask.set({ ... })`. */
59710
- interface DocumentTaskUpdateData {
59865
+ dueDateTime?: Date;
59711
59866
  /**
59712
59867
  * Specifies the completion percentage of the task. This is a value between 0 and 100, where 100 represents a completed task.
59713
59868
  *
@@ -59725,13 +59880,14 @@ declare namespace Excel {
59725
59880
  */
59726
59881
  priority?: number;
59727
59882
  /**
59728
- * Gets or sets the date and time the task should start and is due.
59883
+ * Gets or sets the date and time the task starts.
59884
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
59729
59885
  *
59730
59886
  * @remarks
59731
59887
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
59732
59888
  * @beta
59733
59889
  */
59734
- startAndDueDateTime?: Excel.DocumentTaskSchedule;
59890
+ startDateTime?: Date;
59735
59891
  /**
59736
59892
  * Specifies title of the task.
59737
59893
  *
@@ -59974,7 +60130,7 @@ declare namespace Excel {
59974
60130
  */
59975
60131
  hyperlink?: Excel.RangeHyperlink;
59976
60132
  /**
59977
- * Represents Excel's number format code for the given range.
60133
+ * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
59978
60134
  *
59979
60135
  * @remarks
59980
60136
  * [Api set: ExcelApi 1.1]
@@ -63533,7 +63689,8 @@ declare namespace Excel {
63533
63689
  */
63534
63690
  font?: Excel.Interfaces.ConditionalRangeFontUpdateData;
63535
63691
  /**
63536
- * Represents Excel's number format code for the given range. Cleared if `null` is passed in.
63692
+ * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
63693
+ Cleared if `null` is passed in.
63537
63694
  *
63538
63695
  * @remarks
63539
63696
  * [Api set: ExcelApi 1.6]
@@ -63798,7 +63955,7 @@ declare namespace Excel {
63798
63955
  /** An interface for updating data on the TableStyle object, for use in `tableStyle.set({ ... })`. */
63799
63956
  interface TableStyleUpdateData {
63800
63957
  /**
63801
- * Gets the name of the table style.
63958
+ * Specifies the name of the table style.
63802
63959
  *
63803
63960
  * @remarks
63804
63961
  * [Api set: ExcelApi 1.10]
@@ -63812,7 +63969,7 @@ declare namespace Excel {
63812
63969
  /** An interface for updating data on the PivotTableStyle object, for use in `pivotTableStyle.set({ ... })`. */
63813
63970
  interface PivotTableStyleUpdateData {
63814
63971
  /**
63815
- * Gets the name of the PivotTable style.
63972
+ * Specifies the name of the PivotTable style.
63816
63973
  *
63817
63974
  * @remarks
63818
63975
  * [Api set: ExcelApi 1.10]
@@ -63826,7 +63983,7 @@ declare namespace Excel {
63826
63983
  /** An interface for updating data on the SlicerStyle object, for use in `slicerStyle.set({ ... })`. */
63827
63984
  interface SlicerStyleUpdateData {
63828
63985
  /**
63829
- * Gets the name of the slicer style.
63986
+ * Specifies the name of the slicer style.
63830
63987
  *
63831
63988
  * @remarks
63832
63989
  * [Api set: ExcelApi 1.10]
@@ -63840,7 +63997,7 @@ declare namespace Excel {
63840
63997
  /** An interface for updating data on the TimelineStyle object, for use in `timelineStyle.set({ ... })`. */
63841
63998
  interface TimelineStyleUpdateData {
63842
63999
  /**
63843
- * Gets the name of the timeline style.
64000
+ * Specifies the name of the timeline style.
63844
64001
  *
63845
64002
  * @remarks
63846
64003
  * [Api set: ExcelApi 1.10]
@@ -64643,16 +64800,14 @@ declare namespace Excel {
64643
64800
  If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
64644
64801
  *
64645
64802
  * @remarks
64646
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64647
- * @beta
64803
+ * [Api set: ExcelApiOnline 1.1]
64648
64804
  */
64649
64805
  address?: string;
64650
64806
  /**
64651
- * Specifies if the `AllowEditRange` is password protected.
64807
+ * Specifies if the object is password protected.
64652
64808
  *
64653
64809
  * @remarks
64654
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64655
- * @beta
64810
+ * [Api set: ExcelApiOnline 1.1]
64656
64811
  */
64657
64812
  isPasswordProtected?: boolean;
64658
64813
  /**
@@ -64662,8 +64817,7 @@ declare namespace Excel {
64662
64817
  If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
64663
64818
  *
64664
64819
  * @remarks
64665
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64666
- * @beta
64820
+ * [Api set: ExcelApiOnline 1.1]
64667
64821
  */
64668
64822
  title?: string;
64669
64823
  }
@@ -64736,14 +64890,10 @@ declare namespace Excel {
64736
64890
  interface LinkedWorkbookCollectionData {
64737
64891
  items?: Excel.Interfaces.LinkedWorkbookData[];
64738
64892
  }
64739
- /** An interface describing the data returned by calling `identityCollection.toJSON()`. */
64740
- interface IdentityCollectionData {
64741
- items?: Excel.Interfaces.IdentityEntityData[];
64742
- }
64743
64893
  /** An interface describing the data returned by calling `documentTaskChange.toJSON()`. */
64744
64894
  interface DocumentTaskChangeData {
64745
64895
  /**
64746
- * Represents the user assigned to the task for an `assign` change record type, or the user unassigned from the task for an `unassign` change record type.
64896
+ * Represents the user assigned to the task for an `assign` change action, or the user unassigned from the task for an `unassign` change action.
64747
64897
  *
64748
64898
  * @remarks
64749
64899
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -64751,7 +64901,7 @@ declare namespace Excel {
64751
64901
  */
64752
64902
  assignee?: Excel.Identity;
64753
64903
  /**
64754
- * Represents the user who created or changed the task.
64904
+ * Represents the identity of the user who made the task change.
64755
64905
  *
64756
64906
  * @remarks
64757
64907
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -64775,8 +64925,8 @@ declare namespace Excel {
64775
64925
  */
64776
64926
  createdDateTime?: Date;
64777
64927
  /**
64778
- * Represents the task's due date and time, in UTC time zone. It is used for the `setSchedule` change record type.
64779
- Can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
64928
+ * Represents the task's due date and time. It is used for the `setSchedule` change action.
64929
+ It is in UTC time zone. It can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
64780
64930
  *
64781
64931
  * @remarks
64782
64932
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -64784,7 +64934,7 @@ declare namespace Excel {
64784
64934
  */
64785
64935
  dueDateTime?: Date;
64786
64936
  /**
64787
- * ID for the task change record.
64937
+ * The unique GUID of the task change.
64788
64938
  *
64789
64939
  * @remarks
64790
64940
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -64792,7 +64942,7 @@ declare namespace Excel {
64792
64942
  */
64793
64943
  id?: string;
64794
64944
  /**
64795
- * Represents the task's completion percentage. It is used for the `setPercentComplete` change record type.
64945
+ * Represents the task's completion percentage. It is used for the `setPercentComplete` change action.
64796
64946
  This is a value between 0 and 100, where 100 represents a completed task. Changing this value to 100 also completes the associated comment. Changing the completion from 100 to a lower value reactivates the associated comment.
64797
64947
  *
64798
64948
  * @remarks
@@ -64801,7 +64951,7 @@ declare namespace Excel {
64801
64951
  */
64802
64952
  percentComplete?: number;
64803
64953
  /**
64804
- * Represents the task's priority. It is used for the `setPriority` change record type.
64954
+ * Represents the task's priority. It is used for the `setPriority` change action.
64805
64955
  This is a value between 0 and 10, with 5 being the default priority if not set, and where 0 represents the highest priority.
64806
64956
  *
64807
64957
  * @remarks
@@ -64810,8 +64960,8 @@ declare namespace Excel {
64810
64960
  */
64811
64961
  priority?: number;
64812
64962
  /**
64813
- * Represents the task's start date and time, in UTC time zone. It is used for the `setSchedule` change record type.
64814
- Can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
64963
+ * Represents the task's start date and time. It is used for the `setSchedule` change action.
64964
+ It is in UTC time zone. It can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
64815
64965
  *
64816
64966
  * @remarks
64817
64967
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -64819,7 +64969,7 @@ declare namespace Excel {
64819
64969
  */
64820
64970
  startDateTime?: Date;
64821
64971
  /**
64822
- * Represents the task's title. It is used for the `setTitle` change record type.
64972
+ * Represents the task's title. It is used for the `setTitle` change action.
64823
64973
  *
64824
64974
  * @remarks
64825
64975
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -64835,47 +64985,28 @@ declare namespace Excel {
64835
64985
  */
64836
64986
  type?: Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo";
64837
64987
  /**
64838
- * Represents the `DocumentTaskChange.id` property that was undone for the `undo` change record type.
64988
+ * Represents the `DocumentTaskChange.id` property that was undone for the `undo` change action.
64839
64989
  *
64840
64990
  * @remarks
64841
64991
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64842
64992
  * @beta
64843
64993
  */
64844
- undoHistoryId?: string;
64994
+ undoChangeId?: string;
64845
64995
  }
64846
64996
  /** An interface describing the data returned by calling `documentTaskChangeCollection.toJSON()`. */
64847
64997
  interface DocumentTaskChangeCollectionData {
64848
64998
  items?: Excel.Interfaces.DocumentTaskChangeData[];
64849
64999
  }
64850
- /** An interface describing the data returned by calling `identityEntity.toJSON()`. */
64851
- interface IdentityEntityData {
64852
- /**
64853
- * Represents the user's display name.
64854
- *
64855
- * @remarks
64856
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64857
- * @beta
64858
- */
64859
- displayName?: string;
64860
- /**
64861
- * Represents the user's email address.
64862
- *
64863
- * @remarks
64864
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64865
- * @beta
64866
- */
64867
- email?: string;
65000
+ /** An interface describing the data returned by calling `documentTask.toJSON()`. */
65001
+ interface DocumentTaskData {
64868
65002
  /**
64869
- * Represents the user's unique ID.
65003
+ * Returns a collection of assignees of the task.
64870
65004
  *
64871
65005
  * @remarks
64872
65006
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64873
65007
  * @beta
64874
65008
  */
64875
- id?: string;
64876
- }
64877
- /** An interface describing the data returned by calling `documentTask.toJSON()`. */
64878
- interface DocumentTaskData {
65009
+ assignees?: Excel.Identity[];
64879
65010
  /**
64880
65011
  * Gets the most recent user to have completed the task.
64881
65012
  *
@@ -64908,6 +65039,15 @@ declare namespace Excel {
64908
65039
  * @beta
64909
65040
  */
64910
65041
  createdDateTime?: Date;
65042
+ /**
65043
+ * Gets or sets the date and time the task is due.
65044
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
65045
+ *
65046
+ * @remarks
65047
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65048
+ * @beta
65049
+ */
65050
+ dueDateTime?: Date;
64911
65051
  /**
64912
65052
  * Gets the ID of the task.
64913
65053
  *
@@ -64933,13 +65073,14 @@ declare namespace Excel {
64933
65073
  */
64934
65074
  priority?: number;
64935
65075
  /**
64936
- * Gets or sets the date and time the task should start and is due.
65076
+ * Gets or sets the date and time the task starts.
65077
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
64937
65078
  *
64938
65079
  * @remarks
64939
65080
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
64940
65081
  * @beta
64941
65082
  */
64942
- startAndDueDateTime?: Excel.DocumentTaskSchedule;
65083
+ startDateTime?: Date;
64943
65084
  /**
64944
65085
  * Specifies title of the task.
64945
65086
  *
@@ -65438,32 +65579,28 @@ declare namespace Excel {
65438
65579
  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.
65439
65580
  *
65440
65581
  * @remarks
65441
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65442
- * @beta
65582
+ * [Api set: ExcelApiOnline 1.1]
65443
65583
  */
65444
65584
  allowEditRanges?: Excel.Interfaces.AllowEditRangeData[];
65445
65585
  /**
65446
65586
  * Specifies if protection can be paused for this worksheet.
65447
65587
  *
65448
65588
  * @remarks
65449
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65450
- * @beta
65589
+ * [Api set: ExcelApiOnline 1.1]
65451
65590
  */
65452
65591
  canPauseProtection?: boolean;
65453
65592
  /**
65454
65593
  * Specifies if the sheet is password protected.
65455
65594
  *
65456
65595
  * @remarks
65457
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65458
- * @beta
65596
+ * [Api set: ExcelApiOnline 1.1]
65459
65597
  */
65460
65598
  isPasswordProtected?: boolean;
65461
65599
  /**
65462
65600
  * Specifies if worksheet protection is paused.
65463
65601
  *
65464
65602
  * @remarks
65465
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65466
- * @beta
65603
+ * [Api set: ExcelApiOnline 1.1]
65467
65604
  */
65468
65605
  isPaused?: boolean;
65469
65606
  /**
@@ -65481,12 +65618,11 @@ declare namespace Excel {
65481
65618
  */
65482
65619
  protected?: boolean;
65483
65620
  /**
65484
- * Specifies the protection options settings saved in the worksheet.
65621
+ * Specifies the protection options saved in the worksheet.
65485
65622
  This will return the same `WorksheetProtectionOptions` object regardless of the worksheet protection state.
65486
65623
  *
65487
65624
  * @remarks
65488
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
65489
- * @beta
65625
+ * [Api set: ExcelApiOnline 1.1]
65490
65626
  */
65491
65627
  savedOptions?: Excel.WorksheetProtectionOptions;
65492
65628
  }
@@ -65635,7 +65771,7 @@ declare namespace Excel {
65635
65771
  */
65636
65772
  linkedDataTypeState?: Excel.LinkedDataTypeState[][];
65637
65773
  /**
65638
- * Represents Excel's number format code for the given range.
65774
+ * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
65639
65775
  *
65640
65776
  * @remarks
65641
65777
  * [Api set: ExcelApi 1.1]
@@ -70103,7 +70239,8 @@ declare namespace Excel {
70103
70239
  */
70104
70240
  font?: Excel.Interfaces.ConditionalRangeFontData;
70105
70241
  /**
70106
- * Represents Excel's number format code for the given range. Cleared if `null` is passed in.
70242
+ * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
70243
+ Cleared if `null` is passed in.
70107
70244
  *
70108
70245
  * @remarks
70109
70246
  * [Api set: ExcelApi 1.6]
@@ -70361,7 +70498,7 @@ declare namespace Excel {
70361
70498
  /** An interface describing the data returned by calling `tableStyle.toJSON()`. */
70362
70499
  interface TableStyleData {
70363
70500
  /**
70364
- * Gets the name of the table style.
70501
+ * Specifies the name of the table style.
70365
70502
  *
70366
70503
  * @remarks
70367
70504
  * [Api set: ExcelApi 1.10]
@@ -70382,7 +70519,7 @@ declare namespace Excel {
70382
70519
  /** An interface describing the data returned by calling `pivotTableStyle.toJSON()`. */
70383
70520
  interface PivotTableStyleData {
70384
70521
  /**
70385
- * Gets the name of the PivotTable style.
70522
+ * Specifies the name of the PivotTable style.
70386
70523
  *
70387
70524
  * @remarks
70388
70525
  * [Api set: ExcelApi 1.10]
@@ -70403,7 +70540,7 @@ declare namespace Excel {
70403
70540
  /** An interface describing the data returned by calling `slicerStyle.toJSON()`. */
70404
70541
  interface SlicerStyleData {
70405
70542
  /**
70406
- * Gets the name of the slicer style.
70543
+ * Specifies the name of the slicer style.
70407
70544
  *
70408
70545
  * @remarks
70409
70546
  * [Api set: ExcelApi 1.10]
@@ -70424,7 +70561,7 @@ declare namespace Excel {
70424
70561
  /** An interface describing the data returned by calling `timelineStyle.toJSON()`. */
70425
70562
  interface TimelineStyleData {
70426
70563
  /**
70427
- * Gets the name of the timeline style.
70564
+ * Specifies the name of the timeline style.
70428
70565
  *
70429
70566
  * @remarks
70430
70567
  * [Api set: ExcelApi 1.10]
@@ -71616,8 +71753,7 @@ declare namespace Excel {
71616
71753
  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.
71617
71754
  *
71618
71755
  * @remarks
71619
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71620
- * @beta
71756
+ * [Api set: ExcelApiOnline 1.1]
71621
71757
  */
71622
71758
  interface AllowEditRangeLoadOptions {
71623
71759
  /**
@@ -71630,16 +71766,14 @@ declare namespace Excel {
71630
71766
  If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
71631
71767
  *
71632
71768
  * @remarks
71633
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71634
- * @beta
71769
+ * [Api set: ExcelApiOnline 1.1]
71635
71770
  */
71636
71771
  address?: boolean;
71637
71772
  /**
71638
- * Specifies if the `AllowEditRange` is password protected.
71773
+ * Specifies if the object is password protected.
71639
71774
  *
71640
71775
  * @remarks
71641
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71642
- * @beta
71776
+ * [Api set: ExcelApiOnline 1.1]
71643
71777
  */
71644
71778
  isPasswordProtected?: boolean;
71645
71779
  /**
@@ -71649,8 +71783,7 @@ declare namespace Excel {
71649
71783
  If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
71650
71784
  *
71651
71785
  * @remarks
71652
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71653
- * @beta
71786
+ * [Api set: ExcelApiOnline 1.1]
71654
71787
  */
71655
71788
  title?: boolean;
71656
71789
  }
@@ -71659,8 +71792,7 @@ declare namespace Excel {
71659
71792
  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.
71660
71793
  *
71661
71794
  * @remarks
71662
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71663
- * @beta
71795
+ * [Api set: ExcelApiOnline 1.1]
71664
71796
  */
71665
71797
  interface AllowEditRangeCollectionLoadOptions {
71666
71798
  /**
@@ -71673,16 +71805,14 @@ declare namespace Excel {
71673
71805
  If worksheet protection is enabled and not paused, this method throws an `AccessDenied` error and fails to set the range.
71674
71806
  *
71675
71807
  * @remarks
71676
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71677
- * @beta
71808
+ * [Api set: ExcelApiOnline 1.1]
71678
71809
  */
71679
71810
  address?: boolean;
71680
71811
  /**
71681
- * For EACH ITEM in the collection: Specifies if the `AllowEditRange` is password protected.
71812
+ * For EACH ITEM in the collection: Specifies if the object is password protected.
71682
71813
  *
71683
71814
  * @remarks
71684
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71685
- * @beta
71815
+ * [Api set: ExcelApiOnline 1.1]
71686
71816
  */
71687
71817
  isPasswordProtected?: boolean;
71688
71818
  /**
@@ -71692,8 +71822,7 @@ declare namespace Excel {
71692
71822
  If there is already an existing `AllowEditRange` with the same string, or if the string is `null` or empty (""), then this method throws an `InvalidArgument` error and fails to set the title.
71693
71823
  *
71694
71824
  * @remarks
71695
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71696
- * @beta
71825
+ * [Api set: ExcelApiOnline 1.1]
71697
71826
  */
71698
71827
  title?: boolean;
71699
71828
  }
@@ -71849,43 +71978,6 @@ declare namespace Excel {
71849
71978
  */
71850
71979
  id?: boolean;
71851
71980
  }
71852
- /**
71853
- * Represents a collection of user identities.
71854
- *
71855
- * @remarks
71856
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71857
- * @beta
71858
- */
71859
- interface IdentityCollectionLoadOptions {
71860
- /**
71861
- Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
71862
- */
71863
- $all?: boolean;
71864
- /**
71865
- * For EACH ITEM in the collection: Represents the user's display name.
71866
- *
71867
- * @remarks
71868
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71869
- * @beta
71870
- */
71871
- displayName?: boolean;
71872
- /**
71873
- * For EACH ITEM in the collection: Represents the user's email address.
71874
- *
71875
- * @remarks
71876
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71877
- * @beta
71878
- */
71879
- email?: boolean;
71880
- /**
71881
- * For EACH ITEM in the collection: Represents the user's unique ID.
71882
- *
71883
- * @remarks
71884
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71885
- * @beta
71886
- */
71887
- id?: boolean;
71888
- }
71889
71981
  /**
71890
71982
  * Represents a recorded change to the task.
71891
71983
  *
@@ -71899,7 +71991,7 @@ declare namespace Excel {
71899
71991
  */
71900
71992
  $all?: boolean;
71901
71993
  /**
71902
- * Represents the user assigned to the task for an `assign` change record type, or the user unassigned from the task for an `unassign` change record type.
71994
+ * Represents the user assigned to the task for an `assign` change action, or the user unassigned from the task for an `unassign` change action.
71903
71995
  *
71904
71996
  * @remarks
71905
71997
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71907,7 +71999,7 @@ declare namespace Excel {
71907
71999
  */
71908
72000
  assignee?: boolean;
71909
72001
  /**
71910
- * Represents the user who created or changed the task.
72002
+ * Represents the identity of the user who made the task change.
71911
72003
  *
71912
72004
  * @remarks
71913
72005
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71915,7 +72007,7 @@ declare namespace Excel {
71915
72007
  */
71916
72008
  changedBy?: boolean;
71917
72009
  /**
71918
- * Represents the ID of the `Comment` or `CommentReply` to which the task change is anchored.
72010
+ * Represents the ID of the `comment` or `commentReply` to which the task change is anchored.
71919
72011
  *
71920
72012
  * @remarks
71921
72013
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71931,8 +72023,8 @@ declare namespace Excel {
71931
72023
  */
71932
72024
  createdDateTime?: boolean;
71933
72025
  /**
71934
- * Represents the task's due date and time, in UTC time zone. It is used for the `setSchedule` change record type.
71935
- Can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
72026
+ * Represents the task's due date and time. It is used for the `setSchedule` change action.
72027
+ It is in UTC time zone. It can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
71936
72028
  *
71937
72029
  * @remarks
71938
72030
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71940,7 +72032,7 @@ declare namespace Excel {
71940
72032
  */
71941
72033
  dueDateTime?: boolean;
71942
72034
  /**
71943
- * ID for the task change record.
72035
+ * The unique GUID of the task change.
71944
72036
  *
71945
72037
  * @remarks
71946
72038
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71948,7 +72040,7 @@ declare namespace Excel {
71948
72040
  */
71949
72041
  id?: boolean;
71950
72042
  /**
71951
- * Represents the task's completion percentage. It is used for the `setPercentComplete` change record type.
72043
+ * Represents the task's completion percentage. It is used for the `setPercentComplete` change action.
71952
72044
  This is a value between 0 and 100, where 100 represents a completed task. Changing this value to 100 also completes the associated comment. Changing the completion from 100 to a lower value reactivates the associated comment.
71953
72045
  *
71954
72046
  * @remarks
@@ -71957,7 +72049,7 @@ declare namespace Excel {
71957
72049
  */
71958
72050
  percentComplete?: boolean;
71959
72051
  /**
71960
- * Represents the task's priority. It is used for the `setPriority` change record type.
72052
+ * Represents the task's priority. It is used for the `setPriority` change action.
71961
72053
  This is a value between 0 and 10, with 5 being the default priority if not set, and where 0 represents the highest priority.
71962
72054
  *
71963
72055
  * @remarks
@@ -71966,8 +72058,8 @@ declare namespace Excel {
71966
72058
  */
71967
72059
  priority?: boolean;
71968
72060
  /**
71969
- * Represents the task's start date and time, in UTC time zone. It is used for the `setSchedule` change record type.
71970
- Can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
72061
+ * Represents the task's start date and time. It is used for the `setSchedule` change action.
72062
+ It is in UTC time zone. It can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
71971
72063
  *
71972
72064
  * @remarks
71973
72065
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71975,7 +72067,7 @@ declare namespace Excel {
71975
72067
  */
71976
72068
  startDateTime?: boolean;
71977
72069
  /**
71978
- * Represents the task's title. It is used for the `setTitle` change record type.
72070
+ * Represents the task's title. It is used for the `setTitle` change action.
71979
72071
  *
71980
72072
  * @remarks
71981
72073
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71983,7 +72075,7 @@ declare namespace Excel {
71983
72075
  */
71984
72076
  title?: boolean;
71985
72077
  /**
71986
- * Represents the action type of the task change record. Some examples of action types are `assign`, `undo`, and `setPriority`.
72078
+ * Represents the action type of the task change record. Some examples of action types are assign, undo, and setPriority.
71987
72079
  *
71988
72080
  * @remarks
71989
72081
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -71991,13 +72083,13 @@ declare namespace Excel {
71991
72083
  */
71992
72084
  type?: boolean;
71993
72085
  /**
71994
- * Represents the `DocumentTaskChange.id` property that was undone for the `undo` change record type.
72086
+ * Represents the `DocumentTaskChange.id` property that was undone for the `undo` change action.
71995
72087
  *
71996
72088
  * @remarks
71997
72089
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
71998
72090
  * @beta
71999
72091
  */
72000
- undoHistoryId?: boolean;
72092
+ undoChangeId?: boolean;
72001
72093
  }
72002
72094
  /**
72003
72095
  * Represents a collection of change records for a task.
@@ -72012,7 +72104,7 @@ declare namespace Excel {
72012
72104
  */
72013
72105
  $all?: boolean;
72014
72106
  /**
72015
- * For EACH ITEM in the collection: Represents the user assigned to the task for an `assign` change record type, or the user unassigned from the task for an `unassign` change record type.
72107
+ * For EACH ITEM in the collection: Represents the user assigned to the task for an `assign` change action, or the user unassigned from the task for an `unassign` change action.
72016
72108
  *
72017
72109
  * @remarks
72018
72110
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -72020,7 +72112,7 @@ declare namespace Excel {
72020
72112
  */
72021
72113
  assignee?: boolean;
72022
72114
  /**
72023
- * For EACH ITEM in the collection: Represents the user who created or changed the task.
72115
+ * For EACH ITEM in the collection: Represents the identity of the user who made the task change.
72024
72116
  *
72025
72117
  * @remarks
72026
72118
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -72028,7 +72120,7 @@ declare namespace Excel {
72028
72120
  */
72029
72121
  changedBy?: boolean;
72030
72122
  /**
72031
- * For EACH ITEM in the collection: Represents the ID of the `Comment` or `CommentReply` to which the task change is anchored.
72123
+ * For EACH ITEM in the collection: Represents the ID of the `comment` or `commentReply` to which the task change is anchored.
72032
72124
  *
72033
72125
  * @remarks
72034
72126
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -72044,8 +72136,8 @@ declare namespace Excel {
72044
72136
  */
72045
72137
  createdDateTime?: boolean;
72046
72138
  /**
72047
- * For EACH ITEM in the collection: Represents the task's due date and time, in UTC time zone. It is used for the `setSchedule` change record type.
72048
- Can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
72139
+ * For EACH ITEM in the collection: Represents the task's due date and time. It is used for the `setSchedule` change action.
72140
+ It is in UTC time zone. It can be set to `null` to remove the due date and time. It should be set together with `startDateTime` to avoid conflicts.
72049
72141
  *
72050
72142
  * @remarks
72051
72143
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -72053,7 +72145,7 @@ declare namespace Excel {
72053
72145
  */
72054
72146
  dueDateTime?: boolean;
72055
72147
  /**
72056
- * For EACH ITEM in the collection: ID for the task change record.
72148
+ * For EACH ITEM in the collection: The unique GUID of the task change.
72057
72149
  *
72058
72150
  * @remarks
72059
72151
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -72061,7 +72153,7 @@ declare namespace Excel {
72061
72153
  */
72062
72154
  id?: boolean;
72063
72155
  /**
72064
- * For EACH ITEM in the collection: Represents the task's completion percentage. It is used for the `setPercentComplete` change record type.
72156
+ * For EACH ITEM in the collection: Represents the task's completion percentage. It is used for the `setPercentComplete` change action.
72065
72157
  This is a value between 0 and 100, where 100 represents a completed task. Changing this value to 100 also completes the associated comment. Changing the completion from 100 to a lower value reactivates the associated comment.
72066
72158
  *
72067
72159
  * @remarks
@@ -72070,7 +72162,7 @@ declare namespace Excel {
72070
72162
  */
72071
72163
  percentComplete?: boolean;
72072
72164
  /**
72073
- * For EACH ITEM in the collection: Represents the task's priority. It is used for the `setPriority` change record type.
72165
+ * For EACH ITEM in the collection: Represents the task's priority. It is used for the `setPriority` change action.
72074
72166
  This is a value between 0 and 10, with 5 being the default priority if not set, and where 0 represents the highest priority.
72075
72167
  *
72076
72168
  * @remarks
@@ -72079,8 +72171,8 @@ declare namespace Excel {
72079
72171
  */
72080
72172
  priority?: boolean;
72081
72173
  /**
72082
- * For EACH ITEM in the collection: Represents the task's start date and time, in UTC time zone. It is used for the `setSchedule` change record type.
72083
- Can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
72174
+ * For EACH ITEM in the collection: Represents the task's start date and time. It is used for the `setSchedule` change action.
72175
+ It is in UTC time zone. It can be set to `null` to remove the start date and time. It should be set together with `dueDateTime` to avoid conflicts.
72084
72176
  *
72085
72177
  * @remarks
72086
72178
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -72088,7 +72180,7 @@ declare namespace Excel {
72088
72180
  */
72089
72181
  startDateTime?: boolean;
72090
72182
  /**
72091
- * For EACH ITEM in the collection: Represents the task's title. It is used for the `setTitle` change record type.
72183
+ * For EACH ITEM in the collection: Represents the task's title. It is used for the `setTitle` change action.
72092
72184
  *
72093
72185
  * @remarks
72094
72186
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
@@ -72104,50 +72196,13 @@ declare namespace Excel {
72104
72196
  */
72105
72197
  type?: boolean;
72106
72198
  /**
72107
- * For EACH ITEM in the collection: Represents the `DocumentTaskChange.id` property that was undone for the `undo` change record type.
72108
- *
72109
- * @remarks
72110
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72111
- * @beta
72112
- */
72113
- undoHistoryId?: boolean;
72114
- }
72115
- /**
72116
- * Represents information about a user's identity.
72117
- *
72118
- * @remarks
72119
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72120
- * @beta
72121
- */
72122
- interface IdentityEntityLoadOptions {
72123
- /**
72124
- Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`) but not the navigational properties (e.g.: `Range.format.fill.color`).
72125
- */
72126
- $all?: boolean;
72127
- /**
72128
- * Represents the user's display name.
72199
+ * For EACH ITEM in the collection: Represents the `DocumentTaskChange.id` property that was undone for the `undo` change action.
72129
72200
  *
72130
72201
  * @remarks
72131
72202
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72132
72203
  * @beta
72133
72204
  */
72134
- displayName?: boolean;
72135
- /**
72136
- * Represents the user's email address.
72137
- *
72138
- * @remarks
72139
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72140
- * @beta
72141
- */
72142
- email?: boolean;
72143
- /**
72144
- * Represents the user's unique ID.
72145
- *
72146
- * @remarks
72147
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72148
- * @beta
72149
- */
72150
- id?: boolean;
72205
+ undoChangeId?: boolean;
72151
72206
  }
72152
72207
  /**
72153
72208
  * Represents a task.
@@ -72169,6 +72224,14 @@ declare namespace Excel {
72169
72224
  * @beta
72170
72225
  */
72171
72226
  comment?: Excel.Interfaces.CommentLoadOptions;
72227
+ /**
72228
+ * Returns a collection of assignees of the task.
72229
+ *
72230
+ * @remarks
72231
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72232
+ * @beta
72233
+ */
72234
+ assignees?: boolean;
72172
72235
  /**
72173
72236
  * Gets the most recent user to have completed the task.
72174
72237
  *
@@ -72201,6 +72264,15 @@ declare namespace Excel {
72201
72264
  * @beta
72202
72265
  */
72203
72266
  createdDateTime?: boolean;
72267
+ /**
72268
+ * Gets or sets the date and time the task is due.
72269
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
72270
+ *
72271
+ * @remarks
72272
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72273
+ * @beta
72274
+ */
72275
+ dueDateTime?: boolean;
72204
72276
  /**
72205
72277
  * Gets the ID of the task.
72206
72278
  *
@@ -72226,13 +72298,14 @@ declare namespace Excel {
72226
72298
  */
72227
72299
  priority?: boolean;
72228
72300
  /**
72229
- * Gets or sets the date and time the task should start and is due.
72301
+ * Gets or sets the date and time the task starts.
72302
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
72230
72303
  *
72231
72304
  * @remarks
72232
72305
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72233
72306
  * @beta
72234
72307
  */
72235
- startAndDueDateTime?: boolean;
72308
+ startDateTime?: boolean;
72236
72309
  /**
72237
72310
  * Specifies title of the task.
72238
72311
  *
@@ -72262,6 +72335,14 @@ declare namespace Excel {
72262
72335
  * @beta
72263
72336
  */
72264
72337
  comment?: Excel.Interfaces.CommentLoadOptions;
72338
+ /**
72339
+ * For EACH ITEM in the collection: Returns a collection of assignees of the task.
72340
+ *
72341
+ * @remarks
72342
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72343
+ * @beta
72344
+ */
72345
+ assignees?: boolean;
72265
72346
  /**
72266
72347
  * For EACH ITEM in the collection: Gets the most recent user to have completed the task.
72267
72348
  *
@@ -72294,6 +72375,15 @@ declare namespace Excel {
72294
72375
  * @beta
72295
72376
  */
72296
72377
  createdDateTime?: boolean;
72378
+ /**
72379
+ * For EACH ITEM in the collection: Gets or sets the date and time the task is due.
72380
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
72381
+ *
72382
+ * @remarks
72383
+ * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72384
+ * @beta
72385
+ */
72386
+ dueDateTime?: boolean;
72297
72387
  /**
72298
72388
  * For EACH ITEM in the collection: Gets the ID of the task.
72299
72389
  *
@@ -72319,13 +72409,14 @@ declare namespace Excel {
72319
72409
  */
72320
72410
  priority?: boolean;
72321
72411
  /**
72322
- * For EACH ITEM in the collection: Gets or sets the date and time the task should start and is due.
72412
+ * For EACH ITEM in the collection: Gets or sets the date and time the task starts.
72413
+ To ensure that calls to `dueDateTime` always occur after calls to `startDateTime`, the DispatchId for `dueDateTime` should be greater than the DispatchId for `startDateTime`.
72323
72414
  *
72324
72415
  * @remarks
72325
72416
  * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72326
72417
  * @beta
72327
72418
  */
72328
- startAndDueDateTime?: boolean;
72419
+ startDateTime?: boolean;
72329
72420
  /**
72330
72421
  * For EACH ITEM in the collection: Specifies title of the task.
72331
72422
  *
@@ -72879,24 +72970,21 @@ declare namespace Excel {
72879
72970
  * Specifies if protection can be paused for this worksheet.
72880
72971
  *
72881
72972
  * @remarks
72882
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72883
- * @beta
72973
+ * [Api set: ExcelApiOnline 1.1]
72884
72974
  */
72885
72975
  canPauseProtection?: boolean;
72886
72976
  /**
72887
72977
  * Specifies if the sheet is password protected.
72888
72978
  *
72889
72979
  * @remarks
72890
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72891
- * @beta
72980
+ * [Api set: ExcelApiOnline 1.1]
72892
72981
  */
72893
72982
  isPasswordProtected?: boolean;
72894
72983
  /**
72895
72984
  * Specifies if worksheet protection is paused.
72896
72985
  *
72897
72986
  * @remarks
72898
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72899
- * @beta
72987
+ * [Api set: ExcelApiOnline 1.1]
72900
72988
  */
72901
72989
  isPaused?: boolean;
72902
72990
  /**
@@ -72914,12 +73002,11 @@ declare namespace Excel {
72914
73002
  */
72915
73003
  protected?: boolean;
72916
73004
  /**
72917
- * Specifies the protection options settings saved in the worksheet.
73005
+ * Specifies the protection options saved in the worksheet.
72918
73006
  This will return the same `WorksheetProtectionOptions` object regardless of the worksheet protection state.
72919
73007
  *
72920
73008
  * @remarks
72921
- * [Api set: ExcelApi BETA (PREVIEW ONLY)]
72922
- * @beta
73009
+ * [Api set: ExcelApiOnline 1.1]
72923
73010
  */
72924
73011
  savedOptions?: boolean;
72925
73012
  }
@@ -73078,7 +73165,7 @@ declare namespace Excel {
73078
73165
  */
73079
73166
  linkedDataTypeState?: boolean;
73080
73167
  /**
73081
- * Represents Excel's number format code for the given range.
73168
+ * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
73082
73169
  *
73083
73170
  * @remarks
73084
73171
  * [Api set: ExcelApi 1.1]
@@ -80236,7 +80323,8 @@ declare namespace Excel {
80236
80323
  */
80237
80324
  font?: Excel.Interfaces.ConditionalRangeFontLoadOptions;
80238
80325
  /**
80239
- * Represents Excel's number format code for the given range. Cleared if `null` is passed in.
80326
+ * Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
80327
+ Cleared if `null` is passed in.
80240
80328
  *
80241
80329
  * @remarks
80242
80330
  * [Api set: ExcelApi 1.6]
@@ -80733,7 +80821,7 @@ declare namespace Excel {
80733
80821
  */
80734
80822
  $all?: boolean;
80735
80823
  /**
80736
- * For EACH ITEM in the collection: Gets the name of the table style.
80824
+ * For EACH ITEM in the collection: Specifies the name of the table style.
80737
80825
  *
80738
80826
  * @remarks
80739
80827
  * [Api set: ExcelApi 1.10]
@@ -80759,7 +80847,7 @@ declare namespace Excel {
80759
80847
  */
80760
80848
  $all?: boolean;
80761
80849
  /**
80762
- * Gets the name of the table style.
80850
+ * Specifies the name of the table style.
80763
80851
  *
80764
80852
  * @remarks
80765
80853
  * [Api set: ExcelApi 1.10]
@@ -80785,7 +80873,7 @@ declare namespace Excel {
80785
80873
  */
80786
80874
  $all?: boolean;
80787
80875
  /**
80788
- * For EACH ITEM in the collection: Gets the name of the PivotTable style.
80876
+ * For EACH ITEM in the collection: Specifies the name of the PivotTable style.
80789
80877
  *
80790
80878
  * @remarks
80791
80879
  * [Api set: ExcelApi 1.10]
@@ -80811,7 +80899,7 @@ declare namespace Excel {
80811
80899
  */
80812
80900
  $all?: boolean;
80813
80901
  /**
80814
- * Gets the name of the PivotTable style.
80902
+ * Specifies the name of the PivotTable style.
80815
80903
  *
80816
80904
  * @remarks
80817
80905
  * [Api set: ExcelApi 1.10]
@@ -80837,7 +80925,7 @@ declare namespace Excel {
80837
80925
  */
80838
80926
  $all?: boolean;
80839
80927
  /**
80840
- * For EACH ITEM in the collection: Gets the name of the slicer style.
80928
+ * For EACH ITEM in the collection: Specifies the name of the slicer style.
80841
80929
  *
80842
80930
  * @remarks
80843
80931
  * [Api set: ExcelApi 1.10]
@@ -80863,7 +80951,7 @@ declare namespace Excel {
80863
80951
  */
80864
80952
  $all?: boolean;
80865
80953
  /**
80866
- * Gets the name of the slicer style.
80954
+ * Specifies the name of the slicer style.
80867
80955
  *
80868
80956
  * @remarks
80869
80957
  * [Api set: ExcelApi 1.10]
@@ -80889,7 +80977,7 @@ declare namespace Excel {
80889
80977
  */
80890
80978
  $all?: boolean;
80891
80979
  /**
80892
- * For EACH ITEM in the collection: Gets the name of the timeline style.
80980
+ * For EACH ITEM in the collection: Specifies the name of the timeline style.
80893
80981
  *
80894
80982
  * @remarks
80895
80983
  * [Api set: ExcelApi 1.10]
@@ -80915,7 +81003,7 @@ declare namespace Excel {
80915
81003
  */
80916
81004
  $all?: boolean;
80917
81005
  /**
80918
- * Gets the name of the timeline style.
81006
+ * Specifies the name of the timeline style.
80919
81007
  *
80920
81008
  * @remarks
80921
81009
  * [Api set: ExcelApi 1.10]
@@ -81399,7 +81487,7 @@ declare namespace Excel {
81399
81487
  */
81400
81488
  linkedDataTypeState?: boolean;
81401
81489
  /**
81402
- * For EACH ITEM in the collection: Represents Excel's number format code for the given range.
81490
+ * For EACH ITEM in the collection: Represents Excel's number format code for the given range. For more information about Excel number formatting, see {@link https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68 | Number format codes}.
81403
81491
  *
81404
81492
  * @remarks
81405
81493
  * [Api set: ExcelApi 1.1]