Office.IsAllDayEvent interface

包:

outlook

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

提供在 Outlook 外接程序中获取和设置会议的全天事件状态的方法。

注解

[ API 集：邮箱预览 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

方法

getAsync(options, callback)	获取指示事件是否为全天的布尔值。
getAsync(callback)	获取指示事件是否为全天的布尔值。
setAsync(isAllDayEvent, options, callback)	设置约会的全天事件状态。
setAsync(isAllDayEvent, callback)	设置约会的全天事件状态。

方法详细信息

getAsync(options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取指示事件是否为全天的布尔值。

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

参数

options

Office.AsyncContextOptions

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

callback

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

方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。

返回

void

注解

[ API 集：邮箱预览 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

getAsync(callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取指示事件是否为全天的布尔值。

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

参数

callback

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

方法完成后，使用类型的Office.AsyncResult单个参数调用在 参数中callback传递的函数。

返回

void

注解

[ API 集：邮箱预览 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml

Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Is this an all-day event? " + asyncResult.value);
  } else {
    console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
  }
});

setAsync(isAllDayEvent, options, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

设置约会的全天事件状态。

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

参数

isAllDayEvent

boolean

用于设置全天事件状态的布尔值。

options

Office.AsyncContextOptions

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

callback

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

可选。 方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在 参数中callback传递的函数。

返回

void

注解

[ API 集：邮箱预览 ]

如果约会标记为全天事件： - 开始和结束时间将标记为上午 12：00 (就像在 Outlook UI) 中一样。 开始时间将返回 12：00 AM，结束时间为第二天的 12：00 AM。

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml

Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
  } else {
    console.log("Appointment set to all-day event.");
  }
});

setAsync(isAllDayEvent, callback)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

设置约会的全天事件状态。

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

参数

isAllDayEvent

boolean

用于设置全天事件状态的布尔值。

callback

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

可选。 方法完成后，使用单个参数 asyncResult（即 Office.AsyncResult 对象）调用在 参数中callback传递的函数。

返回

void

注解

[ API 集：邮箱预览 ]

如果约会标记为全天事件： - 开始和结束时间将标记为上午 12：00 (就像在 Outlook UI) 中一样。 开始时间将返回 12：00 AM，结束时间为第二天的 12：00 AM。

最低权限级别： 读/写项

适用的 Outlook 模式：撰写