Office.AppointmentForm interface
Represents the details of the form for creating a new appointment.
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/55-display-items/display-new-appointment.yaml
const start = new Date();
const end = new Date();
end.setHours(start.getHours() + 1);
// The async version is only available starting with requirement set 1.9,
// and provides a callback when the new appointment form has been created.
Office.context.mailbox.displayNewAppointmentFormAsync(
{
requiredAttendees: ["bob@contoso.com"] as any,
optionalAttendees: ["sam@contoso.com"] as any,
start: start,
end: end,
location: "Home",
subject: "meeting",
resources: ["projector@contoso.com"] as any,
body: "Hello World!"
},
function(asyncResult) {
console.log(JSON.stringify(asyncResult));
}
);
Properties
| body | Sets the body of the appointment. |
| end | Sets the date and time that the appointment is to end. |
| location | Sets the location of the appointment. |
| optional |
Sets the optional attendees of the appointment. |
| required |
Sets the required attendees of the appointment. |
| resources | Sets the resources of the appointment. |
| start | Sets the date and time that the appointment is to begin. |
| subject | Sets the description that appears in the Title field of the appointment. |
Property Details
body
Sets the body of the appointment.
body?: string;Property Value
string
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read
end
Sets the date and time that the appointment is to end.
end?: Date | number;Property Value
Date | number
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read
location
Sets the location of the appointment.
location?: string;Property Value
string
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read
optionalAttendees
Sets the optional attendees of the appointment.
optionalAttendees?: string[] | EmailAddressDetails[];Property Value
string[] | Office.EmailAddressDetails[]
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read
requiredAttendees
Sets the required attendees of the appointment.
requiredAttendees?: string[] | EmailAddressDetails[];Property Value
string[] | Office.EmailAddressDetails[]
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read
resources
Sets the resources of the appointment.
resources?: string[];Property Value
string[]
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read
start
Sets the date and time that the appointment is to begin.
start?: Date | number;Property Value
Date | number
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read
subject
Sets the description that appears in the Title field of the appointment.
subject?: string;Property Value
string
Remarks
Minimum permission level: read item
Applicable Outlook mode: Read