Export (0) Print
Expand All

Appointment object (JavaScript API for Office v1.1)

JavaScript API for Office v1.1

Represents an appointment item from the server.

Last modified: June 12, 2014

Applicable Outlook modes

Compose or read

Available in requirement sets

Mailbox

Office.context.mailbox.item

Properties

Property name

Outlook mode

Description

Introduced in

attachments

Read

Gets an array of attachments for the appointment.

Version 1.0

body

Compose

Gets a Body object that provides access the body text of the appointment.

Version 1.1

end

Compose or read

Gets a Date object that contains or a Time object that provides access to the date and time that the appointment is to end.

Version 1.0

location

Compose or read

Gets a string that contains or a Location object that provides access to the location of the appointment.

Version 1.0

normalizedSubject

Read

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

Version 1.0

optionalAttendees

Compose or read

Gets an EmailAddressDetails object that contains or a Recipients object that provides access to optional attendees.

Version 1.0

organizer

Read

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

Version 1.0

requiredAttendees

Compose or read

Gets an EmailAddressDetails object that contains or a Recipients object that provides access to required attendees.

Version 1.0

resources

Read

Gets an EmailAddressDetails object that contains a list of resources required for the meeting.

Version 1.0

start

Compose or read

Gets a Date object that contains or a Time object that provides access to the date and time that the appointment is to begin.

Version 1.0

subject

Compose or read

Gets a string that contains or a Subject object that provides access to the complete subject of the appointment with all prefixes.

Version 1.0

Methods

Method name

Outlook mode

Description

Introduced in

addFileAttachmentAsync

Compose

Adds files as attachments to the appointment.

Version 1.1

addItemAttachmentAsync

Compose

Adds mailbox items as attachments to the appointment.

Version 1.1

getEntities

Read

Returns all entities recognized in the appointment.

Version 1.0

getEntitiesByType

Read

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

Version 1.0

getFilteredEntitiesByName

Read

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

Version 1.0

getRegExMatches

Read

Returns all regular expression matches recognized in the appointment.

Version 1.0

getRegExMatchesByName

Read

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

Version 1.0

removeAttachmentAsync

Compose

Removes a specified or all attachments from the appointment.

Version 1.1

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

New functionality in version 1.1

The Appointment object is supported in compose mode mail apps. The following properties were modified to have a different behavior to support compose mode:

  • end property

  • optionalAttendees property

  • requiredAttendees property

  • resources property

  • start property

  • subject property

The following properties and methods were added to support compose mode:

  • addFileAttachmentAsync method

  • addItemAttachmentAsync method

  • body property

  • removeAttachmentAsync method

The following code example 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;

App types

Mail app

Supported clients

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

Library

Office.js

Namespace

Office

Show:
© 2014 Microsoft