PowerPoint.SensitivityLabelDetails class

注意

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

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

Extends

プロパティ

abacAttributeValues

この秘密度ラベルに現在適用されている属性ベースのアクセス制御 (ABAC) 属性値を取得します。 ABAC 属性が適用されていない場合、またはこのラベルが ABAC 対応でない場合は、空の配列を返します。

children

秘密度ラベルのサブラベルを取得します。

color

秘密度ラベルの色を取得します。

context

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

id

秘密度ラベルの一意の ID を取得します。

isAbacAttributesRequired

このラベルを適用するために ABAC 属性の選択が必要かどうかを取得します。 true の場合、呼び出し元はラベルを適用するときに属性値を指定する必要があります。それ以外の場合は、更新プログラムから SensitivityLabelUpdateResult.MissingRequiredAttributes が返されます。

isAbacEnabled

このラベルが属性ベースのアクセス制御 (ABAC) が有効になっているかどうかを取得します。 ホストのラベル付け機能に attributeBasedAccessControlEnabled が含まれていない場合は false を返します。

isEnabled

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

name

秘密度ラベルの名前を取得します。

order

秘密度ラベルの優先度を取得し、最も低い優先度は 0 です。

protectionType

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

siteId

秘密度ラベルが属するテナントの一意の ID を取得します。

tooltip

秘密度ラベルの説明を取得します。

メソッド

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

toJSON()

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

プロパティの詳細

abacAttributeValues

注意

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

この秘密度ラベルに現在適用されている属性ベースのアクセス制御 (ABAC) 属性値を取得します。 ABAC 属性が適用されていない場合、またはこのラベルが ABAC 対応でない場合は、空の配列を返します。

readonly abacAttributeValues: PowerPoint.SensitivityLabelAbacAttributeValue[];

プロパティ値

注釈

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

children

注意

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

秘密度ラベルのサブラベルを取得します。

readonly children: PowerPoint.SensitivityLabelDetailsCollection;

プロパティ値

注釈

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

color

注意

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

秘密度ラベルの色を取得します。

readonly color: string;

プロパティ値

string

注釈

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

context

注意

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

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

context: RequestContext;

プロパティ値

id

注意

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

秘密度ラベルの一意の ID を取得します。

readonly id: string;

プロパティ値

string

注釈

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

isAbacAttributesRequired

注意

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

このラベルを適用するために ABAC 属性の選択が必要かどうかを取得します。 true の場合、呼び出し元はラベルを適用するときに属性値を指定する必要があります。それ以外の場合は、更新プログラムから SensitivityLabelUpdateResult.MissingRequiredAttributes が返されます。

readonly isAbacAttributesRequired: boolean;

プロパティ値

boolean

注釈

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

isAbacEnabled

注意

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

このラベルが属性ベースのアクセス制御 (ABAC) が有効になっているかどうかを取得します。 ホストのラベル付け機能に attributeBasedAccessControlEnabled が含まれていない場合は false を返します。

readonly isAbacEnabled: boolean;

プロパティ値

boolean

注釈

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

isEnabled

注意

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

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

readonly isEnabled: boolean;

プロパティ値

boolean

注釈

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

name

注意

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

秘密度ラベルの名前を取得します。

readonly name: string;

プロパティ値

string

注釈

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

order

注意

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

秘密度ラベルの優先度を取得し、最も低い優先度は 0 です。

readonly order: number;

プロパティ値

number

注釈

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

protectionType

注意

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

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

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

プロパティ値

PowerPoint.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"

注釈

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

siteId

注意

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

秘密度ラベルが属するテナントの一意の ID を取得します。

readonly siteId: string;

プロパティ値

string

注釈

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

tooltip

注意

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

秘密度ラベルの説明を取得します。

readonly tooltip: string;

プロパティ値

string

注釈

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

メソッドの詳細

load(options)

注意

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

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

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

パラメーター

options
PowerPoint.Interfaces.SensitivityLabelDetailsLoadOptions

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

返品

load(propertyNames)

注意

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

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

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

パラメーター

propertyNames

string | string[]

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

返品

load(propertyNamesAndPaths)

注意

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

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

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

パラメーター

propertyNamesAndPaths

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

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

返品

toJSON()

注意

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

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

toJSON(): PowerPoint.Interfaces.SensitivityLabelDetailsData;

返品