Word.ConflictCollection class

Пакет:: word

Представляет конфликты совместного редактирования в документе Word.

Extends: OfficeExtension.ClientObject

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthoring-conflicts.yaml

// Gets all coauthoring conflicts in the document.
await Word.run(async (context) => {
  const conflicts: Word.ConflictCollection = context.document.coauthoring.conflicts;
  conflicts.load("items/type");
  await context.sync();

  if (conflicts.items.length === 0) {
    console.log("No conflicts found in the document.");
    return;
  }

  console.log(`Found ${conflicts.items.length} conflict(s):`);
  for (let i = 0; i < conflicts.items.length; i++) {
    console.log(`  Conflict ${i + 1}: type = ${conflicts.items[i].type}`);
  }
});

Свойства

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

Методы

acceptAll()	Принимает все изменения пользователя, устраняет конфликты и объединяет изменения с серверной копией документа.
getItem(index)	Получает `Conflict` объект по его индексу в коллекции.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
rejectAll()	Отклоняет все изменения, внесенные пользователем, и сохраняет копию документа на сервере.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.ConflictCollection` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.ConflictCollectionData`), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.

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

context

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

context: RequestContext;

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

Word.RequestContext

items

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

readonly items: Word.Conflict[];

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

Word.Conflict[]

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

acceptAll()

Принимает все изменения пользователя, устраняет конфликты и объединяет изменения с серверной копией документа.

acceptAll(): void;

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthoring-conflicts.yaml

// Accepts all user changes, removes all conflicts, and merges into the server copy.
await Word.run(async (context) => {
  context.document.coauthoring.conflicts.acceptAll();
  await context.sync();

  console.log("All conflicts accepted (all your changes kept).");
});

getItem(index)

Примечание

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

Получает Conflict объект по его индексу в коллекции.

getItem(index: number): Word.Conflict;

Параметры

index: number

Расположение Conflict объекта.

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

Word.Conflict

load(options)

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

load(options?: Word.Interfaces.ConflictCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ConflictCollection;

Параметры

options: Word.Interfaces.ConflictCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

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

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

Word.ConflictCollection

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Word.ConflictCollection

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ConflictCollection;

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

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

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

Word.ConflictCollection

rejectAll()

Отклоняет все изменения, внесенные пользователем, и сохраняет копию документа на сервере.

rejectAll(): void;

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

void

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthoring-conflicts.yaml

// Rejects all user changes and retains the server copy for all conflicts.
await Word.run(async (context) => {
  context.document.coauthoring.conflicts.rejectAll();
  await context.sync();

  console.log("All conflicts rejected (server copy kept for all).");
});

toJSON()

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

toJSON(): Word.Interfaces.ConflictCollectionData;

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

Word.Interfaces.ConflictCollectionData

track()

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

track(): Word.ConflictCollection;

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

Word.ConflictCollection

untrack()

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

untrack(): Word.ConflictCollection;

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

Word.ConflictCollection

Обратная связь

Были ли сведения на этой странице полезными?

Комментарии

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

Примеры

Свойства

Методы

context

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

items

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

acceptAll()

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

Комментарии

Примеры

getItem(index)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

rejectAll()

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

Комментарии

Примеры

toJSON()

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

track()

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

untrack()

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