Compartilhar via

Excel.DocumentTaskChange class

  • Referência
Pacote:
excel

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa uma alteração registrada na tarefa.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

Propriedades

assignee

Representa o usuário atribuído à tarefa para uma assign ação de alteração ou o usuário não assinado da tarefa para uma unassign ação de alteração.
changedBy

Representa a identidade do usuário que fez a alteração da tarefa.
commentId

Representa a ID do comment ou commentReply ao qual a alteração de tarefa está ancorada.
context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
createdDateTime

Representa a data e a hora da criação do registro de alteração de tarefa. Todas as datas estão em UTC.
dueDateTime

Representa a data e a hora da tarefa. Ele é usado para a ação setSchedule de alteração. Ele está no fuso horário UTC. Ele pode ser definido para null remover a data e a hora de vencimento. Ele deve ser definido junto com startDateTime para evitar conflitos.
id

O GUID exclusivo da alteração da tarefa.
percentComplete

Representa o percentual de conclusão da tarefa. Ele é usado para a ação setPercentComplete de alteração. Esse é um valor entre 0 e 100, em que 100 representa uma tarefa concluída. Alterar esse valor para 100 também conclui o comentário associado. Alterar a conclusão de 100 para um valor inferior reativa o comentário associado.
priority

Representa a prioridade da tarefa. Ele é usado para a ação setPriority de alteração. Esse é um valor entre 0 e 10, sendo 5 a prioridade padrão, se não definido, e em que 0 representa a prioridade mais alta.
startDateTime

Representa a data e a hora de início da tarefa. Ele é usado para a ação setSchedule de alteração. Ele está no fuso horário UTC. Ele pode ser definido para null remover a data e a hora de início. Ele deve ser definido junto com dueDateTime para evitar conflitos.
title

Representa o título da tarefa. Ele é usado para a ação setTitle de alteração.
type

Representa o tipo de ação do registro de alteração de tarefa. Alguns exemplos de tipos de ação são assign, undoe setPriority.
undoChangeId

Representa a DocumentTaskChange.id propriedade que foi desfeita para a ação undo de alteração.

Métodos

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.
newObject(context)

Criar uma nova instância do objeto Excel.DocumentTaskChange
toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.DocumentTaskChange original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DocumentTaskChangeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

assignee

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa o usuário atribuído à tarefa para uma assign ação de alteração ou o usuário não assinado da tarefa para uma unassign ação de alteração.

readonly assignee: Excel.EmailIdentity;

Valor da propriedade

Excel.EmailIdentity

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

changedBy

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa a identidade do usuário que fez a alteração da tarefa.

readonly changedBy: Excel.EmailIdentity;

Valor da propriedade

Excel.EmailIdentity

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

commentId

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa a ID do comment ou commentReply ao qual a alteração de tarefa está ancorada.

readonly commentId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

context

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

createdDateTime

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa a data e a hora da criação do registro de alteração de tarefa. Todas as datas estão em UTC.

readonly createdDateTime: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

dueDateTime

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa a data e a hora da tarefa. Ele é usado para a ação setSchedule de alteração. Ele está no fuso horário UTC. Ele pode ser definido para null remover a data e a hora de vencimento. Ele deve ser definido junto com startDateTime para evitar conflitos.

readonly dueDateTime: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

id

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O GUID exclusivo da alteração da tarefa.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

percentComplete

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa o percentual de conclusão da tarefa. Ele é usado para a ação setPercentComplete de alteração. Esse é um valor entre 0 e 100, em que 100 representa uma tarefa concluída. Alterar esse valor para 100 também conclui o comentário associado. Alterar a conclusão de 100 para um valor inferior reativa o comentário associado.

readonly percentComplete: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

priority

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa a prioridade da tarefa. Ele é usado para a ação setPriority de alteração. Esse é um valor entre 0 e 10, sendo 5 a prioridade padrão, se não definido, e em que 0 representa a prioridade mais alta.

readonly priority: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

startDateTime

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa a data e a hora de início da tarefa. Ele é usado para a ação setSchedule de alteração. Ele está no fuso horário UTC. Ele pode ser definido para null remover a data e a hora de início. Ele deve ser definido junto com dueDateTime para evitar conflitos.

readonly startDateTime: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

title

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa o título da tarefa. Ele é usado para a ação setTitle de alteração.

readonly title: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

type

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa o tipo de ação do registro de alteração de tarefa. Alguns exemplos de tipos de ação são assign, undoe setPriority.

readonly type: Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo";

Valor da propriedade

Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo"

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

undoChangeId

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Representa a DocumentTaskChange.id propriedade que foi desfeita para a ação undo de alteração.

readonly undoChangeId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

Detalhes do método

load(options)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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

load(options?: Excel.Interfaces.DocumentTaskChangeLoadOptions): Excel.DocumentTaskChange;

Parâmetros

options
Excel.Interfaces.DocumentTaskChangeLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.DocumentTaskChange

load(propertyNames)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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[]): Excel.DocumentTaskChange;

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.DocumentTaskChange

load(propertyNamesAndPaths)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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;
        }): Excel.DocumentTaskChange;

Parâmetros

propertyNamesAndPaths

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

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

Retornos

Excel.DocumentTaskChange

newObject(context)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Criar uma nova instância do objeto Excel.DocumentTaskChange

static newObject(context: OfficeExtension.ClientRequestContext): Excel.DocumentTaskChange;

Parâmetros

context
OfficeExtension.ClientRequestContext

Retornos

Excel.DocumentTaskChange

toJSON()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.DocumentTaskChange original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.DocumentTaskChangeData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.DocumentTaskChangeData;

Retornos

Excel.Interfaces.DocumentTaskChangeData