-
Notifications
You must be signed in to change notification settings - Fork 62
/
office.categories.yml
406 lines (319 loc) · 15.6 KB
/
office.categories.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
### YamlMime:TSType
name: Office.Categories
uid: 'outlook!Office.Categories:interface'
package: outlook!
fullName: Office.Categories
summary: >-
Represents the categories on an item.
In Outlook, a user can tag messages and appointments by using a category to color-code them. The user defines
[categories in a master list](xref:outlook!Office.MasterCategories:interface) on their mailbox. They can then apply
one or more categories to an item.
**Important**: In Outlook on the web, you can't use the API to manage categories applied to a message in Compose
mode.
remarks: >-
\[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
**read item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!-- -->**:
Compose or Read
isPreview: false
isDeprecated: false
type: interface
methods:
- name: 'addAsync(categories, options, callback)'
uid: 'outlook!Office.Categories#addAsync:member(1)'
package: outlook!
fullName: 'addAsync(categories, options, callback)'
summary: >-
Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a
unique name but multiple categories can use the same color.
**Important**: In Outlook on the web, you can't use the API to manage categories applied to a message or
appointment item in Compose mode.
remarks: >-
\[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Compose or Read
**Errors**:
- `InvalidCategory`<!-- -->: Invalid categories were provided.
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml
// Note: In order for you to successfully add a category,
// it must be in the mailbox categories master list.
Office.context.mailbox.masterCategories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const masterCategories = asyncResult.value;
if (masterCategories && masterCategories.length > 0) {
// Grab the first category from the master list.
const categoryToAdd = [masterCategories[0].displayName];
Office.context.mailbox.item.categories.addAsync(categoryToAdd, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(`Successfully assigned category '${categoryToAdd}' to item.`);
} else {
console.log("categories.addAsync call failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("There are no categories in the master list on this mailbox. You can add categories using Office.context.mailbox.masterCategories.addAsync.");
}
} else {
console.error(asyncResult.error);
}
});
```
isPreview: false
isDeprecated: false
syntax:
content: >-
addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult:
Office.AsyncResult<void>) => void): void;
parameters:
- id: categories
description: The categories to be added to the item.
type: 'string[]'
- id: options
description: >-
An object literal that contains one or more of the following properties:- `asyncContext`<!-- -->: Developers
can provide any object they wish to access in the callback function.
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
- id: callback
description: >-
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
parameter of type `Office.AsyncResult`<!-- -->.
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><void>) => void'
return:
type: void
description: ''
- name: 'addAsync(categories, callback)'
uid: 'outlook!Office.Categories#addAsync:member(2)'
package: outlook!
fullName: 'addAsync(categories, callback)'
summary: >-
Adds categories to an item. Each category must be in the categories master list on that mailbox and so must have a
unique name but multiple categories can use the same color.
**Important**: In Outlook on the web, you can't use the API to manage categories applied to a message or
appointment item in Compose mode.
remarks: >-
\[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Compose or Read
**Errors**:
- `InvalidCategory`<!-- -->: Invalid categories were provided.
isPreview: false
isDeprecated: false
syntax:
content: 'addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;'
parameters:
- id: categories
description: The categories to be added to the item.
type: 'string[]'
- id: callback
description: >-
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
parameter of type `Office.AsyncResult`<!-- -->.
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><void>) => void'
return:
type: void
description: ''
- name: 'getAsync(options, callback)'
uid: 'outlook!Office.Categories#getAsync:member(1)'
package: outlook!
fullName: 'getAsync(options, callback)'
summary: >-
Gets an item's categories.
**Important**:
- If there are no categories on the item, `null` or an empty array will be returned depending on the Outlook
version so make sure to handle both cases.
- In Outlook on the web, you can't use the API to manage categories applied to a message in Compose mode.
remarks: >-
\[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Compose or Read
isPreview: false
isDeprecated: false
syntax:
content: >-
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult:
Office.AsyncResult<CategoryDetails[]>) => void): void;
parameters:
- id: options
description: >-
An object literal that contains one or more of the following properties:- `asyncContext`<!-- -->: Developers
can provide any object they wish to access in the callback function.
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
- id: callback
description: >-
When the method completes, the function passed in the `callback` parameter is called with a single parameter
of type `Office.AsyncResult`<!-- -->. If getting categories fails, the `asyncResult.error` property will
contain an error code.
type: >-
(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><<xref
uid="outlook!Office.CategoryDetails:interface" />[]>) => void
return:
type: void
description: ''
- name: getAsync(callback)
uid: 'outlook!Office.Categories#getAsync:member(2)'
package: outlook!
fullName: getAsync(callback)
summary: >-
Gets an item's categories.
**Important**:
- If there are no categories on the item, `null` or an empty array will be returned depending on the Outlook
version so make sure to handle both cases.
- In Outlook on the web, you can't use the API to manage categories applied to a message in Compose mode.
remarks: >-
\[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Compose or Read
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml
Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const categories = asyncResult.value;
if (categories && categories.length > 0) {
console.log("Categories assigned to this item:");
console.log(JSON.stringify(categories));
} else {
console.log("There are no categories assigned to this item.");
}
} else {
console.error(asyncResult.error);
}
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void): void;'
parameters:
- id: callback
description: >-
When the method completes, the function passed in the `callback` parameter is called with a single parameter
of type `Office.AsyncResult`<!-- -->. If getting categories fails, the `asyncResult.error` property will
contain an error code.
type: >-
(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><<xref
uid="outlook!Office.CategoryDetails:interface" />[]>) => void
return:
type: void
description: ''
- name: 'removeAsync(categories, options, callback)'
uid: 'outlook!Office.Categories#removeAsync:member(1)'
package: outlook!
fullName: 'removeAsync(categories, options, callback)'
summary: >-
Removes categories from an item.
**Important**: In Outlook on the web, you can't use the API to manage categories applied to a message in
Compose mode.
remarks: >-
\[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Compose or Read
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/45-categories/work-with-categories.yaml
Office.context.mailbox.item.categories.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const categories = asyncResult.value;
if (categories && categories.length > 0) {
// Grab the first category assigned to this item.
const categoryToRemove = [categories[0].displayName];
Office.context.mailbox.item.categories.removeAsync(categoryToRemove, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(`Successfully unassigned category '${categoryToRemove}' from this item.`);
} else {
console.log("categories.removeAsync call failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("There are no categories assigned to this item.");
}
} else {
console.error(asyncResult.error);
}
});
```
isPreview: false
isDeprecated: false
syntax:
content: >-
removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult:
Office.AsyncResult<void>) => void): void;
parameters:
- id: categories
description: The categories to be removed from the item.
type: 'string[]'
- id: options
description: >-
An object literal that contains one or more of the following properties:- `asyncContext`<!-- -->: Developers
can provide any object they wish to access in the callback function.
type: '<xref uid="office!Office.AsyncContextOptions:interface" />'
- id: callback
description: >-
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
parameter of type `Office.AsyncResult`<!-- -->. If removing categories fails, the `asyncResult.error`
property will contain an error code.
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><void>) => void'
return:
type: void
description: ''
- name: 'removeAsync(categories, callback)'
uid: 'outlook!Office.Categories#removeAsync:member(2)'
package: outlook!
fullName: 'removeAsync(categories, callback)'
summary: >-
Removes categories from an item.
**Important**: In Outlook on the web, you can't use the API to manage categories applied to a message in
Compose mode.
remarks: >-
\[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) \]
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!--
-->**: **read/write item**
**[Applicable Outlook
mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)<!--
-->**: Compose or Read
isPreview: false
isDeprecated: false
syntax:
content: 'removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void): void;'
parameters:
- id: categories
description: The categories to be removed from the item.
type: 'string[]'
- id: callback
description: >-
Optional. When the method completes, the function passed in the `callback` parameter is called with a single
parameter of type `Office.AsyncResult`<!-- -->. If removing categories fails, the `asyncResult.error`
property will contain an error code.
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><void>) => void'
return:
type: void
description: ''