Word.Interfaces.SensitivityLabelDetailsData interface
An interface describing the data returned by calling sensitivityLabelDetails.toJSON().
Properties
| children | The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels. |
| color | The color of the sensitivity label. |
| id | The unique identifier (GUID) of the sensitivity label. |
| is |
Gets a value indicating whether the label is enabled. |
| name | The name of the sensitivity label. |
| order | The order of the sensitivity label. |
| protection |
Gets a value indicating the protection type provided by this label. |
| site |
The unique identifier (GUID) of the tenant which the sensitivity label is belonged. |
| tooltip | The description of the sensitivity label. |
Property Details
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.
The sublabels of the sensitivity label. Returns null if a label doesn't have any sublabels.
children?: Word.Interfaces.SensitivityLabelDetailsData[];Property Value
Remarks
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.
The color of the sensitivity label.
color?: string;Property Value
string
Remarks
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.
The unique identifier (GUID) of the sensitivity label.
id?: string;Property Value
string
Remarks
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
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.
The name of the sensitivity label.
name?: string;Property Value
string
Remarks
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.
The order of the sensitivity label.
order?: number;Property Value
number
Remarks
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?: Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";Property Value
Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"
Remarks
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.
The unique identifier (GUID) of the tenant which the sensitivity label is belonged.
siteId?: string;Property Value
string
Remarks
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.
The description of the sensitivity label.
tooltip?: string;Property Value
string