Skip to content

Commit 8067f80

Browse files
ElizabethSamuel-MSFTgithub-actions
andauthored
Automatically generated docs (#2287)
* Automatically generated docs * Get latest updates --------- Co-authored-by: github-actions <[email protected]>
1 parent c97cfe3 commit 8067f80

File tree

23 files changed

+425
-98
lines changed

23 files changed

+425
-98
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@ enums:
8989
- outlook!Office.MailboxEnums.AttachmentContentFormat:enum
9090
- outlook!Office.MailboxEnums.AttachmentStatus:enum
9191
- outlook!Office.MailboxEnums.AttachmentType:enum
92+
- outlook!Office.MailboxEnums.BodyMode:enum
9293
- outlook!Office.MailboxEnums.CategoryColor:enum
9394
- outlook!Office.MailboxEnums.ComposeType:enum
9495
- outlook!Office.MailboxEnums.Days:enum

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

Lines changed: 132 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -339,10 +339,7 @@ methods:
339339
package: outlook!
340340
fullName: getAsync(coercionType, options, callback)
341341
summary: >-
342-
Returns the current body in a specified format.
343-
344-
345-
This method returns the entire current body in the format specified by
342+
Returns the entire current body in the format specified by
346343
`coercionType`<!-- -->.
347344
remarks: >-
348345
\[ [API set: Mailbox
@@ -377,6 +374,29 @@ methods:
377374
Otherwise, you may receive an unexpected value, such as an empty string.
378375
379376
377+
- In Outlook on the web and new Outlook on Windows, users can organize
378+
their messages as conversations or individual messages in **Settings**
379+
&gt; **Mail** &gt; **Layout** &gt; **Message organization**
380+
(see [Change how the message list is displayed in
381+
Outlook](https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042)<!--
382+
-->). This setting affects how much of a message's body is displayed to
383+
the user (that is, the entire conversation thread of a message or just the
384+
current message). In Message Compose mode, particulary for replies to a
385+
conversation thread with more than one message, if you want the returned
386+
body to reflect the user's setting, specify the `bodyMode:
387+
Office.MailboxEnums.BodyMode.HostConfig` parameter in your `getAsync`
388+
call. If messages are grouped by conversation, only the body of the
389+
current reply is returned. Conversely, if messages are displayed
390+
individually, the entire conversation thread is returned.
391+
392+
393+
- The `bodyMode` option isn't supported on a message that's loaded using
394+
the `loadItemByIdAsync` method. For more information, see [Activate your
395+
Outlook add-in on multiple
396+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!--
397+
-->.
398+
399+
380400
#### Examples
381401
382402
@@ -407,18 +427,28 @@ methods:
407427
syntax:
408428
content: >-
409429
getAsync(coercionType: Office.CoercionType | string, options:
410-
Office.AsyncContextOptions, callback?: (asyncResult:
411-
Office.AsyncResult<string>) => void): void;
430+
Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode },
431+
callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
412432
parameters:
413433
- id: coercionType
414434
description: The format for the returned body.
415435
type: <xref uid="office!Office.CoercionType:enum" /> | string
416436
- id: options
417437
description: >-
418438
An object literal that contains one or more of the following
419-
properties:- `asyncContext`<!-- -->: Developers can provide any
420-
object they wish to access in the callback function.
421-
type: <xref uid="office!Office.AsyncContextOptions:interface" />
439+
properties. `asyncContext`<!-- -->: Any data you want to access in
440+
the callback function. `bodyMode`<!-- -->: In Outlook on the web and
441+
new Outlook on Windows, specifies whether only the body of the
442+
current message or the entire body of a message conversation is
443+
returned. If a value isn't specified, `bodyMode` defaults to
444+
`Office.MailboxEnums.BodyMode.FullBody`<!-- -->, which returns the
445+
entire body of a message conversation. The `bodyMode` property only
446+
applies to replies on the Message Compose surface. It's ignored in
447+
Outlook on Windows (classic), on Mac, and on mobile devices.
448+
type: >-
449+
<xref uid="office!Office.AsyncContextOptions:interface" /> & {
450+
bodyMode?: <xref uid="outlook!Office.MailboxEnums.BodyMode:enum" />
451+
}
422452
- id: callback
423453
description: >-
424454
Optional. When the method completes, the function passed in the
@@ -436,10 +466,7 @@ methods:
436466
package: outlook!
437467
fullName: getAsync(coercionType, callback)
438468
summary: >-
439-
Returns the current body in a specified format.
440-
441-
442-
This method returns the entire current body in the format specified by
469+
Returns the entire current body in the format specified by
443470
`coercionType`<!-- -->.
444471
remarks: >-
445472
\[ [API set: Mailbox
@@ -474,6 +501,22 @@ methods:
474501
Otherwise, you may receive an unexpected value, such as an empty string.
475502
476503
504+
- In Outlook on the web and new Outlook on Windows, users can organize
505+
their messages as conversations or individual messages in **Settings**
506+
&gt; **Mail** &gt; **Layout** &gt; **Message organization**
507+
(see [Change how the message list is displayed in
508+
Outlook](https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042)<!--
509+
-->). This setting affects how much of a message's body is displayed to
510+
the user (that is, the entire conversation thread of a message or just the
511+
current message). In Message Compose mode, particulary for replies to a
512+
conversation thread with more than one message, if you want the returned
513+
body to reflect the user's setting, specify the `bodyMode:
514+
Office.MailboxEnums.BodyMode.HostConfig` parameter in your `getAsync`
515+
call. If messages are grouped by conversation, only the body of the
516+
current reply is returned. Conversely, if messages are displayed
517+
individually, the entire conversation thread is returned.
518+
519+
477520
#### Examples
478521
479522
@@ -1265,6 +1308,35 @@ methods:
12651308
-->.
12661309
12671310
1311+
- In Outlook on the web and new Outlook on Windows, users can organize
1312+
their messages as conversations or individual messages in **Settings**
1313+
&gt; **Mail** &gt; **Layout** &gt; **Message organization**
1314+
(see [Change how the message list is displayed in
1315+
Outlook](https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042)<!--
1316+
-->). This setting affects how much of a message's body is displayed to
1317+
the user (that is, the entire conversation thread of a message or just the
1318+
current message). In Message Compose mode, particulary for replies to a
1319+
conversation thread with more than one message, if you want to honor the
1320+
user's settings when setting the body of a message, specify the `bodyMode:
1321+
Office.MailboxEnums.BodyMode.HostConfig` parameter in your `setAsync`
1322+
call. If messages are grouped by conversation, only the body of the
1323+
current reply is set. Conversely, if messages are displayed individually,
1324+
the entire body, including previous messages in the conversation thread,
1325+
is replaced.
1326+
1327+
1328+
- In Outlook on the web and new Outlook on Windows, if the `bodyMode`
1329+
property isn't specified or is set to
1330+
`Office.MailboxEnums.BodyMode.FullBody`<!-- -->, the entire body of a
1331+
message, including previous messages from the conversation thread, is
1332+
replaced. This applies even if a user's messages are organized by
1333+
conversation. In this scenario, the user's setting is temporarily changed
1334+
to **Individual messages: Do not group messages** &gt; **Only a
1335+
single message** or **Show email as individual messages** during the
1336+
`setAsync` call. A notification is shown to the user to alert them to this
1337+
change. Once the call completes, the user's setting is reinstated.
1338+
1339+
12681340
**Errors**:
12691341
12701342
@@ -1353,24 +1425,33 @@ methods:
13531425
syntax:
13541426
content: >-
13551427
setAsync(data: string, options: Office.AsyncContextOptions &
1356-
CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>)
1357-
=> void): void;
1428+
CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?:
1429+
(asyncResult: Office.AsyncResult<void>) => void): void;
13581430
parameters:
13591431
- id: data
13601432
description: >-
1361-
The string that will replace the existing body. The string is
1362-
limited to 1,000,000 characters.
1433+
The string that replaces the existing body. The string is limited to
1434+
1,000,000 characters.
13631435
type: string
13641436
- id: options
13651437
description: >-
13661438
An object literal that contains one or more of the following
1367-
properties:- `asyncContext`<!-- -->: Developers can provide any
1368-
object they wish to access in the callback function.
1369-
`coercionType`<!-- -->: The desired format for the body. The string
1370-
in the `data` parameter will be converted to this format.
1439+
properties. `asyncContext`<!-- -->: Any data you want to access in
1440+
the callback function. `coercionType`<!-- -->: The desired format
1441+
for the body. The string in the `data` parameter is converted to
1442+
this format. `bodyMode`<!-- -->: In Outlook on the web and new
1443+
Outlook on Windows, specifies whether only the body of the current
1444+
message or the entire body of a message conversation is set. If a
1445+
value isn't specified, `bodyMode` defaults to
1446+
`Office.MailboxEnums.BodyMode.FullBody`<!-- -->, which replaces the
1447+
entire body, including previous messages in the conversation thread.
1448+
The `bodyMode` property only applies to replies on the Message
1449+
Compose surface. It's ignored in Outlook on Windows (classic), on
1450+
Mac, and on mobile devices.
13711451
type: >-
13721452
<xref uid="office!Office.AsyncContextOptions:interface" /> & <xref
1373-
uid="outlook!Office.CoercionTypeOptions:interface" />
1453+
uid="outlook!Office.CoercionTypeOptions:interface" /> & { bodyMode?:
1454+
<xref uid="outlook!Office.MailboxEnums.BodyMode:enum" /> }
13741455
- id: callback
13751456
description: >-
13761457
Optional. When the method completes, the function passed in the
@@ -1461,6 +1542,35 @@ methods:
14611542
-->.
14621543
14631544
1545+
- In Outlook on the web and new Outlook on Windows, users can organize
1546+
their messages as conversations or individual messages in **Settings**
1547+
&gt; **Mail** &gt; **Layout** &gt; **Message organization**
1548+
(see [Change how the message list is displayed in
1549+
Outlook](https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042)<!--
1550+
-->). This setting affects how much of a message's body is displayed to
1551+
the user (that is, the entire conversation thread of a message or just the
1552+
current message). In Message Compose mode, particulary for replies in a
1553+
conversation thread with more than one message, if you want to honor the
1554+
user's settings when setting the body of a message, specify the `bodyMode:
1555+
Office.MailboxEnums.BodyMode.HostConfig` parameter in your `setAsync`
1556+
call. If messages are grouped by conversation, only the body of the
1557+
current reply is set. Conversely, if messages are displayed individually,
1558+
the entire body, including previous messages in the conversation thread,
1559+
is replaced.
1560+
1561+
1562+
- In Outlook on the web and new Outlook on Windows, if the `bodyMode`
1563+
property isn't specified or is set to
1564+
`Office.MailboxEnums.BodyMode.FullBody`<!-- -->, the entire body of a
1565+
message, including previous messages from the conversation thread, is
1566+
replaced. This applies even if a user's messages are organized by
1567+
conversation. In this scenario, the user's setting is temporarily changed
1568+
to **Individual messages: Do not group messages** &gt; **Only a
1569+
single message** or **Show email as individual messages** during the
1570+
`setAsync` call. A notification is shown to the user to alert them to this
1571+
change. Once the call completes, the user's setting is reinstated.
1572+
1573+
14641574
**Errors**:
14651575
14661576
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
### YamlMime:TSEnum
2+
name: Office.MailboxEnums.BodyMode
3+
uid: outlook!Office.MailboxEnums.BodyMode:enum
4+
package: outlook!
5+
fullName: Office.MailboxEnums.BodyMode
6+
summary: >-
7+
Specifies the portion of a message's body displayed for replies to a
8+
conversation thread with more than one message.
9+
remarks: >-
10+
**[Applicable Outlook
11+
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
12+
-->**: Message Compose
13+
14+
15+
**Important**: This enum is only supported in Outlook on the web and new
16+
Outlook on Windows. On these platforms, users can organize their messages as
17+
conversations or individual messages in **Settings** &gt; **Mail**
18+
&gt; **Layout** &gt; **Message organization**. This user setting
19+
affects the portion of the body of a message that's displayed.
20+
21+
22+
The `BodyMode` enum supports the following message organization settings.
23+
24+
25+
- Conversations: **Group messages by conversation** &gt; **All messages
26+
from the selected conversation** or **Show email grouped by
27+
conversation** &gt; **Newest on top**<!-- -->/<!-- -->**Newest on
28+
bottom**
29+
30+
31+
- Individual messages: **Do not group messages** &gt; **Only a single
32+
message** or **Show email as individual messages**
33+
34+
35+
For more information, see [Change how the message list is displayed in
36+
Outlook](https://support.microsoft.com/office/57fe0cd8-e90b-4b1b-91e4-a0ba658c0042)<!--
37+
-->.
38+
39+
isPreview: false
40+
isDeprecated: false
41+
fields:
42+
- name: FullBody
43+
uid: outlook!Office.MailboxEnums.BodyMode.FullBody:member
44+
package: outlook!
45+
summary: >-
46+
The entire body of a message, including previous messages from the same
47+
conversation thread.
48+
value: '0'
49+
- name: HostConfig
50+
uid: outlook!Office.MailboxEnums.BodyMode.HostConfig:member
51+
package: outlook!
52+
summary: >-
53+
The body mode depends on the user's current setting for message
54+
organization (that is, messages are organized as conversations or
55+
individual messages). If messages are organized by conversation, it
56+
specifies only the current body of the reply. Conversely, if messages are
57+
organized as individual messages, it specifies the entire body of a
58+
message, including previous messages from the same conversation thread.
59+
value: '1'

docs/docs-ref-autogen/outlook/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ items:
2323
uid: outlook!Office.MailboxEnums.AttachmentStatus:enum
2424
- name: AttachmentType
2525
uid: outlook!Office.MailboxEnums.AttachmentType:enum
26+
- name: BodyMode
27+
uid: outlook!Office.MailboxEnums.BodyMode:enum
2628
- name: CategoryColor
2729
uid: outlook!Office.MailboxEnums.CategoryColor:enum
2830
- name: ComposeType

docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.tableaddoptions.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,7 @@ properties:
246246
If provided, specifies properties for each cell in the table.
247247
248248
249-
This should be an 2D array with the same number of rows and columns as the
249+
This should be a 2D array with the same number of rows and columns as the
250250
table. If a cell doesn't require specific formatting, specify an empty
251251
object for that cell. Only the top left cell of a merged are can have
252252
properties specified, which will be applied to the entire merged area. For
@@ -407,7 +407,7 @@ properties:
407407
408408
409409
To apply specific formatting to individual cells, use
410-
specificCellProperties.
410+
`specificCellProperties`<!-- -->.
411411
412412
413413
If both uniformCellProperties and specificCellProperties are undefined,
@@ -417,7 +417,7 @@ properties:
417417
418418
419419
To provide a plain appearance for the table, set this property to an empty
420-
object and don't specify specificCellProperties.
420+
object and don't specify `specificCellProperties`<!-- -->.
421421
remarks: >-
422422
\[ [API set: PowerPointApi
423423
1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets)

docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.textverticalalignment.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ fullName: PowerPoint.TextVerticalAlignment
66
summary: >-
77
Represents the vertical alignment of a
88
[PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) in a
9-
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one the
10-
centered options are selected, the contents of the `TextFrame` will be
9+
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one of
10+
the centered options is selected, the contents of the `TextFrame` will be
1111
centered horizontally within the `Shape` as a group. To change the horizontal
1212
alignment of a text, see
1313
[PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class)

docs/docs-ref-autogen/powerpoint_1_4/powerpoint/powerpoint.textverticalalignment.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ fullName: PowerPoint.TextVerticalAlignment
66
summary: >-
77
Represents the vertical alignment of a
88
[PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) in a
9-
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one the
10-
centered options are selected, the contents of the `TextFrame` will be
9+
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one of
10+
the centered options is selected, the contents of the `TextFrame` will be
1111
centered horizontally within the `Shape` as a group. To change the horizontal
1212
alignment of a text, see
1313
[PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class)

docs/docs-ref-autogen/powerpoint_1_5/powerpoint/powerpoint.textverticalalignment.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ fullName: PowerPoint.TextVerticalAlignment
66
summary: >-
77
Represents the vertical alignment of a
88
[PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) in a
9-
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one the
10-
centered options are selected, the contents of the `TextFrame` will be
9+
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one of
10+
the centered options is selected, the contents of the `TextFrame` will be
1111
centered horizontally within the `Shape` as a group. To change the horizontal
1212
alignment of a text, see
1313
[PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class)

docs/docs-ref-autogen/powerpoint_1_6/powerpoint/powerpoint.textverticalalignment.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ fullName: PowerPoint.TextVerticalAlignment
66
summary: >-
77
Represents the vertical alignment of a
88
[PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) in a
9-
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one the
10-
centered options are selected, the contents of the `TextFrame` will be
9+
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one of
10+
the centered options is selected, the contents of the `TextFrame` will be
1111
centered horizontally within the `Shape` as a group. To change the horizontal
1212
alignment of a text, see
1313
[PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class)

docs/docs-ref-autogen/powerpoint_1_7/powerpoint/powerpoint.textverticalalignment.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ fullName: PowerPoint.TextVerticalAlignment
66
summary: >-
77
Represents the vertical alignment of a
88
[PowerPoint.TextFrame](xref:powerpoint!PowerPoint.TextFrame:class) in a
9-
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one the
10-
centered options are selected, the contents of the `TextFrame` will be
9+
[PowerPoint.Shape](xref:powerpoint!PowerPoint.Shape:class)<!-- -->. If one of
10+
the centered options is selected, the contents of the `TextFrame` will be
1111
centered horizontally within the `Shape` as a group. To change the horizontal
1212
alignment of a text, see
1313
[PowerPoint.ParagraphFormat](xref:powerpoint!PowerPoint.ParagraphFormat:class)

0 commit comments

Comments
 (0)