PowerPoint.SensitivityLabelsCatalog 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.

Provides methods to check the status of the catalog of sensitivity labels in PowerPoint and retrieve all available sensitivity labels if the catalog is enabled.

Extends: OfficeExtension.ClientObject

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
getLabelingCapability	Gets whether the catalog of sensitivity labels is enabled in PowerPoint.

Methods

getLabels()	Gets sensitivity labels that are available to the current user.
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.
newObject(context)	Create a new instance of the `PowerPoint.SensitivityLabelsCatalog` object.
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.SensitivityLabelsCatalog` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `PowerPoint.Interfaces.SensitivityLabelsCatalogData`) that contains shallow copies of any loaded child properties from the original object.

Property Details

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

getLabelingCapability

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 the catalog of sensitivity labels is enabled in PowerPoint.

readonly getLabelingCapability: PowerPoint.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled";

Property Value

PowerPoint.LabelingCapability | "NoLicense" | "LabelingDisabled" | "LabelingPolicyNotFound" | "LabelingEnabled"

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

Method Details

getLabels()

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 sensitivity labels that are available to the current user.

getLabels(): PowerPoint.SensitivityLabelDetailsCollection;

Returns

PowerPoint.SensitivityLabelDetailsCollection

The current object.

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

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.SensitivityLabelsCatalogLoadOptions): PowerPoint.SensitivityLabelsCatalog;

Parameters

options: PowerPoint.Interfaces.SensitivityLabelsCatalogLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.SensitivityLabelsCatalog

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.SensitivityLabelsCatalog;

Parameters

propertyNames: string | string[]

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

Returns

PowerPoint.SensitivityLabelsCatalog

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.SensitivityLabelsCatalog;

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.SensitivityLabelsCatalog

newObject(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.

Create a new instance of the PowerPoint.SensitivityLabelsCatalog object.

static newObject(context: OfficeExtension.ClientRequestContext): PowerPoint.SensitivityLabelsCatalog;

Parameters

context: OfficeExtension.ClientRequestContext

Returns

PowerPoint.SensitivityLabelsCatalog

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.SensitivityLabelsCatalog object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SensitivityLabelsCatalogData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): PowerPoint.Interfaces.SensitivityLabelsCatalogData;

Returns

PowerPoint.Interfaces.SensitivityLabelsCatalogData

Feedback

Was this page helpful?