Skip to content

Commit d4d3a37

Browse files
[all hosts] Get latest (#2099)
1 parent c338295 commit d4d3a37

File tree

105 files changed

+5007
-3950
lines changed

Some content is hidden

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

105 files changed

+5007
-3950
lines changed

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

Lines changed: 66 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2618,15 +2618,12 @@ methods:
26182618
package: outlook!
26192619
fullName: 'getItemIdAsync(options, callback)'
26202620
summary: >-
2621-
Asynchronously gets the ID of a saved item.
2621+
Asynchronously gets the [Exchange Web Services (EWS) item
2622+
identifier](https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange)
2623+
of a saved item.
26222624
26232625
26242626
When invoked, this method returns the item ID via the callback function.
2625-
2626-
2627-
**Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use
2628-
with EWS or the REST API), be aware that when Outlook is in cached mode, it may take some time before the item is
2629-
synced to the server. Until the item is synced, the `itemId` is not recognized and using it returns an error.
26302627
remarks: >-
26312628
\[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
26322629
@@ -2641,6 +2638,19 @@ methods:
26412638
-->**: Appointment Organizer
26422639
26432640
2641+
**Important**:
2642+
2643+
2644+
- The item ID returned isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before
2645+
making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`<!--
2646+
-->.
2647+
2648+
2649+
- If your add-in calls `getItemIdAsync` (for example, to get an item ID to use with EWS or the REST API), be aware
2650+
that when Outlook is in cached mode, it may take some time before the item is synced to the server. Until the item
2651+
is synced, the item ID isn't recognized and using it returns an error.
2652+
2653+
26442654
**Errors**:
26452655
26462656
@@ -2660,7 +2670,8 @@ methods:
26602670
- id: callback
26612671
description: >-
26622672
When the method completes, the function passed in the `callback` parameter is called with a single parameter
2663-
of type `Office.AsyncResult`<!-- -->.
2673+
of type `Office.AsyncResult`<!-- -->. The EWS item ID of the item is returned in the `asyncResult.value`
2674+
property.
26642675
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;string&gt;) =&gt; void'
26652676
return:
26662677
type: void
@@ -2670,15 +2681,12 @@ methods:
26702681
package: outlook!
26712682
fullName: getItemIdAsync(callback)
26722683
summary: >-
2673-
Asynchronously gets the ID of a saved item.
2684+
Asynchronously gets the [Exchange Web Services (EWS) item
2685+
identifier](https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange)
2686+
of a saved item.
26742687
26752688
26762689
When invoked, this method returns the item ID via the callback function.
2677-
2678-
2679-
**Note**: If your add-in calls `getItemIdAsync` on an item in compose mode (e.g., to get an `itemId` to use
2680-
with EWS or the REST API), be aware that when Outlook is in cached mode, it may take some time before the item is
2681-
synced to the server. Until the item is synced, the `itemId` is not recognized and using it returns an error.
26822690
remarks: >-
26832691
\[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
26842692
@@ -2693,6 +2701,19 @@ methods:
26932701
-->**: Appointment Organizer
26942702
26952703
2704+
**Important**:
2705+
2706+
2707+
- The item ID returned isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before
2708+
making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`<!--
2709+
-->.
2710+
2711+
2712+
- If your add-in calls `getItemIdAsync` (for example, to get an item ID to use with EWS or the REST API), be aware
2713+
that when Outlook is in cached mode, it may take some time before the item is synced to the server. Until the item
2714+
is synced, the item ID isn't recognized and using it returns an error.
2715+
2716+
26962717
**Errors**:
26972718
26982719
@@ -2705,15 +2726,16 @@ methods:
27052726
```TypeScript
27062727
27072728
// Link to full sample:
2708-
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/85-tokens-and-service-calls/item-id-compose.yaml
2729+
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/item-id-compose.yaml
27092730
27102731
2711-
Office.context.mailbox.item.getItemIdAsync(function (result) {
2712-
if (result.status !== Office.AsyncResultStatus.Succeeded) {
2732+
Office.context.mailbox.item.getItemIdAsync((result) => {
2733+
if (result.status === Office.AsyncResultStatus.Failed) {
27132734
console.error(`getItemIdAsync failed with message: ${result.error.message}`);
2714-
} else {
2715-
console.log(result.value);
2735+
return;
27162736
}
2737+
2738+
console.log(result.value);
27172739
});
27182740
27192741
```
@@ -2725,7 +2747,8 @@ methods:
27252747
- id: callback
27262748
description: >-
27272749
When the method completes, the function passed in the `callback` parameter is called with a single parameter
2728-
of type `Office.AsyncResult`<!-- -->.
2750+
of type `Office.AsyncResult`<!-- -->. The EWS item ID of the item is returned in the `asyncResult.value`
2751+
property.
27292752
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;string&gt;) =&gt; void'
27302753
return:
27312754
type: void
@@ -3449,9 +3472,16 @@ methods:
34493472
`saveAsync` may not result in the same content.
34503473
34513474
3452-
- If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the
3453-
REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced
3454-
to the server. Until the item is synced, using the item ID will return an error.
3475+
- The identifier returned is the same as the [Exchange Web Services (EWS) item
3476+
identifier](https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange)<!--
3477+
-->. The item ID returned isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before
3478+
making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`<!--
3479+
-->.
3480+
3481+
3482+
- If your add-in calls `saveAsync` to get an item ID to use with EWS or the REST API, be aware that when Outlook
3483+
is in cached mode, it may take some time before the item is actually synced to the server. Until the item is
3484+
synced, using the item ID will return an error.
34553485
34563486
34573487
- In Outlook on Mac, only Version 16.35 (20030802) and later supports saving a meeting. Otherwise, the `saveAsync`
@@ -3501,8 +3531,8 @@ methods:
35013531
- id: callback
35023532
description: >-
35033533
When the method completes, the function passed in the `callback` parameter is called with a single
3504-
parameter, `asyncResult`<!-- -->, which is an `Office.AsyncResult` object. The appointment ID is returned in
3505-
the `asyncResult.value` property.
3534+
parameter, `asyncResult`<!-- -->, which is an `Office.AsyncResult` object. The EWS appointment ID is
3535+
returned in the `asyncResult.value` property.
35063536
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;string&gt;) =&gt; void'
35073537
return:
35083538
type: void
@@ -3546,9 +3576,16 @@ methods:
35463576
`saveAsync` may not result in the same content.
35473577
35483578
3549-
- If your add-in calls `saveAsync` on an item in compose mode in order to get an item ID to use with EWS or the
3550-
REST API, be aware that when Outlook is in cached mode, it may take some time before the item is actually synced
3551-
to the server. Until the item is synced, using the item ID will return an error.
3579+
- The identifier returned is the same as the [Exchange Web Services (EWS) item
3580+
identifier](https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange)<!--
3581+
-->. The item ID returned isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before
3582+
making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`<!--
3583+
-->.
3584+
3585+
3586+
- If your add-in calls `saveAsync` to get an item ID to use with EWS or the REST API, be aware that when Outlook
3587+
is in cached mode, it may take some time before the item is actually synced to the server. Until the item is
3588+
synced, using the item ID will return an error.
35523589
35533590
35543591
- In Outlook on Mac, only Version 16.35 (20030802) and later supports saving a meeting. Otherwise, the `saveAsync`
@@ -3598,8 +3635,8 @@ methods:
35983635
- id: callback
35993636
description: >-
36003637
When the method completes, the function passed in the `callback` parameter is called with a single
3601-
parameter, `asyncResult`<!-- -->, which is an `Office.AsyncResult` object. The appointment ID is returned in
3602-
the `asyncResult.value` property.
3638+
parameter, `asyncResult`<!-- -->, which is an `Office.AsyncResult` object. The EWS appointment ID is
3639+
returned in the `asyncResult.value` property.
36033640
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;string&gt;) =&gt; void'
36043641
return:
36053642
type: void

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

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -508,22 +508,9 @@ properties:
508508
package: outlook!
509509
fullName: itemId
510510
summary: >-
511-
Gets the [Exchange Web Services item
511+
Gets the [Exchange Web Services (EWS) item
512512
identifier](https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange)
513-
for the current item.
514-
515-
516-
The `itemId` property is not available in compose mode. If an item identifier is required, the `saveAsync` method
517-
can be used to save the item to the store, which will return the item identifier in the `asyncResult.value`
518-
parameter in the callback function.
519-
520-
521-
**Note**: The identifier returned by the `itemId` property is the same as the [Exchange Web Services item
522-
identifier](https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange)<!--
523-
-->. The `itemId` property is not identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before
524-
making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`<!--
525-
-->. For more details, see [Use the Outlook REST APIs from an Outlook
526-
add-in](https://learn.microsoft.com/office/dev/add-ins/outlook/use-rest-api#get-the-item-id)<!-- -->.
513+
of the current item.
527514
remarks: >-
528515
**[Minimum permission
529516
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
@@ -535,6 +522,20 @@ properties:
535522
-->**: Appointment Attendee
536523
537524
525+
**Important**:
526+
527+
528+
- The `itemId` property isn't available in compose mode. If an item identifier is required, the
529+
`Office.context.mailbox.item.saveAsync` method can be used to save the item to the store, which will return the
530+
item identifier in the `asyncResult.value` parameter in the callback function. If the item is already saved, you
531+
can call the `Office.context.mailbox.item.getItemIdAsync` method instead.
532+
533+
534+
- The item ID returned isn't identical to the Outlook Entry ID or the ID used by the Outlook REST API. Before
535+
making REST API calls using this value, it should be converted using `Office.context.mailbox.convertToRestId`<!--
536+
-->.
537+
538+
538539
#### Examples
539540
540541

0 commit comments

Comments
 (0)