Skip to content

Commit a043cd6

Browse files
[Admin] Get latest changes (#934)
1 parent df16e05 commit a043cd6

File tree

159 files changed

+85635
-30637
lines changed

Some content is hidden

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

159 files changed

+85635
-30637
lines changed

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

+641-85
Large diffs are not rendered by default.

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

+312-19
Large diffs are not rendered by default.

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

+391-28
Large diffs are not rendered by default.

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

+81-6
Original file line numberDiff line numberDiff line change
@@ -95,16 +95,16 @@ methods:
9595
isDeprecated: false
9696
syntax:
9797
content: >-
98-
addAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult:
98+
addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult:
9999
Office.AsyncResult<void>) => void): void;
100100
parameters:
101101
- id: categories
102102
description: The categories to be added to the item.
103103
type: 'string[]'
104104
- id: options
105105
description: >-
106-
Optional. An object literal that contains one or more of the following properties. `asyncContext`<!-- -->:
107-
Developers can provide any object they wish to access in the callback method.
106+
An object literal that contains one or more of the following properties. `asyncContext`<!-- -->: Developers
107+
can provide any object they wish to access in the callback method.
108108
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
109109
- id: callback
110110
description: >-
@@ -114,6 +114,47 @@ methods:
114114
return:
115115
type: void
116116
description: ''
117+
- name: 'addAsync(categories, callback)'
118+
uid: 'outlook!Office.Categories#addAsync:member(2)'
119+
package: outlook!
120+
fullName: 'addAsync(categories, callback)'
121+
summary: >-
122+
Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a
123+
unique name but multiple categories can use the same color.
124+
125+
126+
\[ [API set: Mailbox 1.8](/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets) \]
127+
remarks: >-
128+
**[Minimum permission
129+
level](https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
130+
`ReadWriteItem`
131+
132+
133+
**[Applicable Outlook
134+
mode](https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
135+
Compose or Read
136+
137+
138+
**Errors**:
139+
140+
141+
- `InvalidCategory`<!-- -->: Invalid categories were provided.
142+
isPreview: false
143+
isDeprecated: false
144+
syntax:
145+
content: 'addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;'
146+
parameters:
147+
- id: categories
148+
description: The categories to be added to the item.
149+
type: 'string[]'
150+
- id: callback
151+
description: >-
152+
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
153+
parameter of type `Office.AsyncResult`<!-- -->.
154+
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;void&gt;) =&gt; void'
155+
return:
156+
type: void
157+
description: ''
117158
- name: 'getAsync(options, callback)'
118159
uid: 'outlook!Office.Categories#getAsync:member(1)'
119160
package: outlook!
@@ -275,16 +316,16 @@ methods:
275316
isDeprecated: false
276317
syntax:
277318
content: >-
278-
removeAsync(categories: string[], options?: Office.AsyncContextOptions, callback?: (asyncResult:
319+
removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult:
279320
Office.AsyncResult<void>) => void): void;
280321
parameters:
281322
- id: categories
282323
description: The categories to be removed from the item.
283324
type: 'string[]'
284325
- id: options
285326
description: >-
286-
Optional. An object literal that contains one or more of the following properties. `asyncContext`<!-- -->:
287-
Developers can provide any object they wish to access in the callback method.
327+
An object literal that contains one or more of the following properties. `asyncContext`<!-- -->: Developers
328+
can provide any object they wish to access in the callback method.
288329
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
289330
- id: callback
290331
description: >-
@@ -295,3 +336,37 @@ methods:
295336
return:
296337
type: void
297338
description: ''
339+
- name: 'removeAsync(categories, callback)'
340+
uid: 'outlook!Office.Categories#removeAsync:member(2)'
341+
package: outlook!
342+
fullName: 'removeAsync(categories, callback)'
343+
summary: |-
344+
Removes categories from an item.
345+
346+
\[ [API set: Mailbox 1.8](/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets) \]
347+
remarks: >-
348+
**[Minimum permission
349+
level](https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
350+
`ReadWriteItem`
351+
352+
353+
**[Applicable Outlook
354+
mode](https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
355+
Compose or Read
356+
isPreview: false
357+
isDeprecated: false
358+
syntax:
359+
content: 'removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;'
360+
parameters:
361+
- id: categories
362+
description: The categories to be removed from the item.
363+
type: 'string[]'
364+
- id: callback
365+
description: >-
366+
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
367+
parameter of type `Office.AsyncResult`<!-- -->. If removing categories fails, the `asyncResult.error`
368+
property will contain an error code.
369+
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;void&gt;) =&gt; void'
370+
return:
371+
type: void
372+
description: ''

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

+39-3
Original file line numberDiff line numberDiff line change
@@ -231,19 +231,55 @@ methods:
231231
isPreview: false
232232
isDeprecated: false
233233
syntax:
234-
content: 'saveAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void, asyncContext?: any): void;'
234+
content: 'saveAsync(callback: (asyncResult: Office.AsyncResult<void>) => void, asyncContext?: any): void;'
235235
parameters:
236236
- id: callback
237237
description: >-
238-
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
239-
parameter of type `Office.AsyncResult`<!-- -->.
238+
When the method completes, the function passed in the `callback` parameter is called with a single parameter
239+
of type `Office.AsyncResult`<!-- -->.
240240
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;void&gt;) =&gt; void'
241241
- id: asyncContext
242242
description: Optional. Any state data that is passed to the callback method.
243243
type: any
244244
return:
245245
type: void
246246
description: ''
247+
- name: saveAsync(asyncContext)
248+
uid: 'outlook!Office.CustomProperties#saveAsync:member(2)'
249+
package: outlook!
250+
fullName: saveAsync(asyncContext)
251+
summary: >-
252+
Saves item-specific custom properties to the server.
253+
254+
255+
You must call the `saveAsync` method to persist any changes made with the `set` method or the `remove` method of
256+
the `CustomProperties` object. The saving action is asynchronous.
257+
258+
259+
It's a good practice to have your callback function check for and handle errors from `saveAsync`<!-- -->. In
260+
particular, a read add-in can be activated while the user is in a connected state in a read form, and subsequently
261+
the user becomes disconnected. If the add-in calls `saveAsync` while in the disconnected state, `saveAsync` would
262+
return an error. Your callback method should handle this error accordingly.
263+
remarks: >-
264+
**[Minimum permission
265+
level](https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
266+
`ReadItem`
267+
268+
269+
**[Applicable Outlook
270+
mode](https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
271+
Compose or Read
272+
isPreview: false
273+
isDeprecated: false
274+
syntax:
275+
content: 'saveAsync(asyncContext?: any): void;'
276+
parameters:
277+
- id: asyncContext
278+
description: Optional. Any state data that is passed to the callback method.
279+
type: any
280+
return:
281+
type: void
282+
description: ''
247283
- name: 'set(name, value)'
248284
uid: 'outlook!Office.CustomProperties#set:member(1)'
249285
package: outlook!

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

+124-9
Original file line numberDiff line numberDiff line change
@@ -77,16 +77,16 @@ methods:
7777
isDeprecated: false
7878
syntax:
7979
content: >-
80-
addAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?:
80+
addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?:
8181
(asyncResult: Office.AsyncResult<void>) => void): void;
8282
parameters:
8383
- id: locationIdentifiers
8484
description: The locations to be added to the current list of locations.
8585
type: '<xref uid="outlook!Office.LocationIdentifier:interface" />[]'
8686
- id: options
8787
description: >-
88-
Optional. An object literal that contains one or more of the following properties. `asyncContext`<!-- -->:
89-
Developers can provide any object they wish to access in the callback method.
88+
An object literal that contains one or more of the following properties. `asyncContext`<!-- -->: Developers
89+
can provide any object they wish to access in the callback method.
9090
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
9191
- id: callback
9292
description: >-
@@ -97,6 +97,48 @@ methods:
9797
return:
9898
type: void
9999
description: ''
100+
- name: 'addAsync(locationIdentifiers, callback)'
101+
uid: 'outlook!Office.EnhancedLocation#addAsync:member(2)'
102+
package: outlook!
103+
fullName: 'addAsync(locationIdentifiers, callback)'
104+
summary: |-
105+
Adds to the set of locations associated with the appointment.
106+
107+
\[ [API set: Mailbox 1.8](/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets) \]
108+
remarks: >-
109+
**[Minimum permission
110+
level](https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
111+
`ReadWriteItem`
112+
113+
114+
**[Applicable Outlook
115+
mode](https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
116+
Compose
117+
118+
119+
**Errors**:
120+
121+
122+
- `InvalidFormatError`<!-- -->: The format of the specified data object is not valid.
123+
isPreview: false
124+
isDeprecated: false
125+
syntax:
126+
content: >-
127+
addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) =>
128+
void): void;
129+
parameters:
130+
- id: locationIdentifiers
131+
description: The locations to be added to the current list of locations.
132+
type: '<xref uid="outlook!Office.LocationIdentifier:interface" />[]'
133+
- id: callback
134+
description: >-
135+
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
136+
parameter, `asyncResult`<!-- -->, which is an `Office.AsyncResult` object. Check the `status` property of
137+
`asyncResult` to determine if the call succeeded.
138+
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;void&gt;) =&gt; void'
139+
return:
140+
type: void
141+
description: ''
100142
- name: 'getAsync(options, callback)'
101143
uid: 'outlook!Office.EnhancedLocation#getAsync:member(1)'
102144
package: outlook!
@@ -147,13 +189,13 @@ methods:
147189
isDeprecated: false
148190
syntax:
149191
content: >-
150-
getAsync(options?: Office.AsyncContextOptions, callback?: (asyncResult:
192+
getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult:
151193
Office.AsyncResult<LocationDetails[]>) => void): void;
152194
parameters:
153195
- id: options
154196
description: >-
155-
Optional. An object literal that contains one or more of the following properties. `asyncContext`<!-- -->:
156-
Developers can provide any object they wish to access in the callback method.
197+
An object literal that contains one or more of the following properties. `asyncContext`<!-- -->: Developers
198+
can provide any object they wish to access in the callback method.
157199
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
158200
- id: callback
159201
description: >-
@@ -165,6 +207,38 @@ methods:
165207
return:
166208
type: void
167209
description: ''
210+
- name: getAsync(callback)
211+
uid: 'outlook!Office.EnhancedLocation#getAsync:member(2)'
212+
package: outlook!
213+
fullName: getAsync(callback)
214+
summary: |-
215+
Gets the set of locations associated with the appointment.
216+
217+
\[ [API set: Mailbox 1.8](/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets) \]
218+
remarks: >-
219+
**[Minimum permission
220+
level](https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
221+
`ReadItem`
222+
223+
224+
**[Applicable Outlook
225+
mode](https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
226+
Compose or Read
227+
isPreview: false
228+
isDeprecated: false
229+
syntax:
230+
content: 'getAsync(callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void): void;'
231+
parameters:
232+
- id: callback
233+
description: >-
234+
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
235+
parameter, `asyncResult`<!-- -->, which is an `Office.AsyncResult` object.
236+
type: >-
237+
(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;<xref
238+
uid="outlook!Office.LocationDetails:interface" />[]&gt;) =&gt; void
239+
return:
240+
type: void
241+
description: ''
168242
- name: 'removeAsync(locationIdentifiers, options, callback)'
169243
uid: 'outlook!Office.EnhancedLocation#removeAsync:member(1)'
170244
package: outlook!
@@ -221,16 +295,16 @@ methods:
221295
isDeprecated: false
222296
syntax:
223297
content: >-
224-
removeAsync(locationIdentifiers: LocationIdentifier[], options?: Office.AsyncContextOptions, callback?:
298+
removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?:
225299
(asyncResult: Office.AsyncResult<void>) => void): void;
226300
parameters:
227301
- id: locationIdentifiers
228302
description: The locations to be removed from the current list of locations.
229303
type: '<xref uid="outlook!Office.LocationIdentifier:interface" />[]'
230304
- id: options
231305
description: >-
232-
Optional. An object literal that contains one or more of the following properties. `asyncContext`<!-- -->:
233-
Developers can provide any object they wish to access in the callback method.
306+
An object literal that contains one or more of the following properties. `asyncContext`<!-- -->: Developers
307+
can provide any object they wish to access in the callback method.
234308
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
235309
- id: callback
236310
description: >-
@@ -241,3 +315,44 @@ methods:
241315
return:
242316
type: void
243317
description: ''
318+
- name: 'removeAsync(locationIdentifiers, callback)'
319+
uid: 'outlook!Office.EnhancedLocation#removeAsync:member(2)'
320+
package: outlook!
321+
fullName: 'removeAsync(locationIdentifiers, callback)'
322+
summary: >-
323+
Removes the set of locations associated with the appointment.
324+
325+
326+
If there are multiple locations with the same name, all matching locations will be removed even if only one was
327+
specified in `locationIdentifiers`<!-- -->.
328+
329+
330+
\[ [API set: Mailbox 1.8](/office/dev/add-ins/reference/requirement-sets/outlook-api-requirement-sets) \]
331+
remarks: >-
332+
**[Minimum permission
333+
level](https://docs.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
334+
`ReadWriteItem`
335+
336+
337+
**[Applicable Outlook
338+
mode](https://docs.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
339+
Compose
340+
isPreview: false
341+
isDeprecated: false
342+
syntax:
343+
content: >-
344+
removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) =>
345+
void): void;
346+
parameters:
347+
- id: locationIdentifiers
348+
description: The locations to be removed from the current list of locations.
349+
type: '<xref uid="outlook!Office.LocationIdentifier:interface" />[]'
350+
- id: callback
351+
description: >-
352+
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
353+
parameter, `asyncResult`<!-- -->, which is an `Office.AsyncResult` object. Check the `status` property of
354+
`asyncResult` to determine if the call succeeded.
355+
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" />&lt;void&gt;) =&gt; void'
356+
return:
357+
type: void
358+
description: ''

0 commit comments

Comments
 (0)