PowerPoint.SensitivityLabelAbacAttribute 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 an attribute-based access control (ABAC) attribute available for selection on an ABAC-enabled sensitivity label.

Extends

OfficeExtension.ClientObject

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

Used by

• PowerPoint.SensitivityLabelsCatalog: getAttributes

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
displayName	Gets the display name of the ABAC attribute. Add-ins are responsible for presenting localized user-facing UI.
displayOrder	Gets the recommended ordering of this ABAC attribute when displayed to a user.
isActive	Gets whether this ABAC attribute is active. true if the attribute is active; otherwise, false.
isMultiValued	Gets whether more than one value can be selected for this ABAC attribute. true if multi-select; otherwise, false.
values	Gets the values that are selectable for this ABAC attribute.

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.SensitivityLabelAbacAttribute object is an API object, the toJSON method returns a plain JavaScript object (typed as PowerPoint.Interfaces.SensitivityLabelAbacAttributeData) 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

displayName

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 display name of the ABAC attribute. Add-ins are responsible for presenting localized user-facing UI.

readonly displayName: string;

Property Value

string

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

displayOrder

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 recommended ordering of this ABAC attribute when displayed to a user.

readonly displayOrder: number;

Property Value

number

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

isActive

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 ABAC attribute is active. true if the attribute is active; otherwise, false.

readonly isActive: boolean;

Property Value

boolean

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

isMultiValued

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 more than one value can be selected for this ABAC attribute. true if multi-select; otherwise, false.

readonly isMultiValued: boolean;

Property Value

boolean

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

values

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 values that are selectable for this ABAC attribute.

readonly values: PowerPoint.SensitivityLabelAbacAttributeValue[];

Property Value

PowerPoint.SensitivityLabelAbacAttributeValue[]

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.SensitivityLabelAbacAttributeLoadOptions): PowerPoint.SensitivityLabelAbacAttribute;

Parameters

options

PowerPoint.Interfaces.SensitivityLabelAbacAttributeLoadOptions

Provides options for which properties of the object to load.

Returns

PowerPoint.SensitivityLabelAbacAttribute

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

Parameters

propertyNames

string | string[]

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

Returns

PowerPoint.SensitivityLabelAbacAttribute

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

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

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

toJSON(): PowerPoint.Interfaces.SensitivityLabelAbacAttributeData;

Returns

PowerPoint.Interfaces.SensitivityLabelAbacAttributeData