Office.SensitivityLabel interface
メッセージまたは予定の秘密度ラベルを取得または設定するメソッドを提供します。 秘密度ラベルの詳細については、「 秘密度ラベルの詳細」を参照してください。
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要: アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
アドインで秘密度ラベルを管理する方法の詳細については、「 作成モードでメッセージまたは予定の秘密度ラベルを管理する」を参照してください。
使用元
メソッド
| get |
作成中のメッセージまたは予定に適用される秘密度ラベルの一意識別子 (GUID) を取得します。 |
| get |
作成中のメッセージまたは予定に適用される秘密度ラベルの一意識別子 (GUID) を取得します。 |
| set |
作成中のメッセージまたは予定に、指定した秘密度ラベルを適用します。 |
| set |
作成中のメッセージまたは予定に、指定した秘密度ラベルを適用します。 |
メソッドの詳細
getAsync(options, callback)
作成中のメッセージまたは予定に適用される秘密度ラベルの一意識別子 (GUID) を取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスしたいオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。 秘密度ラベルの GUID は asyncResult.value プロパティで返されます。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要: アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
アドインで秘密度ラベルを管理する方法の詳細については、「 作成モードでメッセージまたは予定の秘密度ラベルを管理する」を参照してください。
getAsync(callback)
作成中のメッセージまたは予定に適用される秘密度ラベルの一意識別子 (GUID) を取得します。
getAsync(callback: (asyncResult: Office.AsyncResult<string>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。 秘密度ラベルの GUID は asyncResult.value プロパティで返されます。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要: アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
アドインで秘密度ラベルを管理する方法の詳細については、「 作成モードでメッセージまたは予定の秘密度ラベルを管理する」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml
// This snippet gets the current mail item's sensitivity label.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
Office.context.mailbox.item.sensitivityLabel.getAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(asyncResult.value);
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
setAsync(sensitivityLabel, options, callback)
作成中のメッセージまたは予定に、指定した秘密度ラベルを適用します。
setAsync(sensitivityLabel: string | SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- sensitivityLabel
-
string | Office.SensitivityLabelDetails
作成中のメッセージまたは予定に適用する秘密度ラベル。 パラメーター値には、秘密度ラベルの一意識別子 (GUID) または SensitivityLabelDetails オブジェクトを指定できます。
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスしたいオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要:
アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
setAsyncメソッドは、現在loadItemByIdAsyncメソッドを使用して読み込まれているメッセージではサポートされていません。 詳細については、「 複数のメッセージに対して Outlook アドインをアクティブ化する」を参照してください。
ヒント: 使用できる秘密度ラベルを決定するには、 Office.context.sensitivityLabelsCatalog.getAsync メソッドを呼び出します。
アドインで秘密度ラベルを管理する方法の詳細については、「 作成モードでメッセージまたは予定の秘密度ラベルを管理する」を参照してください。
setAsync(sensitivityLabel, callback)
作成中のメッセージまたは予定に、指定した秘密度ラベルを適用します。
setAsync(sensitivityLabel: string | SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;パラメーター
- sensitivityLabel
-
string | Office.SensitivityLabelDetails
作成中のメッセージまたは予定に適用する秘密度ラベル。 パラメーター値には、秘密度ラベルの一意識別子 (GUID) または SensitivityLabelDetails オブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<void>) => void
省略可能。 メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要:
アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
setAsyncメソッドは、現在loadItemByIdAsyncメソッドを使用して読み込まれているメッセージではサポートされていません。 詳細については、「 複数のメッセージに対して Outlook アドインをアクティブ化する」を参照してください。
ヒント: 使用できる秘密度ラベルを決定するには、 Office.context.sensitivityLabelsCatalog.getAsync メソッドを呼び出します。
アドインで秘密度ラベルを管理する方法の詳細については、「 作成モードでメッセージまたは予定の秘密度ラベルを管理する」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-label.yaml
// This snippet sets the sensitivity label on the current mail item.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value == true) {
Office.context.sensitivityLabelsCatalog.getAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const catalog = asyncResult.value;
if (catalog.length > 0) {
var id = catalog[0].id;
Office.context.mailbox.item.sensitivityLabel.setAsync(id, (asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(asyncResult.status);
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
}
else {
console.log("Catalog list is empty");
}
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});