Office.Time interface

リファレンス

パッケージ:: outlook

オブジェクトは Time 、作成モードの予定の start プロパティまたは end プロパティとして返されます。

注釈

メソッド

getAsync(options, callback)	予定の開始または終了の時刻を取得します。日付と時刻は、プロパティの`DateasyncResult.value`オブジェクトとして提供されます。値は、世界協定時刻 (UTC) です。メソッドを使用して、UTC 時刻をローカルクライアント時刻に `convertToLocalClientTime` 変換できます。
getAsync(callback)	予定の開始または終了の時刻を取得します。日付と時刻は、プロパティの`DateasyncResult.value`オブジェクトとして提供されます。値は、世界協定時刻 (UTC) です。メソッドを使用して、UTC 時刻をローカルクライアント時刻に `convertToLocalClientTime` 変換できます。
setAsync(dateTime, options, callback)	予定の開始または終了の時刻を設定します。 start プロパティで `setAsync` メソッドが呼び出された場合、 `end` プロパティは、前に設定した予定の期間を維持するように調整されます。プロパティで `setAsyncend` メソッドが呼び出された場合、予定の期間は新しい終了時刻まで延長されます。この時刻は UTC でなければなりません。`convertToUtcClientTime` メソッドを使用して、正確な UTC 時刻を取得できます。重要: Windows クライアントでは、このメソッドを使用して繰り返しの開始または終了を更新することはできません。
setAsync(dateTime, callback)	予定の開始または終了の時刻を設定します。 start プロパティで `setAsync` メソッドが呼び出された場合、 `end` プロパティは、前に設定した予定の期間を維持するように調整されます。プロパティで `setAsyncend` メソッドが呼び出された場合、予定の期間は新しい終了時刻まで延長されます。この時刻は UTC でなければなりません。`convertToUtcClientTime` メソッドを使用して、正確な UTC 時刻を取得できます。重要: Windows クライアントでは、このメソッドを使用して繰り返しの開始または終了を更新することはできません。

メソッドの詳細

getAsync(options, callback)

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

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

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

パラメーター

options: Office.AsyncContextOptions

次のプロパティの 1 つ以上を含むオブジェクトリテラル:- asyncContext: 開発者は、コールバック関数でアクセスする任意のオブジェクトを指定できます。

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

メソッドが完了すると、パラメーターで callback 渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。 value結果のプロパティはオブジェクトですDate。

戻り値

void

注釈

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

最小アクセス許可レベル: アイテムの読み取り

適用できる Outlook モード: 新規作成

getAsync(callback)

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

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

パラメーター

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

メソッドが完了すると、コールバックパラメーターで渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。 value結果のプロパティはオブジェクトですDate。

戻り値

void

注釈

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

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

start プロパティで setAsync メソッドが呼び出された場合、 end プロパティは、前に設定した予定の期間を維持するように調整されます。プロパティで setAsyncend メソッドが呼び出された場合、予定の期間は新しい終了時刻まで延長されます。

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

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

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

パラメーター

dateTime: Date

協定世界時 (UTC) の日時オブジェクト。

options: Office.AsyncContextOptions

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

オプション。メソッドが完了すると、パラメーターで callback 渡された関数が、型 Office.AsyncResultの 1 つのパラメーターで呼び出されます。日付と時刻の設定が失敗した場合、asyncResult.error プロパティにはエラーコードが格納されます。

戻り値

void

注釈

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

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

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

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

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

パラメーター

dateTime: Date

協定世界時 (UTC) の日時オブジェクト。

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

戻り値

void

注釈

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

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

適用できる Outlook モード: 新規作成

エラー:

InvalidEndTime: 予定の終了時刻は、予定の開始時刻の前です。

次の方法で共有

Office.Time interface

注釈

メソッド

メソッドの詳細

getAsync(options, callback)

パラメーター

戻り値

注釈

getAsync(callback)

パラメーター

戻り値

注釈

例

setAsync(dateTime, options, callback)

パラメーター

戻り値

注釈

例

setAsync(dateTime, callback)

パラメーター

戻り値

注釈

その他のリソース