Share via


Office.Sensitivity interface

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

予定の秘密度レベルを取得および設定するメソッドを提供します。 秘密度レベルの詳細については、「 メールを標準、個人用、プライベート、または機密としてマークする」を参照してください。

注釈

[ API セット: メールボックス プレビュー ]

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

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

メソッド

getAsync(options, callback)

予定の秘密度レベルを取得します。

getAsync(callback)

予定の秘密度レベルを取得します。

setAsync(sensitivity, options, callback)

予定の秘密度レベルを設定します。

setAsync(sensitivity, callback)

予定の秘密度レベルを設定します。

メソッドの詳細

getAsync(options, callback)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

予定の秘密度レベルを取得します。

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

パラメーター

options
Office.AsyncContextOptions

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

callback

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

メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。 予定の秘密度レベルが プロパティに asyncResult.value 返されます。

戻り値

void

注釈

[ API セット: メールボックス プレビュー ]

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

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

重要: Outlook on the web、Outlook on Mac、および新しい Outlook on Windows (プレビュー) では、標準およびプライベートの秘密度レベルのみがサポートされます。 これらのクライアントから機密または個人の秘密度レベルを持つ予定を呼び出 getAsync すと、プロパティに asyncResult.value 標準の秘密度レベルが返されます。

getAsync(callback)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

予定の秘密度レベルを取得します。

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

パラメーター

callback

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

メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。 予定の秘密度レベルが プロパティに asyncResult.value 返されます。

戻り値

void

注釈

[ API セット: メールボックス プレビュー ]

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

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

重要: Outlook on the web、Outlook on Mac、および新しい Outlook on Windows (プレビュー) では、標準およびプライベートの秘密度レベルのみがサポートされます。 これらのクライアントから機密または個人の秘密度レベルを持つ予定を呼び出 getAsync すと、プロパティに asyncResult.value 標準の秘密度レベルが返されます。

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

Office.context.mailbox.item.sensitivity.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Sensitivity: " + asyncResult.value);
  } else {
    console.log("Failed to get sensitivity: " + JSON.stringify(asyncResult.error));
  }
});

setAsync(sensitivity, options, callback)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

予定の秘密度レベルを設定します。

setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

sensitivity

Office.MailboxEnums.AppointmentSensitivityType | string

列挙型または文字列としての秘密度レベル。

options
Office.AsyncContextOptions

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

callback

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

省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス プレビュー ]

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

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

重要: Outlook on the web、Outlook on Mac、および新しい Outlook on Windows (プレビュー) では、標準およびプライベートの秘密度レベルのみがサポートされます。

エラー:

  • Unsupported API parameter: 予定の秘密度レベルの設定はサポートされていません。

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

Office.context.mailbox.item.sensitivity.setAsync(
  Office.MailboxEnums.AppointmentSensitivityType.Confidential,
  function callback(asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Failed) {
      console.log("Failed to set appointment sensitivity: " + JSON.stringify(asyncResult.error));
    } else {
      console.log("Successfully set appointment sensitivity.");
    }
  }
);

setAsync(sensitivity, callback)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

予定の秘密度レベルを設定します。

setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType | string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

パラメーター

sensitivity

Office.MailboxEnums.AppointmentSensitivityType | string

列挙型または文字列としての秘密度レベル。

callback

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

省略可能です。 メソッドが完了すると、 パラメーターでcallback渡された関数が、 オブジェクトである 1 つのパラメーターasyncResultOffice.AsyncResultで呼び出されます。

戻り値

void

注釈

[ API セット: メールボックス プレビュー ]

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

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

重要: Outlook on the web、Outlook on Mac、および新しい Outlook on Windows (プレビュー) では、標準およびプライベートの秘密度レベルのみがサポートされます。

エラー:

  • Unsupported API parameter: 予定の秘密度レベルの設定はサポートされていません。