Word.Coauthor class

Пакет:

word

Представляет совместную работу в документе Word.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: WordApiDesktop 1.4

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

• Word. CoauthorCollection: предметы
• Word.Совместная работа: я
• Word. CoauthoringLock: владелец

Примеры

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

// Gets all coauthors currently editing the document.
await Word.run(async (context) => {
  const authors: Word.CoauthorCollection = context.document.coauthoring.authors;
  authors.load("items/name,items/emailAddress,items/isMe");
  await context.sync();

  if (authors.items.length === 0) {
    console.log("No other coauthors are currently editing this document.");
    return;
  }

  console.log(`${authors.items.length} coauthor(s) editing this document:`);
  authors.items.forEach((author: Word.Coauthor) => {
    console.log(`  ${author.name} (${author.emailAddress})${author.isMe ? " — that's you" : ""}`);
  });
});

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
emailAddress	Получает адрес электронной почты соавтора.
id	Получает уникальный идентификатор Coauthor объекта.
isMe	Указывает, представляет ли этот автор текущего пользователя.
locks	Получает CoauthoringLockCollection объект, представляющий блокировки в документе, связанные с этим соавтором.
name	Получает отображаемое имя соавтора.

Методы

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

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

context

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

context: RequestContext;

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

Word.RequestContext

emailAddress

Получает адрес электронной почты соавтора.

readonly emailAddress: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

id

Получает уникальный идентификатор Coauthor объекта.

readonly id: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

isMe

Указывает, представляет ли этот автор текущего пользователя.

readonly isMe: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.4

locks

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

readonly locks: Word.CoauthoringLockCollection;

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

Word.CoauthoringLockCollection

Комментарии

Набор API: WordApiDesktop 1.4

Этот API работает только с устаревшими блокировками совместного редактирования. Это не применимо к современному совместному редактированию OneDrive или SharePoint, где управление блокировками обрабатывается службой автоматически. Вызовы в современном документе завершаются ошибкой GeneralException .

Примеры

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

// Gets the locks held by each coauthor in the document.
await Word.run(async (context) => {
  const authors: Word.CoauthorCollection = context.document.coauthoring.authors;
  authors.load("items/name");
  await context.sync();

  if (authors.items.length === 0) {
    console.log("No coauthors are currently editing this document.");
    return;
  }

  authors.items.forEach((author: Word.Coauthor) => {
    author.locks.load("items/type");
  });
  await context.sync();

  authors.items.forEach((author: Word.Coauthor) => {
    const lockCount = author.locks.items.length;
    if (lockCount === 0) {
      console.log(`${author.name}: no locks`);
    } else {
      const types = author.locks.items.map((l) => l.type).join(", ");
      console.log(`${author.name}: ${lockCount} lock(s) — ${types}`);
    }
  });
});

name

Получает отображаемое имя соавтора.

readonly name: string;

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

string

Комментарии

Набор API: WordApiDesktop 1.4

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

load(options)

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

load(options?: Word.Interfaces.CoauthorLoadOptions): Word.Coauthor;

Параметры

options

Word.Interfaces.CoauthorLoadOptions

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

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

Word.Coauthor

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.Coauthor

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.Coauthor

toJSON()

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

toJSON(): Word.Interfaces.CoauthorData;

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

Word.Interfaces.CoauthorData

track()

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

track(): Word.Coauthor;

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

Word.Coauthor

untrack()

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

untrack(): Word.Coauthor;

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

Word.Coauthor