Word.SensitivityLabelsCatalog class
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Word の秘密度ラベルのカタログの状態をチェックし、カタログが有効になっている場合は使用可能なすべての秘密度ラベルを取得するメソッドを提供します。
- Extends
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| get |
Word の秘密度ラベル カタログのラベル付け機能を取得します。 |
| get |
Word の秘密度ラベル カタログのラベル付け機能の状態を取得します。 |
メソッド
| get |
秘密度ラベルで使用できる属性ベースのアクセス制御 (ABAC) 属性を取得します。 |
| get |
Word で有効になっているすべての秘密度ラベルを取得します。 |
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| new |
|
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
context
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
getLabelingCapabilities
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Word の秘密度ラベル カタログのラベル付け機能を取得します。
readonly getLabelingCapabilities: Word.LabelingCapability[];
プロパティ値
注釈
getLabelingCapability
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Word の秘密度ラベル カタログのラベル付け機能の状態を取得します。
readonly getLabelingCapability: Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled" | "AttributeBasedAccessControlEnabled";
プロパティ値
Word.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled" | "AttributeBasedAccessControlEnabled"
注釈
API セット: WordApi ベータ版 (プレビューのみ)
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/manage-sensitivity-labels.yaml
// Check whether sensitivity labeling is available for the current user.
await Word.run(async (context) => {
const labelCatalog: Word.SensitivityLabelsCatalog = context.sensitivityLabelsCatalog;
if (!labelCatalog) {
console.warn("The sensitivity label catalog isn't available.");
return;
}
labelCatalog.load("getLabelingCapability");
await context.sync();
switch (labelCatalog.getLabelingCapability) {
case Word.LabelingCapability.labelingEnabled:
console.log("Sensitivity labeling is enabled.");
break;
case Word.LabelingCapability.labelingDisabled:
console.log("Sensitivity labeling is disabled.");
break;
case Word.LabelingCapability.labelingPolicyNotFound:
console.log("No sensitivity labeling policy was found.");
break;
case Word.LabelingCapability.noLicense:
console.log("The current user doesn't have a valid sensitivity labeling license.");
break;
default:
console.log(`Unknown labeling capability: ${labelCatalog.getLabelingCapability}`);
break;
}
});
メソッドの詳細
getAttributes()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルで使用できる属性ベースのアクセス制御 (ABAC) 属性を取得します。
getAttributes(): OfficeExtension.ClientResult<Word.SensitivityLabelAbacAttribute[]>;
戻り値
注釈
API セット: WordApi ベータ版 (プレビューのみ)
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/manage-sensitivity-labels.yaml
// Get available ABAC attributes and describe the kind of value each attribute accepts.
const container = document.getElementById("abac-attributes");
while (container.firstChild) {
container.removeChild(container.firstChild);
}
await Word.run(async (context) => {
const labelCatalog: Word.SensitivityLabelsCatalog = context.sensitivityLabelsCatalog;
if (!labelCatalog) {
console.warn("The sensitivity label catalog isn't available.");
return;
}
labelCatalog.load("getLabelingCapabilities");
await context.sync();
const capabilities: Word.LabelingCapability[] = labelCatalog.getLabelingCapabilities;
if (capabilities.indexOf(Word.LabelingCapability.attributeBasedAccessControlEnabled) === -1) {
console.warn("ABAC attributes aren't enabled or available for the current user.");
return;
}
const catalogAttributes: OfficeExtension.ClientResult<Word.SensitivityLabelAbacAttribute[]> =
labelCatalog.getAttributes();
await context.sync();
if (catalogAttributes.value.length === 0) {
console.log("No ABAC attributes are available in the sensitivity label catalog.");
return;
}
console.log("Available ABAC attributes:");
catalogAttributes.value.forEach((attribute: Word.SensitivityLabelAbacAttribute) => {
let dataTypeDescription: string;
switch (attribute.dataType) {
case Word.SensitivityLabelAbacAttributeDataType.booleanValue:
dataTypeDescription = "Boolean";
break;
case Word.SensitivityLabelAbacAttributeDataType.dateValue:
dataTypeDescription = "Date";
break;
case Word.SensitivityLabelAbacAttributeDataType.numberValue:
dataTypeDescription = "Number";
break;
case Word.SensitivityLabelAbacAttributeDataType.stringValue:
dataTypeDescription = "String";
break;
case Word.SensitivityLabelAbacAttributeDataType.unknown:
dataTypeDescription = "Unknown";
break;
default:
dataTypeDescription = `Unrecognized (${attribute.dataType})`;
break;
}
console.log(`ABAC attribute: ${attribute.displayName}`, {
dataType: attribute.dataType,
dataTypeDescription,
displayOrder: attribute.displayOrder,
isActive: attribute.isActive,
isMultiValued: attribute.isMultiValued,
values: attribute.values.map((attributeValue: Word.SensitivityLabelAbacAttributeValue) => ({
displayName: attributeValue.displayName,
displayOrder: attributeValue.displayOrder,
id: attributeValue.id,
isActive: attributeValue.isActive
}))
});
});
addAttributeOptions(catalogAttributes.value);
});
getLabels()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Word で有効になっているすべての秘密度ラベルを取得します。
getLabels(): Word.SensitivityLabelDetailsCollection;
戻り値
注釈
API セット: WordApi ベータ版 (プレビューのみ)
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/manage-sensitivity-labels.yaml
await Word.run(async (context) => {
const labelSelect = document.getElementById("label-id") as HTMLSelectElement;
labelSelect.options.length = 0;
const placeholder = document.createElement("option");
placeholder.textContent = "Select a label";
placeholder.value = "";
labelSelect.add(placeholder);
// Get the sensitivity labels that the organization published for the current user.
const labelCatalog: Word.SensitivityLabelsCatalog = context.sensitivityLabelsCatalog;
if (!labelCatalog) {
console.warn("The sensitivity label catalog isn't available.");
return;
}
const availableLabels: Word.SensitivityLabelDetailsCollection = labelCatalog.getLabels();
// Load the properties for every label in the catalog.
availableLabels.load(
"items/color,items/id,items/isAbacAttributesRequired,items/isAbacEnabled,items/isEnabled," +
"items/name,items/order,items/protectionType,items/siteId,items/tooltip," +
"items/children/items/id,items/children/items/name,items/children/items/isEnabled"
);
await context.sync();
if (availableLabels.items.length === 0) {
console.log("No sensitivity labels are available for the current user.");
return;
}
// Display the loaded properties for each available label.
console.log("Available sensitivity labels:");
availableLabels.items.forEach((labelDetails: Word.SensitivityLabelDetails) => {
const childLabels = labelDetails.children && labelDetails.children.items.length
? labelDetails.children.items
.map((childLabel: Word.SensitivityLabelDetails) => `${childLabel.name} (${childLabel.id})`)
.join(", ")
: "None";
console.log(
`\n${labelDetails.name}\n` +
` ID: ${labelDetails.id}\n` +
` Site ID: ${labelDetails.siteId}\n` +
` Tooltip: ${labelDetails.tooltip}\n` +
` Color: ${labelDetails.color}\n` +
` Enabled: ${labelDetails.isEnabled ? "Yes" : "No"}\n` +
` Display order: ${labelDetails.order}\n` +
` ABAC enabled: ${labelDetails.isAbacEnabled ? "Yes" : "No"}\n` +
` ABAC attributes required: ${labelDetails.isAbacAttributesRequired ? "Yes" : "No"}\n` +
` Sublabels: ${childLabels}\n` +
` Protection type: ${labelDetails.protectionType}`
);
});
addLabelOptions(availableLabels);
});
load(options)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.SensitivityLabelsCatalogLoadOptions): Word.SensitivityLabelsCatalog;
パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
戻り値
load(propertyNames)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.SensitivityLabelsCatalog;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.SensitivityLabelsCatalog;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
戻り値
newObject(context)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Word.SensitivityLabelsCatalog オブジェクトの新しいインスタンスを作成します。
static newObject(context: OfficeExtension.ClientRequestContext): Word.SensitivityLabelsCatalog;
パラメーター
戻り値
toJSON()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.SensitivityLabelsCatalog オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.SensitivityLabelsCatalogData と型指定) を返します。
toJSON(): Word.Interfaces.SensitivityLabelsCatalogData;
戻り値
track()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.SensitivityLabelsCatalog;
戻り値
untrack()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.SensitivityLabelsCatalog;