Appointment object (JavaScript API for Office v1.0)

JavaScript API for Office v1.0

Represents an appointment item from the server.

Last modified: June 16, 2014

Office.context.mailbox.item

Properties

Property name

Description

attachments

Gets an array of attachments for the appointment.

end

Gets the date and time that the appointment is to end.

location

Gets the location of the appointment.

normalizedSubject

Gets the subject of the appointment, with all prefixes removed (including "RE:" and "FWD:").

optionalAttendees

Gets an EmailAddressDetails object that contains optional attendees.

organizer

Gets an EmailAddressDetails object that contains the organizer of the appointment.

requiredAttendees

Gets an EmailAddressDetails object that contains required attendees.

resources

Gets a list of resources required for the meeting.

start

Gets the date and time that the appointment is to begin.

subject

Gets the complete subject of the appointment with all prefixes.

Methods

Method name

Description

getEntities

Returns all entities recognized in the appointment.

getEntitiesByType

Returns all entities of the specified type recognized in the appointment.

getFilteredEntitiesByName

Returns all matches recognized in the appointment that meet the requirements of the named filter.

getRegExMatches

Returns all regular expression matches recognized in the appointment.

getRegExMatchesByName

Returns all regular expression matches recognized in the appointment using the named regular expression.

The Appointment object is returned as the item property of the Mailbox object. The Appointment object extends the Item object.

The following example code assigns the start and end properties of the Appointment object to variables.

var startDateTime = Office.context.mailbox.item.start;
var endDateTime = Office.context.mailbox.item.end;

Supported clients

Outlook 2013, Outlook 2013 RT, Outlook Web App, and OWA for Devices

Library

Outlook-15.js, OutlookWebApp-15.js

Namespace

Office

Show:
© 2014 Microsoft