-
Notifications
You must be signed in to change notification settings - Fork 64
/
office.time.yml
297 lines (225 loc) · 11.2 KB
/
office.time.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
### YamlMime:TSType
name: Office.Time
uid: 'outlook!Office.Time:interface'
package: outlook!
fullName: Office.Time
summary: The `Time` object is returned as the start or end property of an appointment in compose mode.
remarks: >-
\[ [API set: Mailbox 1.1](/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
isPreview: false
isDeprecated: false
type: interface
methods:
- name: 'getAsync(options, callback)'
uid: 'outlook!Office.Time#getAsync:member(1)'
package: outlook!
fullName: 'getAsync(options, callback)'
summary: >-
Gets the start or end time of an appointment.
The date and time is provided as a `Date` object in the `asyncResult.value` property. The value is in Coordinated
Universal Time (UTC). You can convert the UTC time to the local client time by using the
`convertToLocalClientTime` method.
remarks: >-
\[ [API set: Mailbox 1.1](/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
isPreview: false
isDeprecated: false
syntax:
content: >-
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => 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`<!-- -->. The `value` property of the result is a `Date` object.
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><Date>) => void'
return:
type: void
description: ''
- name: getAsync(callback)
uid: 'outlook!Office.Time#getAsync:member(2)'
package: outlook!
fullName: getAsync(callback)
summary: >-
Gets the start or end time of an appointment.
The date and time is provided as a `Date` object in the `asyncResult.value` property. The value is in Coordinated
Universal Time (UTC). You can convert the UTC time to the local client time by using the
`convertToLocalClientTime` method.
remarks: >-
\[ [API set: Mailbox 1.1](/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
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment starts: ${result.value}`);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => 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`<!-- -->. The `value` property of the result is a `Date` object.
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><Date>) => void'
return:
type: void
description: ''
- name: 'setAsync(dateTime, options, callback)'
uid: 'outlook!Office.Time#setAsync:member(1)'
package: outlook!
fullName: 'setAsync(dateTime, options, callback)'
summary: >-
Sets the start or end time of an appointment.
If the `setAsync` method is called on the start property, the `end` property will be adjusted to maintain the
duration of the appointment as previously set. If the `setAsync` method is called on the `end` property, the
duration of the appointment will be extended to the new end time.
The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method.
**Important**: In the Windows client, you can't use this method to update the start or end of a recurrence.
remarks: >-
\[ [API set: Mailbox 1.1](/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
**Errors**:
- `InvalidEndTime`<!-- -->: The appointment end time is before the appointment start time.
#### Examples
```TypeScript
const startTime = new Date("3/14/2015");
const options = {
// Pass information that can be used in the callback.
asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.start.setAsync(startTime, options, function(result) {
if (result.error) {
console.debug(result.error);
} else {
// Access the asyncContext that was passed to the setAsync method.
console.debug("Start Time " + result.asyncContext.verb);
}
});
```
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml
const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set start date and time to ${start}`);
});
...
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Get start date failed with message ${result.error.message}`);
return;
}
const end = result.value; // Set end to current start date and time.
end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
Office.context.mailbox.item.end.setAsync(end, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Set end date failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set end date and time to ${end}`);
});
});
```
isPreview: false
isDeprecated: false
syntax:
content: >-
setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult:
Office.AsyncResult<void>) => void): void;
parameters:
- id: dateTime
description: A date-time object in Coordinated Universal Time (UTC).
type: Date
- 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 setting the date and time 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: 'setAsync(dateTime, callback)'
uid: 'outlook!Office.Time#setAsync:member(2)'
package: outlook!
fullName: 'setAsync(dateTime, callback)'
summary: >-
Sets the start or end time of an appointment.
If the `setAsync` method is called on the start property, the `end` property will be adjusted to maintain the
duration of the appointment as previously set. If the `setAsync` method is called on the `end` property, the
duration of the appointment will be extended to the new end time.
The time must be in UTC; you can get the correct UTC time by using the `convertToUtcClientTime` method.
**Important**: In the Windows client, you can't use this method to update the start or end of a recurrence.
remarks: >-
\[ [API set: Mailbox 1.1](/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
**Errors**:
- `InvalidEndTime`<!-- -->: The appointment end time is before the appointment start time.
isPreview: false
isDeprecated: false
syntax:
content: 'setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;'
parameters:
- id: dateTime
description: A date-time object in Coordinated Universal Time (UTC).
type: Date
- 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 setting the date and time fails, the `asyncResult.error`
property will contain an error code.
type: '(asyncResult: <xref uid="office!Office.AsyncResult:interface" /><void>) => void'
return:
type: void
description: ''