Office.Sensitivity interface

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

注釈

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

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

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

メソッド

getAsync(options, callback)

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

getAsync(callback)

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

setAsync(sensitivity, options, callback)

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

setAsync(sensitivity, callback)

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

メソッドの詳細

getAsync(options, callback)

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

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 パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。 予定の秘密度レベルは、 asyncResult.value プロパティで返されます。

戻り値

void

注釈

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

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

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

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

getAsync(callback)

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

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

パラメーター

callback

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

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

戻り値

void

注釈

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

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

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

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

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-sensitivity-level.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)

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

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 パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーターasyncResultで呼び出されます。

戻り値

void

注釈

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

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

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

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

エラー:

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

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-sensitivity-level.yaml

Office.context.mailbox.item.sensitivity.setAsync(
  Office.MailboxEnums.AppointmentSensitivityType.Private,
  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)

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

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

パラメーター

sensitivity

Office.MailboxEnums.AppointmentSensitivityType | string

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

callback

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

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

戻り値

void

注釈

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

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

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

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

エラー:

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