PowerPoint.SensitivityLabelDetailsCollection class

Пакет:

powerpoint

Примечание

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

Представляет коллекцию объектов PowerPoint.SensitivityLabelDetails .

Extends

OfficeExtension.ClientObject

Комментарии

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

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

• PowerPoint.SensitivityLabelDetails: дети
• PowerPoint.SensitivityLabelsCatalog: getLabels

Свойства

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

Методы

getCount()	Получает количество объектов PowerPoint.SensitivityLabelDetails в этой коллекции.
getItem(id)	Получает указанный SensitivityLabelDetails объект в этой коллекции. Выдает ошибку, ItemNotFound если элемент с указанным идентификатором не найден.
getItemAt(index)	Получает SensitivityLabelDetails объект по указанному индексу в этой коллекции. Выдает ошибку, IndexOutOfRange если индекс выходит за пределы допустимого диапазона.
getItemOrNullObject(id)	Получает указанный SensitivityLabelDetails объект в этой коллекции. Если элемент с указанным идентификатором не найден, этот метод вернет объект со свойством true.isNullObject Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.SensitivityLabelDetailsCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

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

context

Примечание

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

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

context: RequestContext;

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

PowerPoint.RequestContext

items

Примечание

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

Получает загруженные дочерние элементы в этой коллекции.

readonly items: PowerPoint.SensitivityLabelDetails[];

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

PowerPoint.SensitivityLabelDetails[]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/preview-apis/manage-sensitivity-labels.yaml

await PowerPoint.run(async (context) => {
  const labelSelect = document.getElementById("label-id") as HTMLSelectElement;
  labelSelect.options.length = 0;
  const placeholder = document.createElement("option");
  placeholder.textContent = "Select a label";
  placeholder.value = "";
  labelSelect.add(placeholder);

  // Get the sensitivity labels that the organization published for the current user.
  const labelCatalog: PowerPoint.SensitivityLabelsCatalog = context.sensitivityLabelsCatalog;
  if (!labelCatalog) {
    console.warn("The sensitivity label catalog isn't available.");
    return;
  }

  const availableLabels: PowerPoint.SensitivityLabelDetailsCollection = labelCatalog.getLabels();
  // Load the properties and sublabels for every label in the catalog.
  availableLabels.load(
    "items/color,items/id,items/isAbacAttributesRequired,items/isAbacEnabled,items/isEnabled," +
    "items/name,items/order,items/protectionType,items/siteId,items/tooltip," +
    "items/children/items/id,items/children/items/name,items/children/items/isEnabled"
  );
  await context.sync();

  if (availableLabels.items.length === 0) {
    console.log("No sensitivity labels are available for the current user.");
    return;
  }

  // Display the loaded properties for each available label.
  console.log("Available sensitivity labels:");
  availableLabels.items.forEach((labelDetails: PowerPoint.SensitivityLabelDetails) => {
    const childLabels = labelDetails.children && labelDetails.children.items.length
      ? labelDetails.children.items
          .map((childLabel: PowerPoint.SensitivityLabelDetails) => `${childLabel.name} (${childLabel.id})`)
          .join(", ")
      : "None";

    console.log(
      `\n${labelDetails.name}\n` +
        `  ID: ${labelDetails.id}\n` +
        `  Site ID: ${labelDetails.siteId}\n` +
        `  Tooltip: ${labelDetails.tooltip}\n` +
        `  Color: ${labelDetails.color}\n` +
        `  Enabled: ${labelDetails.isEnabled ? "Yes" : "No"}\n` +
        `  Display order: ${labelDetails.order}\n` +
        `  ABAC enabled: ${labelDetails.isAbacEnabled ? "Yes" : "No"}\n` +
        `  ABAC attributes required: ${labelDetails.isAbacAttributesRequired ? "Yes" : "No"}\n` +
        `  Sublabels: ${childLabels}\n` +
        `  Protection type: ${labelDetails.protectionType}`
    );
  });

  addLabelOptions(availableLabels);
});

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

getCount()

Примечание

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

Получает количество объектов PowerPoint.SensitivityLabelDetails в этой коллекции.

getCount(): OfficeExtension.ClientResult<number>;

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

OfficeExtension.ClientResult<number>

Количество SensitivityLabelDetails объектов.

Комментарии

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

getItem(id)

Примечание

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

Получает указанный SensitivityLabelDetails объект в этой коллекции. Выдает ошибку, ItemNotFound если элемент с указанным идентификатором не найден.

getItem(id: string): PowerPoint.SensitivityLabelDetails;

Параметры

id

string

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

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

PowerPoint.SensitivityLabelDetails

Указанный SensitivityLabelDetails объект.

Комментарии

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

getItemAt(index)

Примечание

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

Получает SensitivityLabelDetails объект по указанному индексу в этой коллекции. Выдает ошибку, IndexOutOfRange если индекс выходит за пределы допустимого диапазона.

getItemAt(index: number): PowerPoint.SensitivityLabelDetails;

Параметры

index

number

Индекс извлекаемого элемента. Используется нулевой индекс.

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

PowerPoint.SensitivityLabelDetails

Объект SensitivityLabelDetails по указанному индексу.

Комментарии

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

getItemOrNullObject(id)

Примечание

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

Получает указанный SensitivityLabelDetails объект в этой коллекции. Если элемент с указанным идентификатором не найден, этот метод вернет объект со свойством true.isNullObject Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getItemOrNullObject(id: string): PowerPoint.SensitivityLabelDetails;

Параметры

id

string

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

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

PowerPoint.SensitivityLabelDetails

Указанный SensitivityLabelDetails объект.

Комментарии

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

load(options)

Примечание

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

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

load(options?: PowerPoint.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions): PowerPoint.SensitivityLabelDetailsCollection;

Параметры

options

PowerPoint.Interfaces.SensitivityLabelDetailsCollectionLoadOptions & PowerPoint.Interfaces.CollectionLoadOptions

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

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

PowerPoint.SensitivityLabelDetailsCollection

load(propertyNames)

Примечание

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

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.SensitivityLabelDetailsCollection

load(propertyNamesAndPaths)

Примечание

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

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): PowerPoint.SensitivityLabelDetailsCollection;

Параметры

propertyNamesAndPaths

OfficeExtension.LoadOption

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

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

PowerPoint.SensitivityLabelDetailsCollection

toJSON()

Примечание

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

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.SensitivityLabelDetailsCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

toJSON(): PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData;

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

PowerPoint.Interfaces.SensitivityLabelDetailsCollectionData