Office.Time interface

在 Time 撰写模式下,该对象作为约会的开始或结束属性返回。

方法

getAsync(options, callback)

获取约会的开始或结束时间。

日期和时间作为属性中的asyncResult.value对象提供Date。 该值以协调世界时 (UTC) 表示。 可以使用此 convertToLocalClientTime 方法将 UTC 时间转换为本地客户端时间。

getAsync(callback)

获取约会的开始或结束时间。

日期和时间作为属性中的asyncResult.value对象提供Date。 该值以协调世界时 (UTC) 表示。 可以使用此 convertToLocalClientTime 方法将 UTC 时间转换为本地客户端时间。

setAsync(dateTime, options, callback)

设置约会的开始或结束时间。

如果在 start 属性上调用该 setAsync 方法,则将调整该 end 属性以保持之前设置的约会持续时间。 如果对 setAsync 属性调用了end 方法,则约会的持续时间将延长到新的结束时间。

时间必须以 UTC 格式表示;您可以使用 convertToUtcClientTime 方法获取正确的 UTC 时间。

重要提示: 在 Windows 客户端中,不能使用此方法更新重复周期的开始或结束。

setAsync(dateTime, callback)

设置约会的开始或结束时间。

如果在 start 属性上调用该 setAsync 方法,则将调整该 end 属性以保持之前设置的约会持续时间。 如果对 setAsync 属性调用了end 方法,则约会的持续时间将延长到新的结束时间。

时间必须以 UTC 格式表示;您可以使用 convertToUtcClientTime 方法获取正确的 UTC 时间。

重要提示: 在 Windows 客户端中,不能使用此方法更新重复周期的开始或结束。

方法详细信息

getAsync(options, callback)

获取约会的开始或结束时间。

日期和时间作为属性中的asyncResult.value对象提供Date。 该值以协调世界时 (UTC) 表示。 可以使用此 convertToLocalClientTime 方法将 UTC 时间转换为本地客户端时间。

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

参数

options
Office.AsyncContextOptions

包含以下一个或多个属性的对象文本:- asyncContext:开发人员可以在回调函数中提供他们希望访问的任何对象。

callback

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

当该方法完成时, callback 将使用类型 Office.AsyncResult为 . value结果的属性是一个Date对象。

返回

void

注解

API 集:邮箱 1.1

最低权限级别: 读取项目

适用的 Outlook 模式:Compose

getAsync(callback)

获取约会的开始或结束时间。

日期和时间作为属性中的asyncResult.value对象提供Date。 该值以协调世界时 (UTC) 表示。 可以使用此 convertToLocalClientTime 方法将 UTC 时间转换为本地客户端时间。

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

参数

callback

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

当该方法完成时,将使用类型 Office.AsyncResult为 . value结果的属性是一个Date对象。

返回

void

注解

API 集:邮箱 1.1

最低权限级别: 读取项目

适用的 Outlook 模式:Compose

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }

  const time = result.value;
  const localTime = Office.context.mailbox.convertToLocalClientTime(time);
  console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});

setAsync(dateTime, options, callback)

设置约会的开始或结束时间。

如果在 start 属性上调用该 setAsync 方法,则将调整该 end 属性以保持之前设置的约会持续时间。 如果对 setAsync 属性调用了end 方法,则约会的持续时间将延长到新的结束时间。

时间必须以 UTC 格式表示;您可以使用 convertToUtcClientTime 方法获取正确的 UTC 时间。

重要提示: 在 Windows 客户端中,不能使用此方法更新重复周期的开始或结束。

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

参数

dateTime

Date

采用协调世界时 (UTC) 的日期-时间对象。

options
Office.AsyncContextOptions

包含以下一个或多个属性的对象文本:- asyncContext:开发人员可以在回调函数中提供他们希望访问的任何对象。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . 如果设置日期和时间失败,asyncResult.error 属性将包含一个错误代码。

返回

void

注解

API 集:邮箱 1.1

最低权限级别: 读取/写入项目

适用的 Outlook 模式:Compose

错误:

  • InvalidEndTime :约会结束时间早于约会开始时间。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml

const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

...

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  const end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

setAsync(dateTime, callback)

设置约会的开始或结束时间。

如果在 start 属性上调用该 setAsync 方法,则将调整该 end 属性以保持之前设置的约会持续时间。 如果对 setAsync 属性调用了end 方法,则约会的持续时间将延长到新的结束时间。

时间必须以 UTC 格式表示;您可以使用 convertToUtcClientTime 方法获取正确的 UTC 时间。

重要提示: 在 Windows 客户端中,不能使用此方法更新重复周期的开始或结束。

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

参数

dateTime

Date

采用协调世界时 (UTC) 的日期-时间对象。

callback

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

可选。 当该方法完成时, callback 将使用类型 Office.AsyncResult为 . 如果设置日期和时间失败,asyncResult.error 属性将包含一个错误代码。

返回

void

注解

API 集:邮箱 1.1

最低权限级别: 读取/写入项目

适用的 Outlook 模式:Compose

错误:

  • InvalidEndTime :约会结束时间早于约会开始时间。