Word.Conflict class

Pacote:: word

Representa um conflito de cocriação num documento Word.

Extends: OfficeExtension.ClientObject

Comentários

Usada por

Word. ConflictCollection: getItem, itens

Propriedades

context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
range	Obtém um `Range` objeto que representa a parte do documento que está contida no `Conflict` objeto.
type	Obtém o `RevisionType` para o `Conflict` objeto.

Métodos

accept()	Aceita a alteração do utilizador e remove o conflito.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
reject()	Rejeita a alteração do utilizador, remove o conflito e aceita a cópia do servidor da alteração do conflito.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é transmitido para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que lhe é transmitido.) Enquanto o objeto original `Word.Conflict` é um objeto de API, o `toJSON` método devolve um objeto JavaScript simples (escrito como `Word.Interfaces.ConflictData`) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre `.sync` chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar `context.sync()` antes de a libertação da memória ser aplicada.

Detalhes da propriedade

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

range

Obtém um Range objeto que representa a parte do documento que está contida no Conflict objeto.

readonly range: Word.Range;

Valor da propriedade

Word.Range

Comentários

Conjunto de API: WordApiDesktop 1.4

type

Obtém o RevisionType para o Conflict objeto.

readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete";

Valor da propriedade

Comentários

Conjunto de API: WordApiDesktop 1.4

Detalhes do método

accept()

Aceita a alteração do utilizador e remove o conflito.

accept(): void;

Retornos

void

Comentários

Conjunto de API: WordApiDesktop 1.4

Exemplos

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

// Accepts the user's change for the first conflict and removes it.
await Word.run(async (context) => {
  const conflicts: Word.ConflictCollection = context.document.coauthoring.conflicts;
  conflicts.load("items");
  await context.sync();

  if (conflicts.items.length === 0) {
    console.log("No conflicts to accept.");
    return;
  }

  conflicts.items[0].accept();
  await context.sync();

  console.log("First conflict accepted (your change kept).");
});

load(options)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.ConflictLoadOptions): Word.Conflict;

Parâmetros

options: Word.Interfaces.ConflictLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Word.Conflict

load(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

propertyNames: string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Word.Conflict

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Word.Conflict

reject()

Rejeita a alteração do utilizador, remove o conflito e aceita a cópia do servidor da alteração do conflito.

reject(): void;

Retornos

void

Comentários

Conjunto de API: WordApiDesktop 1.4

Exemplos

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

// Rejects the user's change for the first conflict and keeps the server copy.
await Word.run(async (context) => {
  const conflicts: Word.ConflictCollection = context.document.coauthoring.conflicts;
  conflicts.load("items");
  await context.sync();

  if (conflicts.items.length === 0) {
    console.log("No conflicts to reject.");
    return;
  }

  conflicts.items[0].reject();
  await context.sync();

  console.log("First conflict rejected (server copy kept).");
});

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.ConflictUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties: Word.Interfaces.ConflictUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options: OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Word.Conflict): void;

Parâmetros

properties: Word.Conflict

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Conflict é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ConflictData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.ConflictData;

Retornos

Word.Interfaces.ConflictData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.Conflict;

Retornos

Word.Conflict

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.Conflict;

Retornos

Word.Conflict

Comentários

Esta página foi útil?