Word.Coauthoring class
Representa o Coauthoring objeto . Esta ação monitoriza as atualizações, alterações, conflitos e outras interações no documento efetuadas através da cocriação.
- Extends
Comentários
Conjunto de API: WordApiDesktop 1.4
Usada por
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthors.yaml
// Gets the coauthoring capabilities and pending-update status of the document.
await Word.run(async (context) => {
const coauthoring: Word.Coauthoring = context.document.coauthoring;
coauthoring.load("canCoauthor,canMerge,pendingUpdates");
await context.sync();
console.log("Can coauthor:", coauthoring.canCoauthor);
console.log("Can merge:", coauthoring.canMerge);
console.log("Pending updates:", coauthoring.pendingUpdates);
});
Propriedades
| authors | Obtém um |
| can |
Obtém se este documento pode ser cocriado. |
| can |
Obtém se o documento pode ser intercalado automaticamente. |
| conflicts | Obtém um |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| locks | Obtém um |
| me | Obtém um |
| pending |
Obtém se o documento tem atualizações pendentes que não foram aceites. |
| updates | Obtém um |
Métodos
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
| 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 |
| 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 |
Detalhes da propriedade
authors
Obtém um CoauthorCollection objeto que representa todos os cocriadores atualmente a editar o documento.
readonly authors: Word.CoauthorCollection;Valor da propriedade
Comentários
canCoauthor
Obtém se este documento pode ser cocriado.
readonly canCoauthor: boolean;Valor da propriedade
boolean
Comentários
canMerge
Obtém se o documento pode ser intercalado automaticamente.
readonly canMerge: boolean;Valor da propriedade
boolean
Comentários
conflicts
Obtém um ConflictCollection objeto que representa todos os conflitos no documento.
readonly conflicts: Word.ConflictCollection;Valor da propriedade
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
// 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
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
locks
Obtém um CoauthoringLockCollection objeto que representa os bloqueios no documento.
readonly locks: Word.CoauthoringLockCollection;Valor da propriedade
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-locks.yaml
// Adds a lock to the paragraph at the insertion point.
// Requires the document to be saved to OneDrive or SharePoint.
await Word.run(async (context) => {
const coauthoring: Word.Coauthoring = context.document.coauthoring;
coauthoring.load("canCoauthor");
await context.sync();
if (!coauthoring.canCoauthor) {
console.warn("This document doesn't support coauthoring. Save it to OneDrive or SharePoint and try again.");
return;
}
const locks: Word.CoauthoringLockCollection = coauthoring.locks;
locks.add();
await context.sync();
console.log("Lock added.");
});
me
Obtém um Coauthor objeto que representa o utilizador atual.
readonly me: Word.Coauthor;Valor da propriedade
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-coauthors.yaml
// Gets the current user's coauthor information.
await Word.run(async (context) => {
const me: Word.Coauthor = context.document.coauthoring.me;
me.load("name,emailAddress,id");
await context.sync();
console.log("Current user:", me.name);
console.log("Email:", me.emailAddress);
console.log("ID:", me.id);
});
pendingUpdates
Obtém se o documento tem atualizações pendentes que não foram aceites.
readonly pendingUpdates: boolean;Valor da propriedade
boolean
Comentários
updates
Obtém um CoauthoringUpdateCollection objeto que representa as atualizações mais recentes que foram intercaladas no documento.
readonly updates: Word.CoauthoringUpdateCollection;Valor da propriedade
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/get-coauthoring-updates.yaml
// Gets the ranges affected by the most recent coauthoring updates merged into the document.
await Word.run(async (context) => {
const updates: Word.CoauthoringUpdateCollection = context.document.coauthoring.updates;
updates.load("items/range");
await context.sync();
if (updates.items.length === 0) {
console.log("No recent coauthoring updates found.");
return;
}
console.log(`Found ${updates.items.length} recent update(s).`);
const ranges = updates.items.map((u) => u.range);
ranges.forEach((r) => r.load("text"));
await context.sync();
ranges.forEach((range, i) => {
console.log(` Update ${i + 1}: "${range.text}"`);
});
});
Detalhes do método
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.CoauthoringLoadOptions): Word.Coauthoring;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
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.Coauthoring;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
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.Coauthoring;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
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.Coauthoring é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.CoauthoringData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.CoauthoringData;Retornos
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.Coauthoring;Retornos
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.Coauthoring;