Word.SensitivityLabelAbacAttribute class
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 for sensitivity labels.
- Extends
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| display |
The display name of the ABAC attribute. |
| display |
The display order of the ABAC attribute. |
| is |
Indicates whether the ABAC attribute is active. |
| is |
Indicates whether the ABAC attribute can have multiple values. |
| values | The values available for the ABAC attribute. |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
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
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.
The display name of the ABAC attribute.
readonly displayName: string;Property Value
string
Remarks
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.
The display order of the ABAC attribute.
readonly displayOrder: number;Property Value
number
Remarks
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.
Indicates whether the ABAC attribute is active.
readonly isActive: boolean;Property Value
boolean
Remarks
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.
Indicates whether the ABAC attribute can have multiple values.
readonly isMultiValued: boolean;Property Value
boolean
Remarks
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.
The values available for the ABAC attribute.
readonly values: Word.SensitivityLabelAbacAttributeValue[];Property Value
Remarks
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?: Word.Interfaces.SensitivityLabelAbacAttributeLoadOptions): Word.SensitivityLabelAbacAttribute;Parameters
Provides options for which properties of the object to load.
Returns
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[]): Word.SensitivityLabelAbacAttribute;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
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;
}): Word.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
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 Word.SensitivityLabelAbacAttribute object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.SensitivityLabelAbacAttributeData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.SensitivityLabelAbacAttributeData;