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 registada à tarefa.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Propriedades

assignee

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

Representa a identidade do utilizador que efetuou a alteração da tarefa.
commentId

Representa o ID da resposta do comentário ou comentário ao qual a alteração da tarefa está ancorada.
context

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

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

Representa a data e hora para conclusão da tarefa. É utilizado para a ação setSchedule de alteração. Está no fuso horário UTC. Pode ser definido para null remover a data e hora para conclusão. Deve ser definido em conjunto com startDateTime para evitar conflitos.
id

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

Representa a percentagem de conclusão da tarefa. É utilizado para a ação setPercentComplete de alteração. Este é um valor entre 0 e 100, em que 100 representa uma tarefa concluída. Alterar este 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. É utilizado para a ação setPriority de alteração. Este é um valor entre 0 e 10, sendo 5 a prioridade predefinida se não estiver definida e em que 0 representa a prioridade mais alta.
startDateTime

Representa a data e hora de início da tarefa. É utilizado para a ação setSchedule de alteração. Está no fuso horário UTC. Pode ser definido como para null remover a data e hora de início. Deve ser definido em conjunto com dueDateTime para evitar conflitos.
title

Representa o título da tarefa. É utilizado para a ação setTitle de alteração.
type

Representa o tipo de ação do registo 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 anulada 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)

Crie uma nova instância do Excel.DocumentTaskChange objeto.
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 Excel.DocumentTaskChange é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.DocumentTaskChangeData) que contém cópias rasas de quaisquer propriedades subordinadas 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 utilizador atribuído à tarefa para uma ação de alteração assign ou o utilizador não atribuído 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 (APENAS PRÉ-VISUALIZAÇÃO) ]

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 utilizador que efetuou a alteração da tarefa.

readonly changedBy: Excel.EmailIdentity;

Valor da propriedade

Excel.EmailIdentity

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 o ID da resposta do comentário ou comentário ao qual a alteração da tarefa está ancorada.

readonly commentId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 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

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 hora de criação do registo de alteração da tarefa. Todas as datas estão em UTC.

readonly createdDateTime: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 hora para conclusão da tarefa. É utilizado para a ação setSchedule de alteração. Está no fuso horário UTC. Pode ser definido para null remover a data e hora para conclusão. Deve ser definido em conjunto com startDateTime para evitar conflitos.

readonly dueDateTime: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 (APENAS PRÉ-VISUALIZAÇÃO) ]

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 a percentagem de conclusão da tarefa. É utilizado para a ação setPercentComplete de alteração. Este é um valor entre 0 e 100, em que 100 representa uma tarefa concluída. Alterar este 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 (APENAS PRÉ-VISUALIZAÇÃO) ]

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. É utilizado para a ação setPriority de alteração. Este é um valor entre 0 e 10, sendo 5 a prioridade predefinida se não estiver definida e em que 0 representa a prioridade mais alta.

readonly priority: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 hora de início da tarefa. É utilizado para a ação setSchedule de alteração. Está no fuso horário UTC. Pode ser definido como para null remover a data e hora de início. Deve ser definido em conjunto com dueDateTime para evitar conflitos.

readonly startDateTime: Date;

Valor da propriedade

Date

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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. É utilizado para a ação setTitle de alteração.

readonly title: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 registo 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 (APENAS PRÉ-VISUALIZAÇÃO) ]

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 anulada para a ação undo de alteração.

readonly undoChangeId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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 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

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.

Crie uma nova instância do Excel.DocumentTaskChange objeto.

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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.DocumentTaskChange é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.DocumentTaskChangeData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.DocumentTaskChangeData;

Retornos

Excel.Interfaces.DocumentTaskChangeData