Office.SeriesTime interface

リファレンス

パッケージ:: outlook

オブジェクトには SeriesTime 、定期的な一連の予定の日付と時刻を取得および設定し、定期的な一連の会議出席依頼の日付と時刻を取得するメソッドが用意されています。

注釈

メソッド

getDuration()	定期的な予定の一連の通常のインスタンスの期間を分単位で取得します。
getEndDate()	"YYYY-MM-DD" という ISO 8601 日付形式の繰り返しパターンの終了日を取得します。
getEndTime()	ユーザーまたはアドインが ISO 8601 形式の "THH:mm:ss:mmm" を使用して繰り返しパターンを設定したタイムゾーンの定期的なパターンの通常の予定または会議出席依頼インスタンスの終了時刻を取得します。
getStartDate()	"YYYY-MM-DD" という ISO 8601 日付形式の繰り返しパターンの開始日を取得します。
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 セット: メールボックス 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()

"YYYY-MM-DD" という ISO 8601 日付形式の繰り返しパターンの終了日を取得します。

getEndDate(): string;

戻り値

string

注釈

[ API セット: メールボックス 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 セット: メールボックス 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()

"YYYY-MM-DD" という ISO 8601 日付形式の繰り返しパターンの開始日を取得します。

getStartDate(): string;

戻り値

string

注釈

[ API セット: メールボックス 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 セット: メールボックス 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 セット: メールボックス 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 セット: メールボックス 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 セット: メールボックス 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 セット: メールボックス 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 セット: メールボックス 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 セット: メールボックス 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

標準の datetime 文字列形式で表されるすべてのインスタンスの開始時刻: "THH:mm:ss:mmm"

戻り値

void

注釈

[ API セット: メールボックス 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)

パラメーター

戻り値

注釈

例

その他のリソース