Skip to content

Commit d11aa49

Browse files
ElizabethSamuel-MSFTgithub-actions
andauthored
Automatically generated docs (#2234)
Co-authored-by: github-actions <[email protected]>
1 parent d28ab6b commit d11aa49

File tree

177 files changed

+6978
-868
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

177 files changed

+6978
-868
lines changed

docs/docs-ref-autogen/office/office/office.addincommands.event.yml

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -289,13 +289,18 @@ methods:
289289
This method must be called at the end of a function which was invoked by the following:
290290
291291
292-
- A function command button (that is, an add-in command defined with an **<!-- -->&lt;<!-- -->Action<!--
293-
-->&gt;<!-- -->** element, where the `xsi:type` attribute is set to `ExecuteFunction`<!-- -->).
292+
- A [function command](https://learn.microsoft.com/office/dev/add-ins/design/add-in-commands) button.
294293
295294
296-
- An [event](https://learn.microsoft.com/javascript/api/manifest/event) defined in the [Events extension
297-
point](https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events) of an on-send add-in in Outlook.
298-
For example, an `ItemSend` event.
295+
- An [on-send add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins) in Outlook.
296+
297+
298+
- An [online-meeting provider add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/online-meeting) in
299+
Outlook.
300+
301+
302+
- A [note-logging add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-log-appointments) in
303+
Outlook on mobile devices.
299304
remarks: >-
300305
The following outlines support information for Outlook.
301306
@@ -313,9 +318,11 @@ methods:
313318
-->**: Compose or Read
314319
315320
316-
**Important**: The `options` parameter only applies to Outlook add-ins that implement the [on-send
317-
feature](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins)<!-- -->. It was introduced
318-
in Mailbox 1.8.
321+
**Important**: The `options` parameter only applies to Outlook add-ins. It was introduced in Mailbox 1.8.
322+
Although Outlook on Android and on iOS support up to Mailbox 1.5, the `options` parameter is supported in
323+
online-meeting provider and note-logging mobile add-ins. For more information on API support in Outlook on mobile
324+
devices, see [Outlook JavaScript APIs supported in Outlook on mobile
325+
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
319326
320327
321328
#### Examples
@@ -363,8 +370,8 @@ methods:
363370
parameters:
364371
- id: options
365372
description: >-
366-
Optional. An object that specifies the behavior of an on-send add-in in Outlook when it completes processing
367-
an `ItemSend` event.
373+
Optional. In Outlook, an object that specifies the behavior of an on-send add-in, online-meeting provider
374+
add-in, or note-logging mobile add-in when it completes processing an event.
368375
type: '<xref uid="office!Office.AddinCommands.EventCompletedOptions:interface" />'
369376
return:
370377
type: void

docs/docs-ref-autogen/office/office/office.addincommands.eventcompletedoptions.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@ uid: 'office!Office.AddinCommands.EventCompletedOptions:interface'
44
package: office!
55
fullName: Office.AddinCommands.EventCompletedOptions
66
summary: >-
7-
Specifies the behavior of an [on-send](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins)
8-
add-in in Outlook when it completes processing an `ItemSend` event.
7+
Specifies the behavior of an [on-send
8+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins)<!-- -->, [online-meeting
9+
provider add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/online-meeting)<!-- -->, or [note-logging
10+
mobile add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-log-appointments) when it completes
11+
processing an event in Outlook.
912
remarks: >-
1013
\[ [API set: Mailbox 1.8](/office/dev/add-ins/reference/javascript-api-for-office) \]
1114
@@ -18,6 +21,12 @@ remarks: >-
1821
**[Applicable Outlook
1922
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
2023
Compose
24+
25+
26+
**Important**: Although Outlook on Android and on iOS support up to Mailbox 1.5, the `EventCompletedOptions`
27+
object is supported in online-meeting provider and note-logging mobile add-ins. For more information on API support in
28+
Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile
29+
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
2130
isPreview: false
2231
isDeprecated: false
2332
type: interface

docs/docs-ref-autogen/office_release/office/office.addincommands.event.yml

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -284,13 +284,18 @@ methods:
284284
This method must be called at the end of a function which was invoked by the following:
285285
286286
287-
- A function command button (that is, an add-in command defined with an **<!-- -->&lt;<!-- -->Action<!--
288-
-->&gt;<!-- -->** element, where the `xsi:type` attribute is set to `ExecuteFunction`<!-- -->).
287+
- A [function command](https://learn.microsoft.com/office/dev/add-ins/design/add-in-commands) button.
289288
290289
291-
- An [event](https://learn.microsoft.com/javascript/api/manifest/event) defined in the [Events extension
292-
point](https://learn.microsoft.com/javascript/api/manifest/extensionpoint#events) of an on-send add-in in Outlook.
293-
For example, an `ItemSend` event.
290+
- An [on-send add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins) in Outlook.
291+
292+
293+
- An [online-meeting provider add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/online-meeting) in
294+
Outlook.
295+
296+
297+
- A [note-logging add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-log-appointments) in
298+
Outlook on mobile devices.
294299
remarks: >-
295300
The following outlines support information for Outlook.
296301
@@ -308,9 +313,11 @@ methods:
308313
-->**: Compose or Read
309314
310315
311-
**Important**: The `options` parameter only applies to Outlook add-ins that implement the [on-send
312-
feature](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins)<!-- -->. It was introduced
313-
in Mailbox 1.8.
316+
**Important**: The `options` parameter only applies to Outlook add-ins. It was introduced in Mailbox 1.8.
317+
Although Outlook on Android and on iOS support up to Mailbox 1.5, the `options` parameter is supported in
318+
online-meeting provider and note-logging mobile add-ins. For more information on API support in Outlook on mobile
319+
devices, see [Outlook JavaScript APIs supported in Outlook on mobile
320+
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
314321
315322
316323
#### Examples
@@ -358,8 +365,8 @@ methods:
358365
parameters:
359366
- id: options
360367
description: >-
361-
Optional. An object that specifies the behavior of an on-send add-in in Outlook when it completes processing
362-
an `ItemSend` event.
368+
Optional. In Outlook, an object that specifies the behavior of an on-send add-in, online-meeting provider
369+
add-in, or note-logging mobile add-in when it completes processing an event.
363370
type: '<xref uid="office!Office.AddinCommands.EventCompletedOptions:interface" />'
364371
return:
365372
type: void

docs/docs-ref-autogen/office_release/office/office.addincommands.eventcompletedoptions.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,11 @@ uid: 'office!Office.AddinCommands.EventCompletedOptions:interface'
44
package: office!
55
fullName: Office.AddinCommands.EventCompletedOptions
66
summary: >-
7-
Specifies the behavior of an [on-send](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins)
8-
add-in in Outlook when it completes processing an `ItemSend` event.
7+
Specifies the behavior of an [on-send
8+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-on-send-addins)<!-- -->, [online-meeting
9+
provider add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/online-meeting)<!-- -->, or [note-logging
10+
mobile add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/mobile-log-appointments) when it completes
11+
processing an event in Outlook.
912
remarks: >-
1013
\[ [API set: Mailbox 1.8](/office/dev/add-ins/reference/javascript-api-for-office) \]
1114
@@ -18,6 +21,12 @@ remarks: >-
1821
**[Applicable Outlook
1922
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
2023
Compose
24+
25+
26+
**Important**: Although Outlook on Android and on iOS support up to Mailbox 1.5, the `EventCompletedOptions`
27+
object is supported in online-meeting provider and note-logging mobile add-ins. For more information on API support in
28+
Outlook on mobile devices, see [Outlook JavaScript APIs supported in Outlook on mobile
29+
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
2130
isPreview: false
2231
isDeprecated: false
2332
type: interface

docs/docs-ref-autogen/outlook/outlook/office.appointmentcompose.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3755,6 +3755,27 @@ methods:
37553755
37563756
- Any code included after the `sendAsync` call isn't guaranteed to run since the add-in completes processing after
37573757
the `sendAsync` call.
3758+
3759+
3760+
#### Examples
3761+
3762+
3763+
```TypeScript
3764+
3765+
// Link to full sample:
3766+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/send-async.yaml
3767+
3768+
3769+
// This snippet sends the current message or appointment being composed.
3770+
3771+
Office.context.mailbox.item.sendAsync((asyncResult) => {
3772+
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
3773+
console.log("Action failed with error: " + asyncResult.error.message);
3774+
return;
3775+
}
3776+
});
3777+
3778+
```
37583779
isPreview: false
37593780
isDeprecated: false
37603781
syntax:

0 commit comments

Comments
 (0)