Office.Time interface

  • 参考
包:
outlook

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

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

方法

getAsync(options, callback)

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

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

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

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

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

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

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

重要提示：在 Windows 客户端中，不能使用此方法更新重复周期的开始或结束时间。
setAsync(dateTime, callback)

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

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

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

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

方法详细信息

getAsync(options, callback)

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

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

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

参数

options
Office.AsyncContextOptions

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

callback

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

方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。 value结果的 属性是 对象Date。

返回

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

getAsync(callback)

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

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

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

参数

callback

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

方法完成后，使用类型的 Office.AsyncResult单个参数调用在回调参数中传递的函数。 value结果的 属性是 对象Date。

返回

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

示例

// 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;
  }
  console.log(`Appointment starts: ${result.value}`);
});

setAsync(dateTime, options, callback)

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

setAsync如果在 start 属性上调用了 方法，则将调整 该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

可选。 方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。 如果设置日期和时间失败，asyncResult.error 属性将包含一个错误代码。

返回

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

错误：

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

示例

const startTime = new Date("3/14/2015");
const 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 method.
        console.debug("Start Time " + result.asyncContext.verb);
    }
});

// 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)

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

setAsync如果在 start 属性上调用了 方法，则将调整 该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

可选。 方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。 如果设置日期和时间失败，asyncResult.error 属性将包含一个错误代码。

返回

void

注解

[ API set： Mailbox 1.1 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

错误：

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