@types/office-js-preview 1.0.374 → 1.0.375

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ This package contains type definitions for Office.js (https://github.com/OfficeD
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 21 Feb 2023 23:32:39 GMT
11
+ * Last updated: Tue, 28 Feb 2023 21:32:42 GMT
12
12
  * Dependencies: none
13
13
  * Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
14
14
 
@@ -987,6 +987,19 @@ declare namespace Office {
987
987
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
988
988
  */
989
989
  roamingSettings: Office.RoamingSettings;
990
+ /**
991
+ * Gets the object to check the status of the catalog of sensitivity labels in Outlook and retrieve all available
992
+ * sensitivity labels if the catalog is enabled.
993
+ *
994
+ * @remarks
995
+ *
996
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
997
+ *
998
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
999
+ *
1000
+ * @beta
1001
+ */
1002
+ sensitivityLabelsCatalog: Office.SensitivityLabelsCatalog;
990
1003
  /**
991
1004
  * Specifies whether the platform and device allows touch interaction.
992
1005
  * True if the add-in is running on a touch device, such as an iPad; false otherwise.
@@ -2406,6 +2419,19 @@ declare namespace Office {
2406
2419
  * [Api set: Mailbox preview]
2407
2420
  */
2408
2421
  SelectedItemsChanged,
2422
+ /**
2423
+ * Occurs in Outlook when the sensitivity label of a message or appointment changes.
2424
+ * **Important**: This event can only be handled in a task pane. It isn't supported by function commands.
2425
+ *
2426
+ * To add an event handler for the `SensitivityLabelChanged` event, use the `addHandlerAsync` method of the `Item` object.
2427
+ * The event handler receives an argument of type
2428
+ * {@link https://learn.microsoft.com/javascript/api/outlook/office.sensitivitylabelchangedeventargs?view=outlook-js-preview | Office.SensitivityLabelChangedEventArgs}.
2429
+ *
2430
+ * [Api set: Mailbox preview]
2431
+ *
2432
+ * @beta
2433
+ */
2434
+ SensitivityLabelChanged,
2409
2435
  /**
2410
2436
  * A Settings.settingsChanged event was raised.
2411
2437
  *
@@ -9870,6 +9896,19 @@ declare namespace Office {
9870
9896
  * @beta
9871
9897
  */
9872
9898
  sensitivity: Sensitivity;
9899
+ /**
9900
+ * Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of an appointment.
9901
+ *
9902
+ * @remarks
9903
+ * [Api set: Mailbox preview]
9904
+ *
9905
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
9906
+ *
9907
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer
9908
+ *
9909
+ * @beta
9910
+ */
9911
+ sensitivityLabel: SensitivityLabel;
9873
9912
  /**
9874
9913
  * Gets the ID of the series that an instance belongs to.
9875
9914
  *
@@ -10015,13 +10054,13 @@ declare namespace Office {
10015
10054
  /**
10016
10055
  * Adds a file to a message or appointment as an attachment.
10017
10056
  *
10018
- * The `addFileAttachmentFromBase64Async` method uploads the file from the base64 encoding and attaches it to the item in the compose form.
10057
+ * The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
10019
10058
  * This method returns the attachment identifier in the `asyncResult.value` object.
10020
10059
  *
10021
10060
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
10022
10061
  *
10023
10062
  * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
10024
- * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of base64 string>`, remove `data:image/svg+xml;base64,`.
10063
+ * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
10025
10064
  *
10026
10065
  * @remarks
10027
10066
  * [Api set: Mailbox 1.8]
@@ -10034,16 +10073,16 @@ declare namespace Office {
10034
10073
  *
10035
10074
  * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
10036
10075
  *
10037
- * - `FileTypeNotSupported`: The attachment has an extension that is not allowed.
10076
+ * - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
10038
10077
  *
10039
10078
  * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
10040
10079
  *
10041
- * **Note**: If you're adding an inline base64 image to the body of a message or appointment being composed, you must first get the current item body using the
10080
+ * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
10042
10081
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
10043
- * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image will not render in the body once it's inserted.
10082
+ * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
10044
10083
  * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
10045
10084
  *
10046
- * @param base64File - The base64 encoded content of an image or file to be added to an email or event.
10085
+ * @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
10047
10086
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
10048
10087
  * @param options - An object literal that contains one or more of the following properties:-
10049
10088
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -10059,13 +10098,13 @@ declare namespace Office {
10059
10098
  /**
10060
10099
  * Adds a file to a message or appointment as an attachment.
10061
10100
  *
10062
- * The `addFileAttachmentFromBase64Async` method uploads the file from the base64 encoding and attaches it to the item in the compose form.
10101
+ * The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
10063
10102
  * This method returns the attachment identifier in the `asyncResult.value` object.
10064
10103
  *
10065
10104
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
10066
10105
  *
10067
10106
  * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
10068
- * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of base64 string>`, remove `data:image/svg+xml;base64,`.
10107
+ * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
10069
10108
  *
10070
10109
  * @remarks
10071
10110
  * [Api set: Mailbox 1.8]
@@ -10078,16 +10117,16 @@ declare namespace Office {
10078
10117
  *
10079
10118
  * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
10080
10119
  *
10081
- * - `FileTypeNotSupported`: The attachment has an extension that is not allowed.
10120
+ * - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
10082
10121
  *
10083
10122
  * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
10084
10123
  *
10085
- * **Note**: If you're adding an inline base64 image to the body of a message or appointment being composed, you must first get the current item body using the
10124
+ * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
10086
10125
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
10087
- * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image will not render in the body once it's inserted.
10126
+ * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
10088
10127
  * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
10089
10128
  *
10090
- * @param base64File - The base64 encoded content of an image or file to be added to an email or event.
10129
+ * @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
10091
10130
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
10092
10131
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter
10093
10132
  * of type `Office.AsyncResult`.
@@ -15182,6 +15221,19 @@ declare namespace Office {
15182
15221
  * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15183
15222
  */
15184
15223
  notificationMessages: NotificationMessages;
15224
+ /**
15225
+ * Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.
15226
+ *
15227
+ * @remarks
15228
+ * [Api set: Mailbox preview]
15229
+ *
15230
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
15231
+ *
15232
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Compose
15233
+ *
15234
+ * @beta
15235
+ */
15236
+ sensitivityLabel: SensitivityLabel;
15185
15237
  /**
15186
15238
  * Gets the ID of the series that an instance belongs to.
15187
15239
  *
@@ -15322,13 +15374,13 @@ declare namespace Office {
15322
15374
  /**
15323
15375
  * Adds a file to a message or appointment as an attachment.
15324
15376
  *
15325
- * The `addFileAttachmentFromBase64Async` method uploads the file from the base64 encoding and attaches it to the item in the compose form.
15377
+ * The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
15326
15378
  * This method returns the attachment identifier in the `asyncResult.value` object.
15327
15379
  *
15328
15380
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
15329
15381
  *
15330
15382
  * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
15331
- * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of base64 string>`, remove `data:image/svg+xml;base64,`.
15383
+ * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
15332
15384
  *
15333
15385
  * @remarks
15334
15386
  * [Api set: Mailbox 1.8]
@@ -15341,16 +15393,16 @@ declare namespace Office {
15341
15393
  *
15342
15394
  * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
15343
15395
  *
15344
- * - `FileTypeNotSupported`: The attachment has an extension that is not allowed.
15396
+ * - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
15345
15397
  *
15346
15398
  * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
15347
15399
  *
15348
- * **Note**: If you're adding an inline base64 image to the body of a message or appointment being composed, you must first get the current item body using the
15400
+ * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
15349
15401
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
15350
- * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image will not render in the body once it's inserted.
15402
+ * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
15351
15403
  * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
15352
15404
  *
15353
- * @param base64File - The base64-encoded content of an image or file to be added to an email or event.
15405
+ * @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
15354
15406
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
15355
15407
  * @param options - An object literal that contains one or more of the following properties:-
15356
15408
  * `asyncContext`: Developers can provide any object they wish to access in the callback function.
@@ -15363,13 +15415,13 @@ declare namespace Office {
15363
15415
  /**
15364
15416
  * Adds a file to a message or appointment as an attachment.
15365
15417
  *
15366
- * The `addFileAttachmentFromBase64Async` method uploads the file from the base64 encoding and attaches it to the item in the compose form.
15418
+ * The `addFileAttachmentFromBase64Async` method uploads the file from the Base64 encoding and attaches it to the item in the compose form.
15367
15419
  * This method returns the attachment identifier in the `asyncResult.value` object.
15368
15420
  *
15369
15421
  * You can subsequently use the identifier with the `removeAttachmentAsync` method to remove the attachment in the same session.
15370
15422
  *
15371
15423
  * **Note**: If you're using a data URL API (e.g., `readAsDataURL`), you need to strip out the data URL prefix then send the rest of the string to this API.
15372
- * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of base64 string>`, remove `data:image/svg+xml;base64,`.
15424
+ * For example, if the full string is represented by `data:image/svg+xml;base64,<rest of Base64 string>`, remove `data:image/svg+xml;base64,`.
15373
15425
  *
15374
15426
  * @remarks
15375
15427
  * [Api set: Mailbox 1.8]
@@ -15382,16 +15434,16 @@ declare namespace Office {
15382
15434
  *
15383
15435
  * - `AttachmentSizeExceeded`: The attachment is larger than allowed.
15384
15436
  *
15385
- * - `FileTypeNotSupported`: The attachment has an extension that is not allowed.
15437
+ * - `FileTypeNotSupported`: The attachment has an extension that isn't allowed.
15386
15438
  *
15387
15439
  * - `NumberOfAttachmentsExceeded`: The message or appointment has too many attachments.
15388
15440
  *
15389
- * **Note**: If you're adding an inline base64 image to the body of a message or appointment being composed, you must first get the current item body using the
15441
+ * **Note**: If you're adding an inline Base64 image to the body of a message or appointment being composed, you must first get the current item body using the
15390
15442
  * {@link https://learn.microsoft.com/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1) | Office.context.mailbox.item.body.getAsync}
15391
- * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image will not render in the body once it's inserted.
15443
+ * method before inserting the image using `addFileAttachmentFromBase64Async`. Otherwise, the image won't render in the body once it's inserted.
15392
15444
  * For further guidance, see {@link https://learn.microsoft.com/office/dev/add-ins/outlook/add-and-remove-attachments-to-an-item-in-a-compose-form#attach-a-file | Attach a file}.
15393
15445
  *
15394
- * @param base64File - The base64-encoded content of an image or file to be added to an email or event.
15446
+ * @param base64File - The Base64-encoded content of an image or file to be added to an email or event. The maximum length of the encoded string is 27,892,122 characters (about 25 MB).
15395
15447
  * @param attachmentName - The name of the attachment that is shown while the attachment is uploading. The maximum length is 255 characters.
15396
15448
  * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter of
15397
15449
  * type Office.AsyncResult. On success, the attachment identifier will be provided in the `asyncResult.value` property.
@@ -18489,6 +18541,259 @@ declare namespace Office {
18489
18541
  */
18490
18542
  setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18491
18543
  }
18544
+ /**
18545
+ * Provides methods to get or set the sensitivity label of a message or appointment. For more information on sensitivity labels, see
18546
+ * {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | Learn about sensitivity labels}.
18547
+ *
18548
+ * @remarks
18549
+ * [Api set: Mailbox preview]
18550
+ *
18551
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18552
+ *
18553
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18554
+ *
18555
+ * @beta
18556
+ */
18557
+ interface SensitivityLabel {
18558
+ /**
18559
+ * Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
18560
+ *
18561
+ * @remarks
18562
+ * [Api set: Mailbox preview]
18563
+ *
18564
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18565
+ *
18566
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18567
+ *
18568
+ * @param options - An object literal that contains one or more of the following properties:-
18569
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18570
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18571
+ * which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
18572
+ * `asyncResult.value` property.
18573
+ *
18574
+ * @beta
18575
+ */
18576
+ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;
18577
+ /**
18578
+ * Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.
18579
+ *
18580
+ * @remarks
18581
+ * [Api set: Mailbox preview]
18582
+ *
18583
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18584
+ *
18585
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18586
+ *
18587
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18588
+ * which is an `Office.AsyncResult` object. The sensitivity label's GUID is returned in the
18589
+ * `asyncResult.value` property.
18590
+ *
18591
+ * @beta
18592
+ */
18593
+ getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;
18594
+ /**
18595
+ * Applies the specified sensitivity label to the message or appointment being composed.
18596
+ *
18597
+ * @remarks
18598
+ * [Api set: Mailbox preview]
18599
+ *
18600
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18601
+ *
18602
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18603
+ *
18604
+ * **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
18605
+ *
18606
+ * @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
18607
+ * unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
18608
+ * @param options - An object literal that contains one or more of the following properties:-
18609
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18610
+ * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18611
+ * which is an `Office.AsyncResult` object.
18612
+ *
18613
+ * @beta
18614
+ */
18615
+ setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18616
+ /**
18617
+ * Applies the specified sensitivity label to the message or appointment being composed.
18618
+ *
18619
+ * @remarks
18620
+ * [Api set: Mailbox preview]
18621
+ *
18622
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18623
+ *
18624
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18625
+ *
18626
+ * **Tip**: To determine the sensitivity labels available for use, call the `Office.context.sensitivityLabelsCatalog.getAsync` method.
18627
+ *
18628
+ * @param sensitivityLabel - The sensitivity label to be applied to the message or appointment being composed. The parameter value can be a sensitivity label's
18629
+ * unique identifier (GUID) or a {@link Office.SensitivityLabelDetails | SensitivityLabelDetails} object.
18630
+ * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18631
+ * which is an `Office.AsyncResult` object.
18632
+ *
18633
+ * @beta
18634
+ */
18635
+ setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
18636
+ }
18637
+ /**
18638
+ * Provides the change status of the sensitivity label applied to a message or appointment in compose mode. This information is provided when the
18639
+ * `Office.EventType.SensitivityLabelChanged` event is raised.
18640
+ *
18641
+ * @remarks
18642
+ * [Api set: Mailbox preview]
18643
+ *
18644
+ * @beta
18645
+ */
18646
+ export interface SensitivityLabelChangedEventArgs {
18647
+ /**
18648
+ * The type of event that was raised. For details, refer to {@link https://learn.microsoft.com/javascript/api/office/office.eventtype | Office.EventType}.
18649
+ *
18650
+ * @remarks
18651
+ * [Api set: Mailbox preview]
18652
+ *
18653
+ * @beta
18654
+ */
18655
+ type: "olkSensitivityLabelChanged";
18656
+ }
18657
+ /**
18658
+ * Represents the properties of available sensitivity labels in Outlook.
18659
+ *
18660
+ * @remarks
18661
+ * [Api set: Mailbox preview]
18662
+ *
18663
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18664
+ *
18665
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18666
+ *
18667
+ * @beta
18668
+ */
18669
+ interface SensitivityLabelDetails {
18670
+ /**
18671
+ * The color of the sensitivity label.
18672
+ *
18673
+ * @beta
18674
+ */
18675
+ color: string;
18676
+ /**
18677
+ * The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.
18678
+ * Returns `null` if a label doesn't have any sublabels.
18679
+ *
18680
+ * @beta
18681
+ */
18682
+ children: SensitivityLabelDetails[];
18683
+ /**
18684
+ * The unique identifier (GUID) of the sensitivity label.
18685
+ *
18686
+ * @beta
18687
+ */
18688
+ id: string;
18689
+ /**
18690
+ * The name of the sensitivity label.
18691
+ *
18692
+ * @beta
18693
+ */
18694
+ name: string;
18695
+ /**
18696
+ * The description of the sensitivity label.
18697
+ *
18698
+ * @beta
18699
+ */
18700
+ tooltip: string;
18701
+ }
18702
+ /**
18703
+ * Provides methods to check the status of the catalog of {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels | sensitivity labels}
18704
+ * in Outlook and retrieve all available sensitivity labels if the catalog is enabled.
18705
+ *
18706
+ * @remarks
18707
+ * [Api set: Mailbox preview]
18708
+ *
18709
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18710
+ *
18711
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18712
+ *
18713
+ * @beta
18714
+ */
18715
+ export interface SensitivityLabelsCatalog {
18716
+ /**
18717
+ * Gets all the sensitivity labels that are enabled in Outlook.
18718
+ *
18719
+ * @remarks
18720
+ * [Api set: Mailbox preview]
18721
+ *
18722
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18723
+ *
18724
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18725
+ *
18726
+ * **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
18727
+ *
18728
+ * @param options - An object literal that contains one or more of the following properties:-
18729
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18730
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18731
+ * which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
18732
+ * `asyncResult.value` property.
18733
+ *
18734
+ * @beta
18735
+ */
18736
+ getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
18737
+ /**
18738
+ * Gets all the sensitivity labels that are enabled in Outlook.
18739
+ *
18740
+ * @remarks
18741
+ * [Api set: Mailbox preview]
18742
+ *
18743
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18744
+ *
18745
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18746
+ *
18747
+ * **Recommended**: To determine whether the catalog of sensitivity labels is enabled in Outlook, call `getIsEnabledAsync` before using `getAsync`.
18748
+ *
18749
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18750
+ * which is an `Office.AsyncResult` object. The available sensitivity labels and their properties are returned in the
18751
+ * `asyncResult.value` property.
18752
+ *
18753
+ * @beta
18754
+ */
18755
+ getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;
18756
+ /**
18757
+ * Checks whether the catalog of sensitivity labels is enabled in Outlook.
18758
+ *
18759
+ * @remarks
18760
+ * [Api set: Mailbox preview]
18761
+ *
18762
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18763
+ *
18764
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18765
+ *
18766
+ * **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
18767
+ * {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
18768
+ *
18769
+ * @param options - An object literal that contains one or more of the following properties:-
18770
+ * `asyncContext`: Developers can provide any object they wish to access in the callback function.
18771
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18772
+ * which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
18773
+ *
18774
+ * @beta
18775
+ */
18776
+ getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
18777
+ /**
18778
+ * Checks whether the catalog of sensitivity labels is enabled in Outlook.
18779
+ *
18780
+ * @remarks
18781
+ * [Api set: Mailbox preview]
18782
+ *
18783
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read/write item**
18784
+ *
18785
+ * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
18786
+ *
18787
+ * **Important**: The catalog of sensitivity labels is configured by an organization's administrator. For more information, see
18788
+ * {@link https://learn.microsoft.com/microsoft-365/compliance/get-started-with-sensitivity-labels | Get started with sensitivity labels}.
18789
+ *
18790
+ * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`,
18791
+ * which is an `Office.AsyncResult` object. The status of the catalog of sensitivity labels is returned in the `asyncResult.value` property.
18792
+ *
18793
+ * @beta
18794
+ */
18795
+ getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;
18796
+ }
18492
18797
  /**
18493
18798
  * The `SeriesTime` object provides methods to get and set the dates and times of appointments in a recurring series and get the dates and times
18494
18799
  * of meeting requests in a recurring series.
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/office-js-preview",
3
- "version": "1.0.374",
3
+ "version": "1.0.375",
4
4
  "description": "TypeScript definitions for Office.js",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/office-js-preview",
6
6
  "license": "MIT",
@@ -45,6 +45,6 @@
45
45
  },
46
46
  "scripts": {},
47
47
  "dependencies": {},
48
- "typesPublisherContentHash": "401eb24631e00439d5eeef146e20281b28a2704fe435dfd27570a0223eb272ee",
48
+ "typesPublisherContentHash": "279a356a6f93bcaf0693b322e9031ea2a2c36e82051927e7a59cee9709a4318c",
49
49
  "typeScriptVersion": "4.2"
50
50
  }