Edit

PowerPoint.SensitivityLabelDetails class

Package:
powerpoint

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Represents the properties of available sensitivity labels in PowerPoint.

Extends
OfficeExtension.ClientObject

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

Used by

Properties

abacAttributeValues

Gets the attribute-based access control (ABAC) attribute values currently applied to this sensitivity label. Returns an empty array when no ABAC attributes are applied or this label is not ABAC-enabled.
children

Gets the sublabels of the sensitivity label.
color

Gets the color of the sensitivity label.
context

The request context associated with the object. This connects the add-in's process to the Office host application's process.
id

Gets the unique ID of the sensitivity label.
isAbacAttributesRequired

Gets whether ABAC attribute selections are required to apply this label. If true, callers must supply attribute values when applying the label; otherwise the update returns SensitivityLabelUpdateResult.MissingRequiredAttributes.
isAbacEnabled

Gets whether this label is attribute-based access control (ABAC) enabled. Returns false when the host's labeling capabilities don't include attributeBasedAccessControlEnabled.
isEnabled

Gets a value indicating whether the label is enabled.
name

Gets the name of the sensitivity label.
order

Gets the priority of the sensitivity label, with 0 as lowest priority.
protectionType

Gets a value indicating the protection type provided by this label.
siteId

Gets the unique ID of the tenant which the sensitivity label is belonged.
tooltip

Gets the description of the sensitivity label.

Methods

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.SensitivityLabelDetails object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SensitivityLabelDetailsData) that contains shallow copies of any loaded child properties from the original object.

Property Details

abacAttributeValues

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the attribute-based access control (ABAC) attribute values currently applied to this sensitivity label. Returns an empty array when no ABAC attributes are applied or this label is not ABAC-enabled.

readonly abacAttributeValues: PowerPoint.SensitivityLabelAbacAttributeValue[];

Property Value

PowerPoint.SensitivityLabelAbacAttributeValue[]

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

children

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the sublabels of the sensitivity label.

readonly children: PowerPoint.SensitivityLabelDetailsCollection;

Property Value

PowerPoint.SensitivityLabelDetailsCollection

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

color

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the color of the sensitivity label.

readonly color: string;

Property Value

string

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

context

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

PowerPoint.RequestContext

id

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the unique ID of the sensitivity label.

readonly id: string;

Property Value

string

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

isAbacAttributesRequired

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets whether ABAC attribute selections are required to apply this label. If true, callers must supply attribute values when applying the label; otherwise the update returns SensitivityLabelUpdateResult.MissingRequiredAttributes.

readonly isAbacAttributesRequired: boolean;

Property Value

boolean

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

isAbacEnabled

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets whether this label is attribute-based access control (ABAC) enabled. Returns false when the host's labeling capabilities don't include attributeBasedAccessControlEnabled.

readonly isAbacEnabled: boolean;

Property Value

boolean

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

isEnabled

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a value indicating whether the label is enabled.

readonly isEnabled: boolean;

Property Value

boolean

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

name

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the name of the sensitivity label.

readonly name: string;

Property Value

string

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

order

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the priority of the sensitivity label, with 0 as lowest priority.

readonly order: number;

Property Value

number

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

protectionType

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets a value indicating the protection type provided by this label.

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

Property Value

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

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

siteId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the unique ID of the tenant which the sensitivity label is belonged.

readonly siteId: string;

Property Value

string

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

tooltip

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Gets the description of the sensitivity label.

readonly tooltip: string;

Property Value

string

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

Method Details

load(options)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

options
PowerPoint.Interfaces.SensitivityLabelDetailsLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.SensitivityLabelDetails

load(propertyNames)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

PowerPoint.SensitivityLabelDetails

load(propertyNamesAndPaths)

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNamesAndPaths

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

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

PowerPoint.SensitivityLabelDetails

toJSON()

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original PowerPoint.SensitivityLabelDetails object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SensitivityLabelDetailsData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.SensitivityLabelDetailsData;

Returns

PowerPoint.Interfaces.SensitivityLabelDetailsData