Word.SensitivityLabelDetails class
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
Word で使用可能な秘密度ラベルのプロパティを表します。
- Extends
注釈
API セット: WordApi ベータ版 (プレビューのみ)
使用元
- Word.SensitivityLabel: getCurrentOrNullObject
- Word.SensitivityLabelDetailsCollection: getFirst, getFirstOrNullObject, getItem, items
例
// 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) => {
// Get the sensitivity label currently applied to the document.
const wordDocument: Word.Document = context.document;
const documentLabel: Word.SensitivityLabel = wordDocument.sensitivityLabel;
const currentLabel: Word.SensitivityLabelDetails = documentLabel.getCurrentOrNullObject();
// Load the properties of the label currently applied to the document.
currentLabel.load(
"color,id,isAbacAttributesRequired,isAbacEnabled,isEnabled,name,order,protectionType,siteId,tooltip"
);
await context.sync();
if (currentLabel.isNullObject) {
console.log("The document doesn't have a sensitivity label.");
return;
}
// Load ABAC values when supported.
let abacAttributeValues: Word.SensitivityLabelAbacAttributeValue[] = [];
const isAbacEnabled = currentLabel.isAbacEnabled;
if (isAbacEnabled) {
currentLabel.load("abacAttributeValues");
await context.sync();
abacAttributeValues = currentLabel.abacAttributeValues;
}
// Display the loaded properties of the current label.
const attributeValues = abacAttributeValues.length
? abacAttributeValues
.map(
(attributeValue: Word.SensitivityLabelAbacAttributeValue) =>
`${attributeValue.displayName} (ID: ${attributeValue.id}, order: ${attributeValue.displayOrder}, active: ${attributeValue.isActive ? "Yes" : "No"})`
)
.join(", ")
: "None";
let protectionDescription: string;
switch (currentLabel.protectionType) {
case Word.SensitivityLabelProtectionType.adminDefined:
protectionDescription = "Defined by an administrator";
break;
case Word.SensitivityLabelProtectionType.userDefined:
protectionDescription = "Defined by the user";
break;
case Word.SensitivityLabelProtectionType.noProtection:
protectionDescription = "No protection";
break;
default:
protectionDescription = `Unknown (${currentLabel.protectionType})`;
break;
}
console.log(
`Current document sensitivity label:\n\n${currentLabel.name}\n` +
` ID: ${currentLabel.id}\n` +
` Site ID: ${currentLabel.siteId}\n` +
` Tooltip: ${currentLabel.tooltip}\n` +
` Color: ${currentLabel.color}\n` +
` Enabled: ${currentLabel.isEnabled ? "Yes" : "No"}\n` +
` Display order: ${currentLabel.order}\n` +
` ABAC enabled: ${currentLabel.isAbacEnabled ? "Yes" : "No"}\n` +
` ABAC attributes required: ${currentLabel.isAbacAttributesRequired ? "Yes" : "No"}\n` +
` ABAC attribute values: ${attributeValues}\n` +
` Protection type: ${protectionDescription}`
);
});
プロパティ
| abac |
秘密度ラベルに関連付けられている属性ベースのアクセス制御 (ABAC) 属性値。 |
| children | 秘密度ラベルのサブラベル。 ラベルにサブラベルがない場合は null を返します。 |
| color | 秘密度ラベルの色。 |
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
| id | 秘密度ラベルの一意識別子 (GUID)。 |
| is |
秘密度ラベルを適用するときに、属性ベースのアクセス制御 (ABAC) 属性が必要かどうかを示します。 |
| is |
秘密度ラベルで属性ベースのアクセス制御 (ABAC) 属性がサポートされているかどうかを示します。 |
| is |
ラベルが有効かどうかを示す値を取得します。 |
| name | 秘密度ラベルの名前。 |
| order | 秘密度ラベルの順序。 |
| protection |
このラベルによって提供される保護の種類を示す値を取得します。 |
| site |
秘密度ラベルが属するテナントの一意識別子 (GUID)。 |
| tooltip | 秘密度ラベルの説明。 |
メソッド
| load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
| toJSON() | API オブジェクトが |
| track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを |
| untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 |
プロパティの詳細
abacAttributeValues
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルに関連付けられている属性ベースのアクセス制御 (ABAC) 属性値。
readonly abacAttributeValues: Word.SensitivityLabelAbacAttributeValue[];プロパティ値
注釈
children
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルのサブラベル。 ラベルにサブラベルがない場合は null を返します。
readonly children: Word.SensitivityLabelDetailsCollection;プロパティ値
注釈
color
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルの色。
readonly color: string;プロパティ値
string
注釈
context
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
id
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルの一意識別子 (GUID)。
readonly id: string;プロパティ値
string
注釈
isAbacAttributesRequired
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルを適用するときに、属性ベースのアクセス制御 (ABAC) 属性が必要かどうかを示します。
readonly isAbacAttributesRequired: boolean;プロパティ値
boolean
注釈
isAbacEnabled
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルで属性ベースのアクセス制御 (ABAC) 属性がサポートされているかどうかを示します。
readonly isAbacEnabled: boolean;プロパティ値
boolean
注釈
isEnabled
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ラベルが有効かどうかを示す値を取得します。
readonly isEnabled: boolean;プロパティ値
boolean
注釈
name
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルの名前。
readonly name: string;プロパティ値
string
注釈
order
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルの順序。
readonly order: number;プロパティ値
number
注釈
protectionType
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
このラベルによって提供される保護の種類を示す値を取得します。
readonly protectionType: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";プロパティ値
Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"
注釈
siteId
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルが属するテナントの一意識別子 (GUID)。
readonly siteId: string;プロパティ値
string
注釈
tooltip
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
秘密度ラベルの説明。
readonly tooltip: string;プロパティ値
string
注釈
メソッドの詳細
load(options)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(options?: Word.Interfaces.SensitivityLabelDetailsLoadOptions): Word.SensitivityLabelDetails;パラメーター
読み込むオブジェクトのプロパティのオプションを指定します。
戻り値
load(propertyNames)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.SensitivityLabelDetails;パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.SensitivityLabelDetails;パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。
戻り値
toJSON()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.SensitivityLabelDetails オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.SensitivityLabelDetailsData と型指定) を返します。
toJSON(): Word.Interfaces.SensitivityLabelDetailsData;戻り値
track()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.SensitivityLabelDetails;戻り値
untrack()
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。
untrack(): Word.SensitivityLabelDetails;