Office.AppointmentForm interface
The AppointmentForm object is used to access the currently selected appointment.
Remarks
Minimum permission level: restricted
Applicable Outlook mode: Compose or Read
Properties
| body | Gets an object that provides methods for manipulating the body of an item. |
| end | Gets or sets the date and time that the appointment is to end. The Read mode The Compose mode The When you use the |
| location | Gets or sets the location of an appointment. Read mode The Compose mode The |
| optional |
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
Compose mode The |
| required |
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
Compose mode The |
| resources | Provides access to the resources of an event. Returns an array of strings containing the resources required for the appointment. |
| start | Gets or sets the date and time that the appointment is to begin. The Read mode The Compose mode The When you use the |
| subject | Gets or sets the description that appears in the subject field of an item. The Read mode The Compose mode The |
Property Details
body
Gets an object that provides methods for manipulating the body of an item.
body: Body | string;Property Value
Office.Body | string
Remarks
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
end
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.
end: Time | Date;Property Value
Office.Time | Date
Remarks
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
location
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.
location: Location | string;Property Value
Office.Location | string
Remarks
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
optionalAttendees
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 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 object for more details.
optionalAttendees: Recipients[] | EmailAddressDetails[];Property Value
Remarks
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
requiredAttendees
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 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 object for more details.
requiredAttendees: Recipients[] | EmailAddressDetails[];Property Value
Remarks
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
resources
Provides access to the resources of an event. Returns an array of strings containing the resources required for the appointment.
resources: string[];Property Value
string[]
Remarks
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
start
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.
start: Time | Date;Property Value
Office.Time | Date
Remarks
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
subject
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.
subject: Subject | string;Property Value
Office.Subject | string
Remarks
Minimum permission level: read item
Applicable Outlook mode: Compose or Read
Office Add-ins