Edit

PowerPoint.Interfaces.SensitivityLabelDetailsLoadOptions interface

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.

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

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.

color

Gets the color of the sensitivity label.

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.

Property Details

$all

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.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

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.

abacAttributeValues?: boolean;

Property Value

boolean

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.

color?: boolean;

Property Value

boolean

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)

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.

id?: boolean;

Property Value

boolean

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.

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.

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.

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.

name?: boolean;

Property Value

boolean

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.

order?: boolean;

Property Value

boolean

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.

protectionType?: boolean;

Property Value

boolean

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.

siteId?: boolean;

Property Value

boolean

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.

tooltip?: boolean;

Property Value

boolean

Remarks

API set: PowerPointApi BETA (PREVIEW ONLY)