Excel.DocumentTask class
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 tarefa.
- Extends
Propriedades
| assignees | Devolve uma coleção de detentores da tarefa. |
| changes | Obtém os registos de alteração da tarefa. |
| comment | Obtém o comentário associado à tarefa. |
| completed |
Faz com que o utilizador mais recente tenha concluído a tarefa. |
| completed |
Obtém a data e hora em que a tarefa foi concluída. Todas as datas estão em UTC. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| created |
Obtém o utilizador que criou a tarefa. |
| created |
Obtém a data e hora em que a tarefa foi criada. Todas as datas estão em UTC. |
| id | Obtém o ID da tarefa. |
| percent |
Especifica a percentagem de conclusão da tarefa. Este é um valor entre 0 e 100, em que 100 representa uma tarefa concluída. |
| priority | Especifica a prioridade da tarefa. Este é um valor entre 0 e 10, em que 0 representa a prioridade mais alta. |
| start |
Especifica a data e hora em que a tarefa deve ser iniciada e está para conclusão. |
| title | Especifica o título da tarefa. |
Métodos
| assign(assignee) | Adiciona o utilizador especificado à lista de detentores anexados à tarefa. |
| 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 |
| unassign(assignee) | Remove o utilizador especificado da lista de detentores anexados à tarefa. |
| unassign |
Remove todos os utilizadores da lista de detentores anexados à tarefa. |
Detalhes da propriedade
assignees
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.
Devolve uma coleção de detentores da tarefa.
readonly assignees: Excel.EmailIdentity[];Valor da propriedade
Comentários
changes
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.
Obtém os registos de alteração da tarefa.
readonly changes: Excel.DocumentTaskChangeCollection;Valor da propriedade
Comentários
comment
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.
Obtém o comentário associado à tarefa.
readonly comment: Excel.Comment;Valor da propriedade
Comentários
completedBy
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.
Faz com que o utilizador mais recente tenha concluído a tarefa.
readonly completedBy: Excel.EmailIdentity;Valor da propriedade
Comentários
completedDateTime
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.
Obtém a data e hora em que a tarefa foi concluída. Todas as datas estão em UTC.
readonly completedDateTime: Date;Valor da propriedade
Date
Comentários
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
createdBy
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.
Obtém o utilizador que criou a tarefa.
readonly createdBy: Excel.EmailIdentity;Valor da propriedade
Comentários
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.
Obtém a data e hora em que a tarefa foi criada. Todas as datas estão em UTC.
readonly createdDateTime: Date;Valor da propriedade
Date
Comentários
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.
Obtém o ID da tarefa.
readonly id: string;Valor da propriedade
string
Comentários
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.
Especifica a percentagem de conclusão da tarefa. Este é um valor entre 0 e 100, em que 100 representa uma tarefa concluída.
percentComplete: number;Valor da propriedade
number
Comentários
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.
Especifica a prioridade da tarefa. Este é um valor entre 0 e 10, em que 0 representa a prioridade mais alta.
priority: number;Valor da propriedade
number
Comentários
startAndDueDateTime
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.
Especifica a data e hora em que a tarefa deve ser iniciada e está para conclusão.
startAndDueDateTime: Excel.DocumentTaskSchedule;Valor da propriedade
Comentários
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.
Especifica o título da tarefa.
title: string;Valor da propriedade
string
Comentários
Detalhes do método
assign(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.
Adiciona o utilizador especificado à lista de detentores anexados à tarefa.
assign(assignee: Excel.EmailIdentity): void;Parâmetros
- assignee
- Excel.EmailIdentity
A identidade do utilizador a adicionar à lista de detentores.
Retornos
void
Comentários
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.DocumentTaskLoadOptions): Excel.DocumentTask;Parâmetros
Fornece opções para as propriedades do objeto a carregar.
Retornos
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.DocumentTask;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)
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.DocumentTask;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()
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.DocumentTask é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.DocumentTaskData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.DocumentTaskData;Retornos
unassign(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.
Remove o utilizador especificado da lista de detentores anexados à tarefa.
unassign(assignee: Excel.EmailIdentity): void;Parâmetros
- assignee
- Excel.EmailIdentity
A identidade do utilizador a remover da lista de detentores.
Retornos
void
Comentários
unassignAll()
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.
Remove todos os utilizadores da lista de detentores anexados à tarefa.
unassignAll(): void;Retornos
void