Word.SensitivityLabelDetails class

Пакет:
word

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Представляет свойства доступных меток конфиденциальности в Word.

Extends
OfficeExtension.ClientObject

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

Используется

Свойства

abacAttributeValues

Значения атрибутов управления доступом на основе атрибутов (ABAC), связанные с меткой конфиденциальности.
children

Вложенные метки метки конфиденциальности. Возвращает значение NULL, если подпись не содержит вложенных подписей.
color

Цвет метки конфиденциальности.
context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
id

Уникальный идентификатор (GUID) метки конфиденциальности.
isAbacAttributesRequired

Указывает, требуются ли атрибуты управления доступом на основе атрибутов (ABAC) при применении метки конфиденциальности.
isAbacEnabled

Указывает, поддерживает ли метка конфиденциальности атрибуты управления доступом на основе атрибутов (ABAC).
isEnabled

Получает значение, указывающее, включена ли метка.
name

Имя метки конфиденциальности.
order

Порядок метки конфиденциальности.
protectionType

Получает значение, указывающее тип защиты, предоставляемый этой меткой.
siteId

Уникальный идентификатор (GUID) клиента, к которому принадлежит метка конфиденциальности.
tooltip

Описание метки конфиденциальности.

Методы

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.SensitivityLabelDetails объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.SensitivityLabelDetailsData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

Сведения о свойстве

abacAttributeValues

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Значения атрибутов управления доступом на основе атрибутов (ABAC), связанные с меткой конфиденциальности.

readonly abacAttributeValues: Word.SensitivityLabelAbacAttributeValue[];

Значение свойства

Word.SensitivityLabelAbacAttributeValue[]

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

children

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Вложенные метки метки конфиденциальности. Возвращает значение NULL, если подпись не содержит вложенных подписей.

readonly children: Word.SensitivityLabelDetailsCollection;

Значение свойства

Word.SensitivityLabelDetailsCollection

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

color

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Цвет метки конфиденциальности.

readonly color: string;

Значение свойства

string

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

context

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

id

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Уникальный идентификатор (GUID) метки конфиденциальности.

readonly id: string;

Значение свойства

string

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

isAbacAttributesRequired

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает, требуются ли атрибуты управления доступом на основе атрибутов (ABAC) при применении метки конфиденциальности.

readonly isAbacAttributesRequired: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

isAbacEnabled

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Указывает, поддерживает ли метка конфиденциальности атрибуты управления доступом на основе атрибутов (ABAC).

readonly isAbacEnabled: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

isEnabled

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Получает значение, указывающее, включена ли метка.

readonly isEnabled: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

name

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Имя метки конфиденциальности.

readonly name: string;

Значение свойства

string

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

order

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Порядок метки конфиденциальности.

readonly order: number;

Значение свойства

number

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

protectionType

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Получает значение, указывающее тип защиты, предоставляемый этой меткой.

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

Значение свойства

Word.SensitivityLabelProtectionType | "NoProtection" | "AdminDefined" | "UserDefined"

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

siteId

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Уникальный идентификатор (GUID) клиента, к которому принадлежит метка конфиденциальности.

readonly siteId: string;

Значение свойства

string

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

tooltip

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Описание метки конфиденциальности.

readonly tooltip: string;

Значение свойства

string

Комментарии

Набор API: WordApi BETA (ТОЛЬКО ПРЕДВАРИТЕЛЬНАЯ ВЕРСИЯ)

Сведения о методе

load(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

options
Word.Interfaces.SensitivityLabelDetailsLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Word.SensitivityLabelDetails

load(propertyNames)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Word.SensitivityLabelDetails

load(propertyNamesAndPaths)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Word.SensitivityLabelDetails

toJSON()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.SensitivityLabelDetails объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.SensitivityLabelDetailsData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Word.Interfaces.SensitivityLabelDetailsData;

Возвращаемое значение

Word.Interfaces.SensitivityLabelDetailsData

track()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.SensitivityLabelDetails;

Возвращаемое значение

Word.SensitivityLabelDetails

untrack()

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.SensitivityLabelDetails;

Возвращаемое значение

Word.SensitivityLabelDetails