@types/office-js-preview 1.0.409 → 1.0.410
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.
- office-js-preview/README.md +1 -1
- office-js-preview/index.d.ts +256 -161
- office-js-preview/package.json +2 -2
office-js-preview/README.md
CHANGED
|
@@ -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:
|
|
11
|
+
* Last updated: Tue, 29 Aug 2023 20:03:01 GMT
|
|
12
12
|
* Dependencies: none
|
|
13
13
|
* Global values: `Excel`, `Office`, `OfficeCore`, `OfficeExtension`, `OneNote`, `PowerPoint`, `Visio`, `Word`
|
|
14
14
|
|
office-js-preview/index.d.ts
CHANGED
|
@@ -1047,6 +1047,13 @@ declare namespace Office {
|
|
|
1047
1047
|
*
|
|
1048
1048
|
* @remarks
|
|
1049
1049
|
*
|
|
1050
|
+
* For information on support in Excel, Word, and PowerPoint, see
|
|
1051
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets}.
|
|
1052
|
+
*
|
|
1053
|
+
* The following outlines support information for Outlook.
|
|
1054
|
+
*
|
|
1055
|
+
* [Api set: Mailbox 1.3]
|
|
1056
|
+
*
|
|
1050
1057
|
* See {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
|
|
1051
1058
|
*
|
|
1052
1059
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
@@ -1059,7 +1066,13 @@ declare namespace Office {
|
|
|
1059
1066
|
*
|
|
1060
1067
|
* @remarks
|
|
1061
1068
|
*
|
|
1062
|
-
*
|
|
1069
|
+
* The following outlines support information for Outlook.
|
|
1070
|
+
*
|
|
1071
|
+
* [Api set: Mailbox 1.3]
|
|
1072
|
+
*
|
|
1073
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
1074
|
+
*
|
|
1075
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
1063
1076
|
*/
|
|
1064
1077
|
source:Source;
|
|
1065
1078
|
/**
|
|
@@ -1067,202 +1080,90 @@ declare namespace Office {
|
|
|
1067
1080
|
*
|
|
1068
1081
|
* This method must be called at the end of a function which was invoked by the following:
|
|
1069
1082
|
*
|
|
1070
|
-
* - A function command button (that is, an add-in command defined with an
|
|
1083
|
+
* - A function command button (that is, an add-in command defined with an **\<Action\>** element, where the `xsi:type` attribute is set to `ExecuteFunction`).
|
|
1071
1084
|
*
|
|
1072
|
-
* - An event defined in the {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#launchevent | LaunchEvent extension point}.
|
|
1073
|
-
* For example, an `OnMessageSend` event.
|
|
1074
|
-
*
|
|
1075
1085
|
* - An {@link https://learn.microsoft.com/javascript/api/manifest/event | event} defined in the
|
|
1076
|
-
* {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point}
|
|
1077
|
-
*
|
|
1078
|
-
* - An event defined in the
|
|
1079
|
-
* {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint?view=outlook-js-preview&preserve-view=true#reportphishingcommandsurface-preview | ReportPhishingCommandSurface extension point (preview)}.
|
|
1086
|
+
* {@link https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events | Events extension point} of an on-send add-in in Outlook.
|
|
1087
|
+
* For example, an `ItemSend` event.
|
|
1080
1088
|
*
|
|
1081
1089
|
* @remarks
|
|
1082
1090
|
*
|
|
1091
|
+
* The following outlines support information for Outlook.
|
|
1092
|
+
*
|
|
1083
1093
|
* [Api set: Mailbox 1.3]
|
|
1084
|
-
*
|
|
1094
|
+
*
|
|
1085
1095
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
1086
1096
|
*
|
|
1087
1097
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
1088
1098
|
*
|
|
1089
|
-
* **
|
|
1099
|
+
* **Important**: The `options` parameter only applies to Outlook add-ins that implement the
|
|
1100
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send feature}. It was introduced in Mailbox 1.8.
|
|
1090
1101
|
*
|
|
1091
|
-
* @param options Optional. An object that specifies behavior
|
|
1102
|
+
* @param options Optional. An object that specifies the behavior of an on-send add-in in Outlook when it completes processing an `ItemSend` event.
|
|
1092
1103
|
*/
|
|
1093
1104
|
completed(options?: EventCompletedOptions): void;
|
|
1094
1105
|
}
|
|
1095
1106
|
/**
|
|
1096
|
-
* Specifies the behavior
|
|
1107
|
+
* Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins | on-send} add-in in Outlook
|
|
1108
|
+
* when it completes processing an `ItemSend` event.
|
|
1109
|
+
*
|
|
1110
|
+
* @remarks
|
|
1111
|
+
*
|
|
1112
|
+
* [Api set: Mailbox 1.8]
|
|
1113
|
+
*
|
|
1114
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
1115
|
+
*
|
|
1116
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
1097
1117
|
*/
|
|
1098
1118
|
interface EventCompletedOptions {
|
|
1099
1119
|
/**
|
|
1100
1120
|
* When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
|
|
1101
|
-
* to signal completion of an event handler, this
|
|
1102
|
-
* For example, an add-in that handles the `
|
|
1103
|
-
* sending of an item. For a complete sample, see the
|
|
1104
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
1105
|
-
*
|
|
1106
|
-
* **Important**: Only applicable to add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
1121
|
+
* to signal completion of an event handler, this value indicates if the handled event should continue execution or be canceled.
|
|
1122
|
+
* For example, an on-send add-in that handles the `ItemSend` event can set `allowEvent` to `false` to cancel the sending of a message.
|
|
1107
1123
|
*
|
|
1108
1124
|
* @remarks
|
|
1109
1125
|
*
|
|
1110
1126
|
* [Api set: Mailbox 1.8]
|
|
1111
|
-
*
|
|
1112
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
1113
|
-
*
|
|
1114
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
1115
|
-
*/
|
|
1116
|
-
allowEvent?: boolean;
|
|
1117
|
-
/**
|
|
1118
|
-
* When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
|
|
1119
|
-
* to signal completion of an event handler and set its `allowEvent` property to `false`, this property sets the error message
|
|
1120
|
-
* that will be displayed to the user. For an example, see the
|
|
1121
|
-
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
1122
1127
|
*
|
|
1123
|
-
* **Important**: Only applicable to add-ins that implement {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}.
|
|
1124
|
-
*
|
|
1125
|
-
* @remarks
|
|
1126
|
-
*
|
|
1127
|
-
* [Api set: Mailbox 1.12]
|
|
1128
|
-
*
|
|
1129
1128
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
1130
1129
|
*
|
|
1131
1130
|
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
1132
1131
|
*/
|
|
1133
|
-
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
|
|
1141
|
-
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
* the `folderName` property is ignored.
|
|
1155
|
-
*
|
|
1156
|
-
* @beta
|
|
1157
|
-
*/
|
|
1158
|
-
folderName?: string;
|
|
1159
|
-
/**
|
|
1160
|
-
* When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
|
|
1161
|
-
* to signal that a reported message has finished processing, this property specifies whether the message is moved to a different folder in the mailbox.
|
|
1162
|
-
*
|
|
1163
|
-
* **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
|
|
1164
|
-
*
|
|
1165
|
-
* @remarks
|
|
1166
|
-
*
|
|
1167
|
-
* [Api set: Mailbox preview]
|
|
1168
|
-
*
|
|
1169
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
1170
|
-
*
|
|
1171
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
1172
|
-
*
|
|
1173
|
-
* **Important**:
|
|
1174
|
-
*
|
|
1175
|
-
* In Outlook on Windows, you can only use this property in a spam-reporting add-in starting in Version 2308 (Build 16724.10000).
|
|
1176
|
-
* If you're using an earlier build that supports the integrated spam-reporting feature, use the `postProcessingAction`
|
|
1177
|
-
* property instead.
|
|
1178
|
-
*
|
|
1179
|
-
* If the property is set to `Office.MailboxEnums.MoveSpamItemTo.CustomFolder`, you must specify the name of the folder to which
|
|
1180
|
-
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `moveItemTo` property will default to
|
|
1181
|
-
* `Office.MailboxEnums.MoveSpamItemTo.JunkFolder` and move the reported message to the **Junk Email** folder.
|
|
1182
|
-
*
|
|
1183
|
-
* @beta
|
|
1184
|
-
*/
|
|
1185
|
-
moveItemTo?: Office.MailboxEnums.MoveSpamItemTo;
|
|
1186
|
-
/**
|
|
1187
|
-
* When set to `true`, deletes a reported message if an error occurs while the message is processed.
|
|
1188
|
-
* If this property is set to `false` or isn't specified in the
|
|
1189
|
-
* {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method},
|
|
1190
|
-
* the reported message remains in its current mailbox folder.
|
|
1191
|
-
*
|
|
1192
|
-
* **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
|
|
1193
|
-
*
|
|
1194
|
-
* @remarks
|
|
1195
|
-
*
|
|
1196
|
-
* [Api set: Mailbox preview]
|
|
1197
|
-
*
|
|
1198
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
1199
|
-
*
|
|
1200
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
1201
|
-
*
|
|
1202
|
-
* @beta
|
|
1203
|
-
*/
|
|
1204
|
-
onErrorDeleteItem?: boolean;
|
|
1132
|
+
allowEvent?: boolean;
|
|
1133
|
+
}
|
|
1134
|
+
/**
|
|
1135
|
+
* Encapsulates source data for add-in events.
|
|
1136
|
+
*
|
|
1137
|
+
* @remarks
|
|
1138
|
+
*
|
|
1139
|
+
* For information on support in Excel, Word, and PowerPoint, see
|
|
1140
|
+
* {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets}.
|
|
1141
|
+
*
|
|
1142
|
+
* The following outlines support information for Outlook.
|
|
1143
|
+
*
|
|
1144
|
+
* [Api set: Mailbox 1.3]
|
|
1145
|
+
*
|
|
1146
|
+
* See {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
|
|
1147
|
+
*
|
|
1148
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
1149
|
+
*
|
|
1150
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
1151
|
+
*/
|
|
1152
|
+
interface Source {
|
|
1205
1153
|
/**
|
|
1206
|
-
*
|
|
1207
|
-
* to signal that a reported message has finished processing, this property specifies whether the message is moved to a different folder in the mailbox.
|
|
1208
|
-
* The following post-processing actions are available.
|
|
1209
|
-
*
|
|
1210
|
-
* - `delete` - Moves the reported message to the **Deleted Items** folder of the mailbox.
|
|
1211
|
-
*
|
|
1212
|
-
* - `moveToCustomFolder` - Moves the reported message to a specified folder. You must specify the name of the folder in the `folderName` property.
|
|
1213
|
-
*
|
|
1214
|
-
* - `moveToSpamFolder` - Moves the reported message to the **Junk Email** folder of the mailbox.
|
|
1215
|
-
*
|
|
1216
|
-
* - `noMove` - Leaves the reported message in its current folder.
|
|
1217
|
-
*
|
|
1218
|
-
* **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
|
|
1154
|
+
* The ID of the control that triggered calling this function. The ID comes from the manifest.
|
|
1219
1155
|
*
|
|
1220
1156
|
* @remarks
|
|
1221
1157
|
*
|
|
1222
|
-
*
|
|
1223
|
-
*
|
|
1224
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
1225
|
-
*
|
|
1226
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
1227
|
-
*
|
|
1228
|
-
* **Important**:
|
|
1229
|
-
*
|
|
1230
|
-
* In Outlook on Windows, you can only use this property in earlier builds that support the integrated spam-reporting feature.
|
|
1231
|
-
* If you're on Version 2308 (Build 16724.10000) or later, use the `moveItemTo` property instead.
|
|
1232
|
-
*
|
|
1233
|
-
* If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which
|
|
1234
|
-
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to
|
|
1235
|
-
* `moveToSpamFolder` and move the reported message to the **Junk Email** folder.
|
|
1236
|
-
*
|
|
1237
|
-
* @beta
|
|
1238
|
-
*/
|
|
1239
|
-
postProcessingAction?: string;
|
|
1240
|
-
/**
|
|
1241
|
-
* When you use the {@link https://learn.microsoft.com/javascript/api/office/office.addincommands.event#office-office-addincommands-event-completed-member(1) | completed method}
|
|
1242
|
-
* to signal that a reported message has finished processing, this property indicates if a post-processing dialog is shown to the user. The JSON object assigned to this property
|
|
1243
|
-
* must contain a title and a description. If this property isn't specified, a dialog isn't shown to the user once their reported message is processed.
|
|
1244
|
-
*
|
|
1245
|
-
* **Important**: Only applicable to add-ins that implement the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
|
|
1246
|
-
*
|
|
1247
|
-
* @remarks
|
|
1158
|
+
* The following outlines support information for Outlook.
|
|
1248
1159
|
*
|
|
1249
|
-
* [Api set: Mailbox
|
|
1160
|
+
* [Api set: Mailbox 1.3]
|
|
1250
1161
|
*
|
|
1251
|
-
*
|
|
1162
|
+
* See {@link https://learn.microsoft.com/javascript/api/requirement-sets/common/add-in-commands-requirement-sets | Add-in commands requirement sets} for more support information.
|
|
1252
1163
|
*
|
|
1253
|
-
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-
|
|
1164
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
1254
1165
|
*
|
|
1255
|
-
* @
|
|
1256
|
-
*/
|
|
1257
|
-
showPostProcessingDialog?: object;
|
|
1258
|
-
}
|
|
1259
|
-
/**
|
|
1260
|
-
* Encapsulates source data for add-in events.
|
|
1261
|
-
*/
|
|
1262
|
-
interface Source {
|
|
1263
|
-
|
|
1264
|
-
/**
|
|
1265
|
-
* The ID of the control that triggered calling this function. The ID comes from the manifest.
|
|
1166
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
1266
1167
|
*/
|
|
1267
1168
|
id: string;
|
|
1268
1169
|
}
|
|
@@ -15299,6 +15200,35 @@ declare namespace Office {
|
|
|
15299
15200
|
*/
|
|
15300
15201
|
removeHandlerAsync(eventType: Office.EventType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
|
|
15301
15202
|
}
|
|
15203
|
+
/**
|
|
15204
|
+
* The `MailboxEvent` object is passed as an argument to the event handler of an add-in that implements
|
|
15205
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/autolaunch | event-based activation}, including
|
|
15206
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts},
|
|
15207
|
+
* or the {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting feature}.
|
|
15208
|
+
* It allows the add-in to signify to the Outlook client that it has completed processing an event.
|
|
15209
|
+
*
|
|
15210
|
+
* @remarks
|
|
15211
|
+
* [Api set: Mailbox 1.10]
|
|
15212
|
+
*
|
|
15213
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
15214
|
+
*
|
|
15215
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15216
|
+
*/
|
|
15217
|
+
interface MailboxEvent {
|
|
15218
|
+
/**
|
|
15219
|
+
* Indicates that the event-based or spam-reporting add-in has completed processing an event.
|
|
15220
|
+
*
|
|
15221
|
+
* @remarks
|
|
15222
|
+
* [Api set: Mailbox 1.10]
|
|
15223
|
+
*
|
|
15224
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **restricted**
|
|
15225
|
+
*
|
|
15226
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read
|
|
15227
|
+
*
|
|
15228
|
+
* @param options - Optional. An object that specifies the behavior of an event-based or spam-reporting add-in when it completes processing an event.
|
|
15229
|
+
*/
|
|
15230
|
+
completed(options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions): void;
|
|
15231
|
+
}
|
|
15302
15232
|
/**
|
|
15303
15233
|
* Represents the categories master list on the mailbox.
|
|
15304
15234
|
*
|
|
@@ -19815,6 +19745,42 @@ declare namespace Office {
|
|
|
19815
19745
|
*/
|
|
19816
19746
|
delegatePermissions: MailboxEnums.DelegatePermissions;
|
|
19817
19747
|
}
|
|
19748
|
+
/**
|
|
19749
|
+
* Specifies the behavior of a {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts add-in}
|
|
19750
|
+
* when it completes processing an `OnMessageSend` or `OnAppointmentSend` event.
|
|
19751
|
+
*/
|
|
19752
|
+
interface SmartAlertsEventCompletedOptions {
|
|
19753
|
+
/**
|
|
19754
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler,
|
|
19755
|
+
* this value indicates if the handled event should continue execution or be canceled.
|
|
19756
|
+
* For example, an add-in that handles the `OnMessageSend` or `OnAppointmentSend` event can set `allowEvent` to `false` to cancel the sending of an item.
|
|
19757
|
+
* For a complete sample, see the
|
|
19758
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
19759
|
+
*
|
|
19760
|
+
* @remarks
|
|
19761
|
+
*
|
|
19762
|
+
* [Api set: Mailbox 1.12]
|
|
19763
|
+
*
|
|
19764
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
19765
|
+
*
|
|
19766
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19767
|
+
*/
|
|
19768
|
+
allowEvent?: boolean;
|
|
19769
|
+
/**
|
|
19770
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal completion of an event handler and set its `allowEvent` property
|
|
19771
|
+
* to `false`, this property sets the error message that will be displayed to the user. For an example, see the
|
|
19772
|
+
* {@link https://learn.microsoft.com/office/dev/add-ins/outlook/smart-alerts-onmessagesend-walkthrough | Smart Alerts walkthrough}.
|
|
19773
|
+
*
|
|
19774
|
+
* @remarks
|
|
19775
|
+
*
|
|
19776
|
+
* [Api set: Mailbox 1.12]
|
|
19777
|
+
*
|
|
19778
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **restricted**
|
|
19779
|
+
*
|
|
19780
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose
|
|
19781
|
+
*/
|
|
19782
|
+
errorMessage?: string;
|
|
19783
|
+
}
|
|
19818
19784
|
/**
|
|
19819
19785
|
* Provides information about the `Office.EventType.SpamReporting` event that occurs when an unsolicited message is reported.
|
|
19820
19786
|
*
|
|
@@ -19834,6 +19800,135 @@ declare namespace Office {
|
|
|
19834
19800
|
*/
|
|
19835
19801
|
type: "SpamReporting";
|
|
19836
19802
|
}
|
|
19803
|
+
/**
|
|
19804
|
+
* Specifies the behavior of an {@link https://learn.microsoft.com/office/dev/add-ins/outlook/spam-reporting | integrated spam-reporting add-in}
|
|
19805
|
+
* after it completes processing a
|
|
19806
|
+
* {@link https://learn.microsoft.com/javascript/api/office/office.eventtype?view=outlook-js-preview&preserve-view=true#fields | SpamReporting} event.
|
|
19807
|
+
*
|
|
19808
|
+
* @remarks
|
|
19809
|
+
*
|
|
19810
|
+
* [Api set: Mailbox preview]
|
|
19811
|
+
*
|
|
19812
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item**
|
|
19813
|
+
*
|
|
19814
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
19815
|
+
*
|
|
19816
|
+
* @beta
|
|
19817
|
+
*/
|
|
19818
|
+
interface SpamReportingEventCompletedOptions {
|
|
19819
|
+
/**
|
|
19820
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal that a reported message has finished processing,
|
|
19821
|
+
* this property specifies the Outlook mailbox folder to which the message will be moved.
|
|
19822
|
+
*
|
|
19823
|
+
* @remarks
|
|
19824
|
+
*
|
|
19825
|
+
* [Api set: Mailbox preview]
|
|
19826
|
+
*
|
|
19827
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
19828
|
+
*
|
|
19829
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
19830
|
+
*
|
|
19831
|
+
* **Important**:
|
|
19832
|
+
*
|
|
19833
|
+
* - If the specified folder doesn't exist yet, it will be created before the message is moved.
|
|
19834
|
+
*
|
|
19835
|
+
* - If the `postProcessingAction` property is set to `moveToCustomFolder`, the `folderName` property must be specified.
|
|
19836
|
+
* Otherwise, the reported message is moved to the Junk Email folder of the mailbox. If `postProcessingAction` is set to another action other than `moveToCustomFolder`,
|
|
19837
|
+
* the `folderName` property is ignored.
|
|
19838
|
+
*
|
|
19839
|
+
* @beta
|
|
19840
|
+
*/
|
|
19841
|
+
folderName?: string;
|
|
19842
|
+
/**
|
|
19843
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal that a reported message has finished processing,
|
|
19844
|
+
* this property specifies whether the message is moved to a different folder in the mailbox.
|
|
19845
|
+
*
|
|
19846
|
+
* @remarks
|
|
19847
|
+
*
|
|
19848
|
+
* [Api set: Mailbox preview]
|
|
19849
|
+
*
|
|
19850
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
19851
|
+
*
|
|
19852
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
19853
|
+
*
|
|
19854
|
+
* **Important**:
|
|
19855
|
+
*
|
|
19856
|
+
* In Outlook on Windows, you can only use this property in a spam-reporting add-in starting in Version 2308 (Build 16724.10000).
|
|
19857
|
+
* If you're using an earlier build that supports the integrated spam-reporting feature, use the `postProcessingAction`
|
|
19858
|
+
* property instead.
|
|
19859
|
+
*
|
|
19860
|
+
* If the property is set to `Office.MailboxEnums.MoveSpamItemTo.CustomFolder`, you must specify the name of the folder to which
|
|
19861
|
+
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `moveItemTo` property will default to
|
|
19862
|
+
* `Office.MailboxEnums.MoveSpamItemTo.JunkFolder` and move the reported message to the **Junk Email** folder.
|
|
19863
|
+
*
|
|
19864
|
+
* @beta
|
|
19865
|
+
*/
|
|
19866
|
+
moveItemTo?: Office.MailboxEnums.MoveSpamItemTo;
|
|
19867
|
+
/**
|
|
19868
|
+
* When set to `true`, deletes a reported message if an error occurs while the message is processed.
|
|
19869
|
+
* If this property is set to `false` or isn't specified in the {@link Office.MailboxEvent.completed | completed method},
|
|
19870
|
+
* the reported message remains in its current mailbox folder.
|
|
19871
|
+
*
|
|
19872
|
+
* @remarks
|
|
19873
|
+
*
|
|
19874
|
+
* [Api set: Mailbox preview]
|
|
19875
|
+
*
|
|
19876
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
19877
|
+
*
|
|
19878
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
19879
|
+
*
|
|
19880
|
+
* @beta
|
|
19881
|
+
*/
|
|
19882
|
+
onErrorDeleteItem?: boolean;
|
|
19883
|
+
/**
|
|
19884
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal that a reported message has finished processing,
|
|
19885
|
+
* this property specifies whether the message is moved to a different folder in the mailbox. The following post-processing actions are available.
|
|
19886
|
+
*
|
|
19887
|
+
* - `delete` - Moves the reported message to the **Deleted Items** folder of the mailbox.
|
|
19888
|
+
*
|
|
19889
|
+
* - `moveToCustomFolder` - Moves the reported message to a specified folder. You must specify the name of the folder in the `folderName` property.
|
|
19890
|
+
*
|
|
19891
|
+
* - `moveToSpamFolder` - Moves the reported message to the **Junk Email** folder of the mailbox.
|
|
19892
|
+
*
|
|
19893
|
+
* - `noMove` - Leaves the reported message in its current folder.
|
|
19894
|
+
*
|
|
19895
|
+
* @remarks
|
|
19896
|
+
*
|
|
19897
|
+
* [Api set: Mailbox preview]
|
|
19898
|
+
*
|
|
19899
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
19900
|
+
*
|
|
19901
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
19902
|
+
*
|
|
19903
|
+
* **Important**:
|
|
19904
|
+
*
|
|
19905
|
+
* In Outlook on Windows, you can only use this property in earlier builds that support the integrated spam-reporting feature.
|
|
19906
|
+
* If you're on Version 2308 (Build 16724.10000) or later, use the `moveItemTo` property instead.
|
|
19907
|
+
*
|
|
19908
|
+
* If the property is set to `moveToCustomFolder`, you must specify the name of the folder to which
|
|
19909
|
+
* the message will be moved in the `folderName` property of the `event.completed` call. Otherwise, the `postProcessingAction` property will default to
|
|
19910
|
+
* `moveToSpamFolder` and move the reported message to the **Junk Email** folder.
|
|
19911
|
+
*
|
|
19912
|
+
* @beta
|
|
19913
|
+
*/
|
|
19914
|
+
postProcessingAction?: string;
|
|
19915
|
+
/**
|
|
19916
|
+
* When you use the {@link Office.MailboxEvent.completed | completed method} to signal that a reported message has finished processing,
|
|
19917
|
+
* this property indicates if a post-processing dialog is shown to the user. The JSON object assigned to this property must contain a title and a description.
|
|
19918
|
+
* If this property isn't specified, a dialog isn't shown to the user once their reported message is processed.
|
|
19919
|
+
*
|
|
19920
|
+
* @remarks
|
|
19921
|
+
*
|
|
19922
|
+
* [Api set: Mailbox preview]
|
|
19923
|
+
*
|
|
19924
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level (Outlook)}**: **read item**
|
|
19925
|
+
*
|
|
19926
|
+
* **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Message Read
|
|
19927
|
+
*
|
|
19928
|
+
* @beta
|
|
19929
|
+
*/
|
|
19930
|
+
showPostProcessingDialog?: object;
|
|
19931
|
+
}
|
|
19837
19932
|
/**
|
|
19838
19933
|
* Provides methods to get and set the subject of an appointment or message in an Outlook add-in.
|
|
19839
19934
|
*
|
office-js-preview/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@types/office-js-preview",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.410",
|
|
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": "
|
|
48
|
+
"typesPublisherContentHash": "844fdd4e078cd90f5f0556b7777348441770b71bd98176c8b58b58d931258132",
|
|
49
49
|
"typeScriptVersion": "4.3"
|
|
50
50
|
}
|