Skip to content

Commit c97cfe3

Browse files
ElizabethSamuel-MSFTgithub-actions
andauthored
Automatically generated docs (#2286)
Co-authored-by: github-actions <[email protected]>
1 parent 13c4b2b commit c97cfe3

File tree

106 files changed

+1906
-274
lines changed

Some content is hidden

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

106 files changed

+1906
-274
lines changed

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -566,9 +566,18 @@ properties:
566566
-->**: Appointment Organizer
567567
568568
569-
**Important**: This property isn't supported in Outlook on Android or
570-
on iOS. For more information on supported APIs in Outlook mobile, see
571-
[Outlook JavaScript APIs supported in Outlook on mobile
569+
**Important**:
570+
571+
572+
- To learn about the different types of notification messages you can
573+
implement, see [Create notifications for your Outlook
574+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
575+
-->.
576+
577+
578+
- This property isn't supported in Outlook on Android or on iOS. For more
579+
information on supported APIs in Outlook mobile, see [Outlook JavaScript
580+
APIs supported in Outlook on mobile
572581
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!--
573582
-->.
574583

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -755,9 +755,18 @@ properties:
755755
-->**: Appointment Attendee
756756
757757
758-
**Important**: This property isn't supported in Outlook on Android or
759-
on iOS. For more information on supported APIs in Outlook mobile, see
760-
[Outlook JavaScript APIs supported in Outlook on mobile
758+
**Important**:
759+
760+
761+
- To learn about the different types of notification messages you can
762+
implement, see [Create notifications for your Outlook
763+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
764+
-->.
765+
766+
767+
- This property isn't supported in Outlook on Android or on iOS. For more
768+
information on supported APIs in Outlook mobile, see [Outlook JavaScript
769+
APIs supported in Outlook on mobile
761770
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!--
762771
-->.
763772

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -419,8 +419,17 @@ properties:
419419
-->**: Message Compose
420420
421421
422-
**Important**: Only the `getAllAsync` method of the
423-
NotificationMessages object is supported.
422+
**Important**:
423+
424+
425+
- To learn about the different types of notification messages you can
426+
implement, see [Create notifications for your Outlook
427+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
428+
-->.
429+
430+
431+
- Only the `getAllAsync` method of the NotificationMessages object is
432+
supported.
424433
425434
isPreview: false
426435
isDeprecated: false

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -580,6 +580,12 @@ properties:
580580
**Important**:
581581
582582
583+
- To learn about the different types of notification messages you can
584+
implement, see [Create notifications for your Outlook
585+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
586+
-->.
587+
588+
583589
- Only the `getAllAsync` method of the NotificationMessages object is
584590
supported.
585591

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -753,6 +753,12 @@ properties:
753753
-->**: Message Compose
754754
755755
756+
**Important**: To learn about the different types of notification
757+
messages you can implement, see [Create notifications for your Outlook
758+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
759+
-->.
760+
761+
756762
#### Examples
757763
758764

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -971,6 +971,12 @@ properties:
971971
-->**: Message Read
972972
973973
974+
**Important**: To learn about the different types of notification
975+
messages you can implement, see [Create notifications for your Outlook
976+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
977+
-->.
978+
979+
974980
#### Examples
975981
976982

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

Lines changed: 41 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ remarks: >-
2121
-->**: Compose or Read
2222
2323
24+
**Important**: To learn about the different types of notification messages
25+
you can implement, see [Create notifications for your Outlook
26+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
27+
-->.
28+
29+
2430
#### Examples
2531
2632
@@ -84,13 +90,42 @@ properties:
8490
package: outlook!
8591
fullName: icon
8692
summary: >-
87-
A reference to an icon that's defined in the manifest. It appears in the
88-
infobar area. It's applicable if the type is `InformationalMessage`<!--
89-
-->, and is required if the type is `InsightMessage`<!-- -->. Specifying
90-
this parameter for an unsupported type results in an exception.
93+
A reference to a custom icon that's defined in the manifest. The icon
94+
appears before the notification message in the infobar area. An icon must
95+
be specified for `InformationalMessage` and `InsightMessage`
96+
notifications.
9197
remarks: >-
92-
**Important**: Currently, the custom icon is only displayed in classic
93-
Outlook on Windows.
98+
**Important**:
99+
100+
101+
- Currently, the custom icon is only displayed in classic Outlook on
102+
Windows.
103+
104+
105+
- A custom icon is only supported in `InformationalMessage` and
106+
`InsightMessage` notifications. Specifying an icon for other notification
107+
types results in an exception.
108+
109+
110+
- If your add-in uses the [add-in only
111+
manifest](https://learn.microsoft.com/office/dev/add-ins/develop/add-in-manifests)<!--
112+
-->, the icon must be specified in the
113+
[Images](https://learn.microsoft.com/javascript/api/manifest/images)
114+
element of the
115+
[Resources](https://learn.microsoft.com/javascript/api/manifest/resources)
116+
section of the manifest.
117+
118+
119+
- If your add-in uses the [unified manifest for Microsoft
120+
365](https://learn.microsoft.com/office/dev/add-ins/develop/unified-manifest-overview)<!--
121+
-->, you can't currently customize the icon of an `InformationalMessage`
122+
or `InsightMessage` notification. The notification uses the first image
123+
specified in the
124+
["icons"](https://learn.microsoft.com/microsoft-365/extensibility/schema/extension-common-icon)
125+
array of the first
126+
[extensions.ribbons.tabs.groups.controls](https://learn.microsoft.com/microsoft-365/extensibility/schema/extension-common-custom-group-controls-item)
127+
object of the manifest. Although this is the case, you must still specify
128+
a string in the `icon` property (for example, "icon-16").
94129
95130
isPreview: false
96131
isDeprecated: false

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ remarks: >-
2020
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
2121
-->**: Compose or Read
2222
23+
24+
**Important**: To learn about the different types of notification messages
25+
you can implement, see [Create notifications for your Outlook
26+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
27+
-->.
28+
2329
isPreview: false
2430
isDeprecated: false
2531
type: interface

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -504,9 +504,18 @@ properties:
504504
-->**: Appointment Organizer
505505
506506
507-
**Important**: This property isn't supported in Outlook on Android or
508-
on iOS. For more information on supported APIs in Outlook mobile, see
509-
[Outlook JavaScript APIs supported in Outlook on mobile
507+
**Important**:
508+
509+
510+
- To learn about the different types of notification messages you can
511+
implement, see [Create notifications for your Outlook
512+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
513+
-->.
514+
515+
516+
- This property isn't supported in Outlook on Android or on iOS. For more
517+
information on supported APIs in Outlook mobile, see [Outlook JavaScript
518+
APIs supported in Outlook on mobile
510519
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!--
511520
-->.
512521

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -717,9 +717,18 @@ properties:
717717
-->**: Appointment Attendee
718718
719719
720-
**Important**: This property isn't supported in Outlook on Android or
721-
on iOS. For more information on supported APIs in Outlook mobile, see
722-
[Outlook JavaScript APIs supported in Outlook on mobile
720+
**Important**:
721+
722+
723+
- To learn about the different types of notification messages you can
724+
implement, see [Create notifications for your Outlook
725+
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/notifications)<!--
726+
-->.
727+
728+
729+
- This property isn't supported in Outlook on Android or on iOS. For more
730+
information on supported APIs in Outlook mobile, see [Outlook JavaScript
731+
APIs supported in Outlook on mobile
723732
devices](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis)<!--
724733
-->.
725734

0 commit comments

Comments
 (0)