Skip to content

Commit 81c0da9

Browse files
samantharamongithub-actions
andauthored
Automatically generated docs (#2255)
Co-authored-by: github-actions <[email protected]>
1 parent 034a706 commit 81c0da9

File tree

160 files changed

+5817
-1263
lines changed

Some content is hidden

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

160 files changed

+5817
-1263
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -532,6 +532,11 @@ properties:
532532
-->**: Appointment Organizer
533533
534534
535+
**Important**: This property isn't supported in Outlook on Android or on iOS. For more information on
536+
supported APIs in Outlook mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
537+
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
538+
539+
535540
#### Examples
536541
537542

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -703,6 +703,11 @@ properties:
703703
-->**: Appointment Attendee
704704
705705
706+
**Important**: This property isn't supported in Outlook on Android or on iOS. For more information on
707+
supported APIs in Outlook mobile, see [Outlook JavaScript APIs supported in Outlook on mobile
708+
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!-- -->.
709+
710+
706711
#### Examples
707712
708713

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

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -74,14 +74,10 @@ properties:
7474
package: outlook!
7575
fullName: icon
7676
summary: >-
77-
A reference to an icon that is defined in the manifest. It appears in the infobar area. It is applicable if the
78-
type is `InformationalMessage`<!-- -->, and is required if the type is `InsightMessage`<!-- -->. Specifying this
77+
A reference to an icon that's defined in the manifest. It appears in the infobar area. It's applicable if the type
78+
is `InformationalMessage`<!-- -->, and is required if the type is `InsightMessage`<!-- -->. Specifying this
7979
parameter for an unsupported type results in an exception.
80-
81-
82-
**Note**: At present, the custom icon is displayed in Outlook on Windows only and not on other clients (e.g.,
83-
Mac, web browser).
84-
remarks: ''
80+
remarks: '**Important**: Currently, the custom icon is only displayed in classic Outlook on Windows.'
8581
isPreview: false
8682
isDeprecated: false
8783
syntax:
@@ -134,21 +130,27 @@ properties:
134130
uid: 'outlook!Office.NotificationMessageDetails#type:member'
135131
package: outlook!
136132
fullName: type
137-
summary: >-
138-
Specifies the `ItemNotificationMessageType` of message.
133+
summary: Specifies the `ItemNotificationMessageType` of message.
134+
remarks: >-
135+
**Important**:
139136
140137
141-
If type is `ProgressIndicator` or `ErrorMessage`<!-- -->, an icon is automatically supplied and the message is not
142-
persistent. Therefore the icon and persistent properties are not valid for these types of messages. Including them
138+
- For the `ProgressIndicator` or `ErrorMessage` types, an icon is automatically supplied and the message isn't
139+
persistent. Therefore, the icon and persistent properties aren't valid for these types of messages. Including them
143140
will result in an `ArgumentException`<!-- -->.
144141
145142
146-
If type is `ProgressIndicator`<!-- -->, the developer should remove or replace the progress indicator when the
147-
action is complete.
143+
- For the `ProgressIndicator` type, you should remove or replace the progress indicator when the action is
144+
complete.
148145
149146
150-
**Important**: Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
151-
remarks: ''
147+
- In Outlook on Android and on iOS, only the `ProgressIndicator`<!-- -->, `InformationalMessage`<!-- -->, and
148+
`ErrorMessage` notification types are supported.
149+
150+
151+
- In compose mode, while the style of each notification type varies on other Outlook clients, notifications in
152+
Outlook on Android and on iOS all use the same style. The notification message is always prefixed with an
153+
informational icon.
152154
isPreview: false
153155
isDeprecated: false
154156
syntax:

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

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,7 @@ methods:
2424
uid: 'outlook!Office.NotificationMessages#addAsync:member(1)'
2525
package: outlook!
2626
fullName: 'addAsync(key, JSONmessage, options, callback)'
27-
summary: >-
28-
Adds a notification to an item.
29-
30-
31-
There are a maximum of 5 notifications per message. Setting more will return a
32-
`NumberOfNotificationMessagesExceeded` error.
27+
summary: Adds a notification to an item.
3328
remarks: >-
3429
\[ [API set: Mailbox 1.3](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
3530
@@ -47,6 +42,11 @@ methods:
4742
**Important**:
4843
4944
45+
- In Outlook on the web, on Windows (new and classic), and on Mac, you can set a maximum of five notifications per
46+
message. Setting more returns a `NumberOfNotificationMessagesExceeded` error. In Outlook on Android and on iOS,
47+
you can only set one notification per message. Setting an additional notification replaces the previous one.
48+
49+
5050
- Only one notification of type
5151
[InsightMessage](https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields)
5252
is allowed per add-in. Attempting to add more will throw an error.
@@ -57,7 +57,13 @@ methods:
5757
`InsightMessage` notification only in Compose mode.
5858
5959
60-
- Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
60+
- In Outlook on Android and on iOS, only the `ProgressIndicator`<!-- -->, `InformationalMessage`<!-- -->, and
61+
`ErrorMessage` notification types are supported.
62+
63+
64+
- In compose mode, while the style of each notification type varies on other Outlook clients, notifications in
65+
Outlook on Android and on iOS all use the same style. The notification message is always prefixed with an
66+
informational icon.
6167
6268
6369
- The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
@@ -169,12 +175,7 @@ methods:
169175
uid: 'outlook!Office.NotificationMessages#addAsync:member(2)'
170176
package: outlook!
171177
fullName: 'addAsync(key, JSONmessage, callback)'
172-
summary: >-
173-
Adds a notification to an item.
174-
175-
176-
There are a maximum of 5 notifications per message. Setting more will return a
177-
`NumberOfNotificationMessagesExceeded` error.
178+
summary: Adds a notification to an item.
178179
remarks: >-
179180
\[ [API set: Mailbox 1.3](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
180181
@@ -192,6 +193,11 @@ methods:
192193
**Important**:
193194
194195
196+
- In Outlook on the web, on Windows (new and classic), and on Mac, you can set a maximum of five notifications per
197+
message. Setting more returns a `NumberOfNotificationMessagesExceeded` error. In Outlook on Android and on iOS,
198+
you can only set one notification per message. Setting an additional notification replaces the previous one.
199+
200+
195201
- Only one notification of type
196202
[InsightMessage](https://learn.microsoft.com/javascript/api/outlook/office.mailboxenums.itemnotificationmessagetype#fields)
197203
is allowed per add-in. Attempting to add more will throw an error.
@@ -202,7 +208,13 @@ methods:
202208
`InsightMessage` notification only in Compose mode.
203209
204210
205-
- Only the `InformationalMessage` type is supported in Outlook on Android and on iOS.
211+
- In Outlook on Android and on iOS, only the `ProgressIndicator`<!-- -->, `InformationalMessage`<!-- -->, and
212+
`ErrorMessage` notification types are supported.
213+
214+
215+
- In compose mode, while the style of each notification type varies on other Outlook clients, notifications in
216+
Outlook on Android and on iOS all use the same style. The notification message is always prefixed with an
217+
informational icon.
206218
207219
208220
- The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ methods:
6161
There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
6262
6363
64-
- The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
64+
The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
6565
For more information, see [Activate your Outlook add-in on multiple
6666
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
6767
@@ -171,7 +171,7 @@ methods:
171171
There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
172172
173173
174-
- The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
174+
The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
175175
For more information, see [Activate your Outlook add-in on multiple
176176
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
177177
@@ -528,7 +528,7 @@ methods:
528528
There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
529529
530530
531-
- The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
531+
The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
532532
For more information, see [Activate your Outlook add-in on multiple
533533
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
534534
@@ -610,7 +610,7 @@ methods:
610610
There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
611611
612612
613-
- The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
613+
The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
614614
For more information, see [Activate your Outlook add-in on multiple
615615
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
616616

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,6 +238,11 @@ methods:
238238
- The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
239239
240240
241+
- The `prependAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync`
242+
method. For more information, see [Activate your Outlook add-in on multiple
243+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
244+
245+
241246
**Errors**:
242247
243248
@@ -367,6 +372,11 @@ methods:
367372
- The `prependAsync` method doesn't support inline CSS. Use internal or external CSS instead.
368373
369374
375+
- The `prependAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync`
376+
method. For more information, see [Activate your Outlook add-in on multiple
377+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
378+
379+
370380
**Errors**:
371381
372382
@@ -430,6 +440,11 @@ methods:
430440
- The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
431441
432442
443+
- The `setSelectedDataAsync` method isn't supported on a message that's currently loaded using the
444+
`loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
445+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
446+
447+
433448
**Errors**:
434449
435450
@@ -547,6 +562,11 @@ methods:
547562
- The `setSelectedDataAsync` method doesn't support inline CSS. Use internal or external CSS instead.
548563
549564
565+
- The `setSelectedDataAsync` method isn't supported on a message that's currently loaded using the
566+
`loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
567+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
568+
569+
550570
**Errors**:
551571
552572

docs/docs-ref-autogen/outlook_1_1/outlook/office.customproperties.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,11 @@ methods:
111111
-->**: Compose or Read
112112
113113
114+
**Important**: The `remove` method isn't supported on a message that's currently loaded using the
115+
`loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
116+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
117+
118+
114119
#### Examples
115120
116121
@@ -275,6 +280,11 @@ methods:
275280
-->**: Compose or Read
276281
277282
283+
**Important**: The `set` method isn't supported on a message that's currently loaded using the
284+
`loadItemByIdAsync` method. For more information, see [Activate your Outlook add-in on multiple
285+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
286+
287+
278288
#### Examples
279289
280290

docs/docs-ref-autogen/outlook_1_1/outlook/office.recipients.yml

Lines changed: 44 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,12 @@ methods:
3939
-->**: Compose
4040
4141
42-
**Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook
43-
on the web, on Windows ([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) and
44-
classic), on Mac (classic UI), on Android, and on iOS. However, take note of the following:
42+
**Important**:
43+
44+
45+
With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on
46+
Windows ([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) and classic), on Mac
47+
(classic UI), on Android, and on iOS. However, take note of the following:
4548
4649
4750
- In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500
@@ -58,6 +61,11 @@ methods:
5861
There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
5962
6063
64+
The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
65+
For more information, see [Activate your Outlook add-in on multiple
66+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
67+
68+
6169
**Errors**:
6270
6371
@@ -142,9 +150,12 @@ methods:
142150
-->**: Compose
143151
144152
145-
**Important**: With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook
146-
on the web, on Windows ([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) and
147-
classic), on Mac (classic UI), on Android, and on iOS. However, take note of the following:
153+
**Important**:
154+
155+
156+
With the `addAsync` method, you can add a maximum of 100 recipients to a mail item in Outlook on the web, on
157+
Windows ([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) and classic), on Mac
158+
(classic UI), on Android, and on iOS. However, take note of the following:
148159
149160
150161
- In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500
@@ -161,6 +172,11 @@ methods:
161172
There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI).
162173
163174
175+
The `addAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
176+
For more information, see [Activate your Outlook add-in on multiple
177+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
178+
179+
164180
**Errors**:
165181
166182
@@ -491,9 +507,12 @@ methods:
491507
-->**: Compose
492508
493509
494-
**Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on
495-
Windows ([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) and classic), on Mac
496-
(classic UI), on Android, and on iOS. However, take note of the following:
510+
**Important**:
511+
512+
513+
With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
514+
([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) and classic), on Mac (classic
515+
UI), on Android, and on iOS. However, take note of the following:
497516
498517
499518
- In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500
@@ -510,6 +529,11 @@ methods:
510529
There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
511530
512531
532+
The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
533+
For more information, see [Activate your Outlook add-in on multiple
534+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
535+
536+
513537
**Errors**:
514538
515539
@@ -565,9 +589,12 @@ methods:
565589
-->**: Compose
566590
567591
568-
**Important**: With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on
569-
Windows ([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) and classic), on Mac
570-
(classic UI), on Android, and on iOS. However, take note of the following:
592+
**Important**:
593+
594+
595+
With the `setAsync` method, you can set a maximum of 100 recipients in Outlook on the web, on Windows
596+
([new](https://support.microsoft.com/office/656bb8d9-5a60-49b2-a98b-ba7822bc7627) and classic), on Mac (classic
597+
UI), on Android, and on iOS. However, take note of the following:
571598
572599
573600
- In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500
@@ -584,6 +611,11 @@ methods:
584611
There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI).
585612
586613
614+
The `setAsync` method isn't supported on a message that's currently loaded using the `loadItemByIdAsync` method.
615+
For more information, see [Activate your Outlook add-in on multiple
616+
messages](https://learn.microsoft.com/office/dev/add-ins/outlook/item-multi-select)<!-- -->.
617+
618+
587619
**Errors**:
588620
589621

0 commit comments

Comments
 (0)