Office.SeriesTime interface

参考

包:: outlook

对象 SeriesTime 提供方法，用于获取和设置定期序列中的约会日期和时间，以及获取定期系列中的会议请求的日期和时间。

注解

方法

getDuration()	获取定期约会系列中常用实例的持续时间（以分钟为单位）。
getEndDate()	使用以下 ISO 8601 日期格式获取定期模式的结束日期：“YYYY-MM-DD”。
getEndTime()	使用以下 ISO 8601 格式获取定期模式的常规约会或会议请求实例的结束时间：“THH：mm：ss：mmm”。
getStartDate()	使用以下 ISO 8601 日期格式获取定期模式的开始日期：“YYYY-MM-DD”。
getStartTime()	使用以下 ISO 8601 格式获取定期模式的常见约会实例的开始时间：“THH：mm：ss：mmm”，无论在哪个时区由用户/外接程序设置定期模式。
setDuration(minutes)	设置定期模式中所有约会的持续时间。这也将更改重复周期模式的结束时间。
setEndDate(year, month, day)	设置定期约会系列的结束日期。
setEndDate(date)	设置定期约会系列的结束日期。
setStartDate(year, month, day)	设置定期约会系列的开始日期。
setStartDate(date)	设置定期约会系列的开始日期。
setStartTime(hours, minutes)	设置定期约会系列的所有实例的开始时间，无论在哪个时区设置定期模式 (项的时区默认) 。
setStartTime(time)	设置定期约会系列的所有实例的开始时间，无论在哪个时区设置定期模式 (项的时区默认) 。

方法详细信息

getDuration()

获取定期约会系列中常用实例的持续时间（以分钟为单位）。

getDuration(): number;

number

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写或阅读

示例

// This example gets the duration of a usual instance in a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const duration = recurrence.seriesTime.getDuration();
}

getEndDate()

使用以下 ISO 8601 日期格式获取定期模式的结束日期：“YYYY-MM-DD”。

getEndDate(): string;

string

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写或阅读

示例

// This example gets the end date of a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getEndDate();
}

getEndTime()

使用以下 ISO 8601 格式获取定期模式的常规约会或会议请求实例的结束时间：“THH：mm：ss：mmm”。

getEndTime(): string;

string

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写或阅读

示例

// This example gets the end time of a usual instance in a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getEndTime();
}

getStartDate()

使用以下 ISO 8601 日期格式获取定期模式的开始日期：“YYYY-MM-DD”。

getStartDate(): string;

string

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写或阅读

示例

// This example gets the start date of a recurring appointment series.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getStartDate();
}

getStartTime()

使用以下 ISO 8601 格式获取定期模式的常见约会实例的开始时间：“THH：mm：ss：mmm”，无论在哪个时区由用户/外接程序设置定期模式。

getStartTime(): string;

string

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读取项

适用的 Outlook 模式：撰写或阅读

示例

// This example gets the start time of a usual
// instance in a recurring appointment series.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setDuration(120);

setDuration(minutes)

设置定期模式中所有约会的持续时间。这也将更改重复周期模式的结束时间。

setDuration(minutes: number): void;

参数

minutes: number

约会的长度（以分钟为单位）。

void

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

示例

// This example sets the duration of each appointment
// in a recurring series to 2 hours.
Office.context.mailbox.item.recurrence.getAsync(callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const recurrence = asyncResult.value;
    const endDate = recurrence.seriesTime.getStartTime();
}

setEndDate(year, month, day)

设置定期约会系列的结束日期。

setEndDate(year: number, month: number, day: number): void;

参数

year: number

结束日期的年份值。

month: number

结束日期的月份值。有效范围为 0-11，其中 0 表示第 1 个月，11 表示第 12 个月。

day: number

结束日期的日值。

void

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

示例

// This example sets the end date of a recurring
// appointment series to November 2, 2017.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setEndDate(2017, 10, 2);

setEndDate(date)

设置定期约会系列的结束日期。

setEndDate(date: string): void;

参数

date: string

以 ISO 8601 日期格式表示的定期约会系列的结束日期：“YYYY-MM-DD”。

void

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

示例

// This example sets the end date of a
// recurring appointment series to November 2, 2017
// using ISO 8601 date standard.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setEndDate("2017-11-02");

setStartDate(year, month, day)

设置定期约会系列的开始日期。

setStartDate(year:number, month:number, day:number): void;

参数

year: number

开始日期的年份值。

month: number

开始日期的月份值。有效范围为 0-11，其中 0 表示第 1 个月，11 表示第 12 个月。

day: number

开始日期的日期值。

void

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

示例

// This example sets the start date of a recurring
// appointment series to November 2, 2017.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setStartDate(2017, 10, 2);

setStartDate(date)

设置定期约会系列的开始日期。

setStartDate(date:string): void;

参数

date: string

以 ISO 8601 日期格式表示的定期约会系列的开始日期：“YYYY-MM-DD”。

void

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

示例

// This example sets the start date of a recurring
// appointment series to November 2, 2017
// using ISO 8601 date standard.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setStartDate("2017-11-02");

setStartTime(hours, minutes)

设置定期约会系列的所有实例的开始时间，无论在哪个时区设置定期模式 (项的时区默认) 。

setStartTime(hours: number, minutes: number): void;

参数

hours: number

开始时间的小时值。有效范围：0-24。

minutes: number

开始时间的分钟值。有效范围：0-59。

void

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

示例

// This example sets the start time of each instance
// of a recurring appointment series to 1:30 PM.
const seriesTimeObject = new SeriesTime();
seriesTimeObject.setStartTime(13, 30);

// This example sets the start time of each instance
// of a recurring appointment series to 11:30 AM.
seriesTimeObject.setStartTime(11, 30);

setStartTime(time)

设置定期约会系列的所有实例的开始时间，无论在哪个时区设置定期模式 (项的时区默认) 。

setStartTime(time: string): void;

参数

time: string

标准日期时间字符串格式表示的所有实例的开始时间：“THH：mm：ss：mmm”。

void

注解

[ API set： Mailbox 1.7 ]

最低权限级别： 读/写项

适用的 Outlook 模式：撰写

示例

// This example sets the start time of each instance
// of a recurring appointment series to 11:30 PM.
const seriesTimeObject = new SeriesTime()
seriesTimeObject.setStartTime("T23:30:00");

Office.SeriesTime interface

注解

方法

方法详细信息

getDuration()

返回

注解

示例

getEndDate()

返回

注解

示例

getEndTime()

返回

注解

示例

getStartDate()

返回

注解

示例

getStartTime()

返回

注解

示例

setDuration(minutes)

参数

返回

注解

示例

setEndDate(year, month, day)

参数

返回

注解

示例

setEndDate(date)

参数

返回

注解

示例

setStartDate(year, month, day)

参数

返回

注解

示例

setStartDate(date)

参数

返回

注解

示例

setStartTime(hours, minutes)

参数

返回

注解

示例

setStartTime(time)

参数

返回

注解

示例

反馈

其他资源