Office.Time interface

予定の開始または終了の時刻を取得します。

日付と時刻は、asyncResult.value プロパティでDateオブジェクトとして提供されます。 値は、世界協定時刻 (UTC) です。 convertToLocalClientTime メソッドを使用して、UTC 時刻をローカル クライアント時刻に変換できます。

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

パラメーター

返品

注釈

API セット: メールボックス 1.1

最小アクセス許可レベル: 項目の読み取り

適用可能な Outlook モード: Compose

予定の開始または終了の時刻を取得します。

日付と時刻は、asyncResult.value プロパティでDateオブジェクトとして提供されます。 値は、世界協定時刻 (UTC) です。 convertToLocalClientTime メソッドを使用して、UTC 時刻をローカル クライアント時刻に変換できます。

getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => void): 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 メソッドが呼び出されると、 end プロパティは、以前に設定された予定の期間を維持するように調整されます。 end プロパティで setAsync メソッドが呼び出されると、予定の期間が新しい終了時刻に延長されます。

この時刻は UTC でなければなりません。convertToUtcClientTime メソッドを使用して、正確な UTC 時刻を取得できます。

重要: Windows クライアントでは、このメソッドを使用して定期的な開始または終了を更新することはできません。

setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): 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 メソッドが呼び出されると、 end プロパティは、以前に設定された予定の期間を維持するように調整されます。 end プロパティで setAsync メソッドが呼び出されると、予定の期間が新しい終了時刻に延長されます。

この時刻は UTC でなければなりません。convertToUtcClientTime メソッドを使用して、正確な UTC 時刻を取得できます。

重要: Windows クライアントでは、このメソッドを使用して定期的な開始または終了を更新することはできません。

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

パラメーター

返品

注釈

API セット: メールボックス 1.1

最小アクセス許可レベル: 項目の読み取り/書き込み

適用可能な Outlook モード: Compose

エラー:

• InvalidEndTime : 予定の終了時刻は、予定の開始時刻より前になります。