Office.Time interface

Package:

outlook

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

Remarks

[Api set: Mailbox 1.1]

Minimum permission level: read item

Applicable Outlook mode: Compose

Methods

getAsync(options, callback)	Gets the start or end time of an appointment. 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.
getAsync(callback)	Gets the start or end time of an appointment. 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.
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. Important: In the Windows client, you can't use this method to update the start or end of a recurrence.
setAsync(dateTime, 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. Important: In the Windows client, you can't use this method to update the start or end of a recurrence.

Method Details

getAsync(options, callback)

Gets the start or end time of an appointment.

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.

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => void): void;

Parameters

options

Office.AsyncContextOptions

An object literal that contains one or more of the following properties:- asyncContext: Developers can provide any object they wish to access in the callback function.

callback

(asyncResult: Office.AsyncResult<Date>) => void

When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. The value property of the result is a Date object.

Returns

void

Remarks

[Api set: Mailbox 1.1]

Minimum permission level: read item

Applicable Outlook mode: Compose

getAsync(callback)

Gets the start or end time of an appointment.

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.

getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => void): void;

Parameters

callback

(asyncResult: Office.AsyncResult<Date>) => void

When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. The value property of the result is a Date object.

Returns

void

Remarks

[Api set: Mailbox 1.1]

Minimum permission level: read item

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.

Important: In the Windows client, you can't use this method to update the start or end of a recurrence.

setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameters

dateTime

Date

A date-time object in Coordinated Universal Time (UTC).

options

Office.AsyncContextOptions

An object literal that contains one or more of the following properties:- asyncContext: Developers can provide any object they wish to access in the callback function.

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. If setting the date and time fails, the asyncResult.error property will contain an error code.

Returns

void

Remarks

[Api set: Mailbox 1.1]

Minimum permission level: read/write item

Applicable Outlook mode: Compose

Errors:

• InvalidEndTime: The appointment end time is before the appointment start time.

setAsync(dateTime, 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.

Important: In the Windows client, you can't use this method to update the start or end of a recurrence.

setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parameters

dateTime

Date

A date-time object in Coordinated Universal Time (UTC).

callback

(asyncResult: Office.AsyncResult<void>) => void

Optional. When the method completes, the function passed in the callback parameter is called with a single parameter of type Office.AsyncResult. If setting the date and time fails, the asyncResult.error property will contain an error code.

Returns

void

Remarks

[Api set: Mailbox 1.1]

Minimum permission level: read/write item

Applicable Outlook mode: Compose

Errors:

• InvalidEndTime: The appointment end time is before the appointment start time.