Office.SensitivityLabelsCatalog interface
Outlook の秘密度ラベルのカタログの状態をチェックし、カタログが有効になっている場合は使用可能なすべての秘密度ラベルを取得するメソッドを提供します。
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要: アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
アドインで秘密度ラベルを管理する方法の詳細については、「 Office アドインで秘密度ラベルを管理する」を参照してください。
使用元
メソッド
| get |
Outlook で有効になっているすべての秘密度ラベルを取得します。 |
| get |
Outlook で有効になっているすべての秘密度ラベルを取得します。 |
| get |
秘密度ラベルのカタログが Outlook で有効になっているかどうかを確認します。 |
| get |
秘密度ラベルのカタログが Outlook で有効になっているかどうかを確認します。 |
メソッドの詳細
getAsync(options, callback)
Outlook で有効になっているすべての秘密度ラベルを取得します。
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスしたいオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<Office.SensitivityLabelDetails[]>) => void
メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。 使用可能な秘密度ラベルとそのプロパティは、 asyncResult.value プロパティで返されます。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要: アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
推奨: 秘密度ラベルのカタログが Outlook で有効になっているかどうかを確認するには、getAsync を使用する前に getIsEnabledAsync を呼び出します。
アドインで秘密度ラベルを管理する方法の詳細については、「 Office アドインで秘密度ラベルを管理する」を参照してください。
getAsync(callback)
Outlook で有効になっているすべての秘密度ラベルを取得します。
getAsync(callback: (asyncResult: Office.AsyncResult<SensitivityLabelDetails[]>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<Office.SensitivityLabelDetails[]>) => void
メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。 使用可能な秘密度ラベルとそのプロパティは、 asyncResult.value プロパティで返されます。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要: アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
推奨: 秘密度ラベルのカタログが Outlook で有効になっているかどうかを確認するには、getAsync を使用する前に getIsEnabledAsync を呼び出します。
アドインで秘密度ラベルを管理する方法の詳細については、「 Office アドインで秘密度ラベルを管理する」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-labels-catalog.yaml
// This snippet gets all available sensitivity labels from the catalog.
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;
console.log("Sensitivity Labels Catalog:");
console.log(JSON.stringify(catalog));
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});
getIsEnabledAsync(options, callback)
秘密度ラベルのカタログが Outlook で有効になっているかどうかを確認します。
getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;パラメーター
- options
- Office.AsyncContextOptions
次のプロパティの 1 つ以上を含むオブジェクト リテラル:- asyncContext: 開発者は、コールバック関数でアクセスしたいオブジェクトを指定できます。
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。 秘密度ラベルのカタログの状態は、 asyncResult.value プロパティで返されます。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要: 秘密度ラベルのカタログは、organizationの管理者によって構成されます。 詳細については、「秘密度ラベルの使用を開始する」を参照してください。
重要: アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
アドインで秘密度ラベルを管理する方法の詳細については、「 Office アドインで秘密度ラベルを管理する」を参照してください。
getIsEnabledAsync(callback)
秘密度ラベルのカタログが Outlook で有効になっているかどうかを確認します。
getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;パラメーター
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => void
メソッドが完了すると、callback パラメーターで渡された関数が、Office.AsyncResult オブジェクトである 1 つのパラメーター asyncResult を指定して呼び出されます。 秘密度ラベルのカタログの状態は、 asyncResult.value プロパティで返されます。
返品
void
注釈
最小アクセス許可レベル: 項目の読み取り/書き込み
適用可能な Outlook モード: Compose
重要: 秘密度ラベルのカタログは、organizationの管理者によって構成されます。 詳細については、「秘密度ラベルの使用を開始する」を参照してください。
重要: アドインで秘密度ラベル機能を使用するには、Microsoft 365 E5 サブスクリプションが必要です。
アドインで秘密度ラベルを管理する方法の詳細については、「 Office アドインで秘密度ラベルを管理する」を参照してください。
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/60-sensitivity-label/sensitivity-labels-catalog.yaml
// This snippet determines if the sensitivity labels catalog is enabled on the current mailbox.
Office.context.sensitivityLabelsCatalog.getIsEnabledAsync((asyncResult) => {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log(asyncResult.value);
} else {
console.log("Action failed with error: " + asyncResult.error.message);
}
});