PowerPoint.SensitivityLabelDetails class

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

表示 PowerPoint 中可用敏感度标签的属性。

扩展

属性

abacAttributeValues

获取基于属性的访问控制 (ABAC) 当前应用于此敏感度标签的属性值。 未应用 ABAC 属性或此标签未启用 ABAC 时,返回空数组。

children

获取敏感度标签的子标签。

color

获取敏感度标签的颜色。

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

id

获取敏感度标签的唯一 ID。

isAbacAttributesRequired

获取应用此标签是否需要 ABAC 属性选择。 如果 ,调用方在应用标签时必须提供属性值;否则 true,更新将返回 SensitivityLabelUpdateResult.MissingRequiredAttributes

isAbacEnabled

获取此标签是否是基于属性的访问控制 (启用 ABAC) 。 当主机的标记功能不包括 attributeBasedAccessControlEnabled时返回false

isEnabled

获取指示是否启用标签的值。

name

获取敏感度标签的名称。

order

获取敏感度标签的优先级,其中 0 为最低优先级。

protectionType

获取指示此标签提供的保护类型的值。

siteId

获取敏感度标签所属的租户的唯一 ID。

tooltip

获取敏感度标签的说明。

方法

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

toJSON()

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 PowerPoint.SensitivityLabelDetails 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 PowerPoint.Interfaces.SensitivityLabelDetailsData) ,其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

abacAttributeValues

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取基于属性的访问控制 (ABAC) 当前应用于此敏感度标签的属性值。 未应用 ABAC 属性或此标签未启用 ABAC 时,返回空数组。

readonly abacAttributeValues: PowerPoint.SensitivityLabelAbacAttributeValue[];

属性值

注解

API 集:PowerPointApi BETA (仅预览版)

children

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取敏感度标签的子标签。

readonly children: PowerPoint.SensitivityLabelDetailsCollection;

属性值

注解

API 集:PowerPointApi BETA (仅预览版)

color

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取敏感度标签的颜色。

readonly color: string;

属性值

string

注解

API 集:PowerPointApi BETA (仅预览版)

context

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

id

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取敏感度标签的唯一 ID。

readonly id: string;

属性值

string

注解

API 集:PowerPointApi BETA (仅预览版)

isAbacAttributesRequired

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取应用此标签是否需要 ABAC 属性选择。 如果 ,调用方在应用标签时必须提供属性值;否则 true,更新将返回 SensitivityLabelUpdateResult.MissingRequiredAttributes

readonly isAbacAttributesRequired: boolean;

属性值

boolean

注解

API 集:PowerPointApi BETA (仅预览版)

isAbacEnabled

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取此标签是否是基于属性的访问控制 (启用 ABAC) 。 当主机的标记功能不包括 attributeBasedAccessControlEnabled时返回false

readonly isAbacEnabled: boolean;

属性值

boolean

注解

API 集:PowerPointApi BETA (仅预览版)

isEnabled

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取指示是否启用标签的值。

readonly isEnabled: boolean;

属性值

boolean

注解

API 集:PowerPointApi BETA (仅预览版)

name

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取敏感度标签的名称。

readonly name: string;

属性值

string

注解

API 集:PowerPointApi BETA (仅预览版)

order

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取敏感度标签的优先级,其中 0 为最低优先级。

readonly order: number;

属性值

number

注解

API 集:PowerPointApi BETA (仅预览版)

protectionType

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取指示此标签提供的保护类型的值。

readonly protectionType: PowerPoint.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined";

属性值

PowerPoint.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"

注解

API 集:PowerPointApi BETA (仅预览版)

siteId

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取敏感度标签所属的租户的唯一 ID。

readonly siteId: string;

属性值

string

注解

API 集:PowerPointApi BETA (仅预览版)

tooltip

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取敏感度标签的说明。

readonly tooltip: string;

属性值

string

注解

API 集:PowerPointApi BETA (仅预览版)

方法详细信息

load(options)

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(options?: PowerPoint.Interfaces.SensitivityLabelDetailsLoadOptions): PowerPoint.SensitivityLabelDetails;

参数

options
PowerPoint.Interfaces.SensitivityLabelDetailsLoadOptions

为要加载的对象属性提供选项。

返回

load(propertyNames)

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNames?: string | string[]): PowerPoint.SensitivityLabelDetails;

参数

propertyNames

string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

load(propertyNamesAndPaths)

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.SensitivityLabelDetails;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串,以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

toJSON()

注意

此 API 以预览状态提供给开发者,可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 PowerPoint.SensitivityLabelDetails 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 PowerPoint.Interfaces.SensitivityLabelDetailsData) ,其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): PowerPoint.Interfaces.SensitivityLabelDetailsData;

返回