Time

The Time object is returned as the start or end property of an appointment in compose mode.

Requirements
Requirement Value
Minimum mailbox requirement set version 1.1
Minimum permission level ReadItem
Applicable Outlook mode Compose
Members and methods
Member Type
getAsync Method
setAsync Method

Methods

getAsync([options], callback)

Gets the start or end time of an appointment.

Parameters:
Name Type Attributes Description
options Object <optional> An object literal that contains one or more of the following properties.
options.asyncContext Object <optional> Developers can provide any object they wish to access in the callback method.
callback function When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.

The date and time is provided as a Date object in the asyncResult.value property. The value is in Coordinated Universal Time (UTC). You can convert the UTC time to the local client time by using the convertToLocalClientTime method.|

Requirements
Requirement Value
Minimum mailbox requirement set version 1.1
Minimum permission level ReadItem
Applicable Outlook mode Compose

setAsync(dateTime, [options], [callback])

Sets the start or end time of an appointment.

If the setAsync method is called on the start property, the end property will be adjusted to maintain the duration of the appointment as previously set. If the setAsync method is called on the end property, the duration of the appointment will be extended to the new end time.

The time must be in UTC; you can get the correct UTC time by using the convertToUtcClientTime method.

Parameters:
Name Type Attributes Description
dateTime Date A Date object in Coordinated Universal Time (UTC).
options Object <optional> An object literal that contains one or more of the following properties.
options.asyncContext Object <optional> Developers can provide any object they wish to access in the callback method.
callback function <optional> When the method completes, the function passed in the callback parameter is called with a single parameter, asyncResult, which is an AsyncResult object.
If setting the date and time fails, the asyncResult.error property will contain an error code.
Errors
Error code Description
InvalidEndTime The appointment end time is before the appointment start time.
Requirements
Requirement Value
Minimum mailbox requirement set version 1.1
Minimum permission level ReadWriteItem
Applicable Outlook mode Compose
Example

The following example sets the start time of an appointment.

var startTime = new Date("3/14/2015");
var options = {
  // Pass information that can be used
  // in the callback
     asyncContext: {verb:"Set"}
}
Office.context.mailbox.item.start.setAsync(startTime, options, function(result) {
  if (result.error) {
    console.debug(result.error);
  } else {
    // Access the asyncContext that was passed to the setAsync function
    console.debug("Start Time " + result.asyncContext.verb);
  }
});
onsole.debug(result.error); } else { // Access the asyncContext that was passed to the setAsync function console.debug("Start Time " + result.asyncContext.verb); } });