Word.SensitivityLabelDetails class

パッケージ:
word

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

Word で使用可能な秘密度ラベルのプロパティを表します。

Extends
OfficeExtension.ClientObject

注釈

API セット: WordApi ベータ版 (プレビューのみ)

使用元

プロパティ

abacAttributeValues

秘密度ラベルに関連付けられている属性ベースのアクセス制御 (ABAC) 属性値。
children

秘密度ラベルのサブラベル。 ラベルにサブラベルがない場合は null を返します。
color

秘密度ラベルの色。
context

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
id

秘密度ラベルの一意識別子 (GUID)。
isAbacAttributesRequired

秘密度ラベルを適用するときに、属性ベースのアクセス制御 (ABAC) 属性が必要かどうかを示します。
isAbacEnabled

秘密度ラベルで属性ベースのアクセス制御 (ABAC) 属性がサポートされているかどうかを示します。
isEnabled

ラベルが有効かどうかを示す値を取得します。
name

秘密度ラベルの名前。
order

秘密度ラベルの順序。
protectionType

このラベルによって提供される保護の種類を示す値を取得します。
siteId

秘密度ラベルが属するテナントの一意識別子 (GUID)。
tooltip

秘密度ラベルの説明。

メソッド

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。
toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.SensitivityLabelDetails オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.SensitivityLabelDetailsData と型指定) を返します。
track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。

プロパティの詳細

abacAttributeValues

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルに関連付けられている属性ベースのアクセス制御 (ABAC) 属性値。

readonly abacAttributeValues: Word.SensitivityLabelAbacAttributeValue[];

プロパティ値

Word.SensitivityLabelAbacAttributeValue[]

注釈

API セット: WordApi ベータ版 (プレビューのみ)

children

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルのサブラベル。 ラベルにサブラベルがない場合は null を返します。

readonly children: Word.SensitivityLabelDetailsCollection;

プロパティ値

Word.SensitivityLabelDetailsCollection

注釈

API セット: WordApi ベータ版 (プレビューのみ)

color

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの色。

readonly color: string;

プロパティ値

string

注釈

API セット: WordApi ベータ版 (プレビューのみ)

context

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Word.RequestContext

id

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの一意識別子 (GUID)。

readonly id: string;

プロパティ値

string

注釈

API セット: WordApi ベータ版 (プレビューのみ)

isAbacAttributesRequired

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルを適用するときに、属性ベースのアクセス制御 (ABAC) 属性が必要かどうかを示します。

readonly isAbacAttributesRequired: boolean;

プロパティ値

boolean

注釈

API セット: WordApi ベータ版 (プレビューのみ)

isAbacEnabled

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルで属性ベースのアクセス制御 (ABAC) 属性がサポートされているかどうかを示します。

readonly isAbacEnabled: boolean;

プロパティ値

boolean

注釈

API セット: WordApi ベータ版 (プレビューのみ)

isEnabled

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ラベルが有効かどうかを示す値を取得します。

readonly isEnabled: boolean;

プロパティ値

boolean

注釈

API セット: WordApi ベータ版 (プレビューのみ)

name

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの名前。

readonly name: string;

プロパティ値

string

注釈

API セット: WordApi ベータ版 (プレビューのみ)

order

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの順序。

readonly order: number;

プロパティ値

number

注釈

API セット: WordApi ベータ版 (プレビューのみ)

protectionType

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このラベルによって提供される保護の種類を示す値を取得します。

readonly protectionType: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";

プロパティ値

Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"

注釈

API セット: WordApi ベータ版 (プレビューのみ)

siteId

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルが属するテナントの一意識別子 (GUID)。

readonly siteId: string;

プロパティ値

string

注釈

API セット: WordApi ベータ版 (プレビューのみ)

tooltip

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

秘密度ラベルの説明。

readonly tooltip: string;

プロパティ値

string

注釈

API セット: WordApi ベータ版 (プレビューのみ)

メソッドの詳細

load(options)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.SensitivityLabelDetailsLoadOptions): Word.SensitivityLabelDetails;

パラメーター

options
Word.Interfaces.SensitivityLabelDetailsLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

Word.SensitivityLabelDetails

load(propertyNames)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Word.SensitivityLabelDetails;

パラメーター

propertyNames

string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

Word.SensitivityLabelDetails

load(propertyNamesAndPaths)

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.SensitivityLabelDetails;

パラメーター

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

Word.SensitivityLabelDetails

toJSON()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.SensitivityLabelDetails オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.SensitivityLabelDetailsData と型指定) を返します。

toJSON(): Word.Interfaces.SensitivityLabelDetailsData;

返品

Word.Interfaces.SensitivityLabelDetailsData

track()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。 このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.SensitivityLabelDetails;

返品

Word.SensitivityLabelDetails

untrack()

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ リリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.SensitivityLabelDetails;

返品

Word.SensitivityLabelDetails