-
Notifications
You must be signed in to change notification settings - Fork 64
/
office.appointmentform.yml
317 lines (227 loc) · 10.3 KB
/
office.appointmentform.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
### YamlMime:TSType
name: Office.AppointmentForm
uid: 'outlook!Office.AppointmentForm:interface'
package: outlook!
fullName: Office.AppointmentForm
summary: The `AppointmentForm` object is used to access the currently selected appointment.
remarks: >-
**[Minimum permission
level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)<!-- -->**:
**restricted**
**[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
properties:
- name: body
uid: 'outlook!Office.AppointmentForm#body:member'
package: outlook!
fullName: body
summary: Gets an object that provides methods for manipulating the body of an item.
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 or Read
isPreview: false
isDeprecated: false
syntax:
content: 'body: Body | string;'
return:
type: '<xref uid="outlook!Office.Body:interface" /> | string'
- name: end
uid: 'outlook!Office.AppointmentForm#end:member'
package: outlook!
fullName: end
summary: >-
Gets or sets the date and time that the appointment is to end.
The `end` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the
`convertToLocalClientTime` method to convert the `end` property value to the client's local date and time.
*Read mode*
The `end` property returns a `Date` object.
*Compose mode*
The `end` property returns a `Time` object.
When you use the `Time.setAsync` method to set the end time, you should use the `convertToUtcClientTime` method to
convert the local time on the client to UTC for the server.
remarks: >-
**[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: 'end: Time | Date;'
return:
type: '<xref uid="outlook!Office.Time:interface" /> | Date'
- name: location
uid: 'outlook!Office.AppointmentForm#location:member'
package: outlook!
fullName: location
summary: >-
Gets or sets the location of an appointment.
*Read mode*
The `location` property returns a string that contains the location of the appointment.
*Compose mode*
The `location` property returns a `Location` object that provides methods that are used to get and set the
location of the appointment.
remarks: >-
**[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: 'location: Location | string;'
return:
type: '<xref uid="outlook!Office.Location:interface" /> | string'
- name: optionalAttendees
uid: 'outlook!Office.AppointmentForm#optionalAttendees:member'
package: outlook!
fullName: optionalAttendees
summary: >-
Provides access to the optional attendees of an event. The type of object and level of access depend on the mode
of the current item.
*Read mode*
The `optionalAttendees` property returns an array that contains an
[EmailAddressDetails](xref:outlook!Office.EmailAddressDetails:interface) object for each optional attendee to the
meeting. Collection size limits:
- Web browser, new Mac UI, Android: No limit
- Windows: 500 members
- Classic Mac UI: 100 members
*Compose mode*
The `optionalAttendees` property returns a `Recipients` object that provides methods to get or update the optional
attendees for a meeting. However, depending on the client/platform (i.e., Windows, Mac, etc.), limits may apply on
how many recipients you can get or update. See the [Recipients](xref:outlook!Office.Recipients:interface) object
for more details.
remarks: >-
**[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: 'optionalAttendees: Recipients[] | EmailAddressDetails[];'
return:
type: >-
<xref uid="outlook!Office.Recipients:interface" />[] | <xref
uid="outlook!Office.EmailAddressDetails:interface" />[]
- name: requiredAttendees
uid: 'outlook!Office.AppointmentForm#requiredAttendees:member'
package: outlook!
fullName: requiredAttendees
summary: >-
Provides access to the required attendees of an event. The type of object and level of access depend on the mode
of the current item.
*Read mode*
The `requiredAttendees` property returns an array that contains an
[EmailAddressDetails](xref:outlook!Office.EmailAddressDetails:interface) object for each required attendee to the
meeting. Collection size limits:
- Web browser, new Mac UI, Android: No limit
- Windows: 500 members
- Classic Mac UI: 100 members
*Compose mode*
The `requiredAttendees` property returns a `Recipients` object that provides methods to get or update the required
attendees for a meeting. However, depending on the client/platform (i.e., Windows, Mac, etc.), limits may apply on
how many recipients you can get or update. See the [Recipients](xref:outlook!Office.Recipients:interface) object
for more details.
remarks: >-
**[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: 'requiredAttendees: Recipients[] | EmailAddressDetails[];'
return:
type: >-
<xref uid="outlook!Office.Recipients:interface" />[] | <xref
uid="outlook!Office.EmailAddressDetails:interface" />[]
- name: resources
uid: 'outlook!Office.AppointmentForm#resources:member'
package: outlook!
fullName: resources
summary: >-
Provides access to the resources of an event. Returns an array of strings containing the resources required for
the appointment.
remarks: >-
**[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: 'resources: string[];'
return:
type: 'string[]'
- name: start
uid: 'outlook!Office.AppointmentForm#start:member'
package: outlook!
fullName: start
summary: >-
Gets or sets the date and time that the appointment is to begin.
The `start` property is expressed as a Coordinated Universal Time (UTC) date and time value. You can use the
`convertToLocalClientTime` method to convert the value to the client's local date and time.
*Read mode*
The `start` property returns a `Date` object.
*Compose mode*
The `start` property returns a `Time` object.
When you use the `Time.setAsync` method to set the start time, you should use the `convertToUtcClientTime` method
to convert the local time on the client to UTC for the server.
remarks: >-
**[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: 'start: Time | Date;'
return:
type: '<xref uid="outlook!Office.Time:interface" /> | Date'
- name: subject
uid: 'outlook!Office.AppointmentForm#subject:member'
package: outlook!
fullName: subject
summary: >-
Gets or sets the description that appears in the subject field of an item.
The `subject` property gets or sets the entire subject of the item, as sent by the email server.
*Read mode*
The `subject` property returns a string. Use the `normalizedSubject` property to get the subject minus any leading
prefixes such as RE: and FW:.
*Compose mode*
The `subject` property returns a `Subject` object that provides methods to get and set the subject.
remarks: >-
**[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: 'subject: Subject | string;'
return:
type: '<xref uid="outlook!Office.Subject:interface" /> | string'