Excel.DocumentTaskChange class

  • Referencia
Paquete:
excel

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa un cambio registrado en la tarea.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Propiedades

assignee

Representa el usuario asignado a la tarea para una assign acción de cambio o el usuario no asignado a la tarea para una unassign acción de cambio.
changedBy

Representa la identidad del usuario que realizó el cambio de tarea.
commentId

Representa el identificador de comment o commentReply al que está delimitado el cambio de tarea.
context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
createdDateTime

Representa la fecha y hora de creación del registro de cambio de tarea. Todas las fechas están en UTC.
dueDateTime

Representa la fecha y hora de vencimiento de la tarea. Se usa para la acción de setSchedule cambio. Está en la zona horaria UTC. Se puede establecer en null para quitar la fecha y hora de vencimiento. Debe establecerse junto con startDateTime para evitar conflictos.
id

El GUID único del cambio de tarea.
percentComplete

Representa el porcentaje de finalización de la tarea. Se usa para la acción de setPercentComplete cambio. Se trata de un valor entre 0 y 100, donde 100 representa una tarea completada. Al cambiar este valor a 100, también se completa el comentario asociado. Al cambiar la finalización de 100 a un valor inferior, se reactiva el comentario asociado.
priority

Representa la prioridad de la tarea. Se usa para la acción de setPriority cambio. Se trata de un valor entre 0 y 10, con 5 como prioridad predeterminada si no se establece y donde 0 representa la prioridad más alta.
startDateTime

Representa la fecha y hora de inicio de la tarea. Se usa para la acción de setSchedule cambio. Está en la zona horaria UTC. Se puede establecer en null para quitar la fecha y hora de inicio. Debe establecerse junto con dueDateTime para evitar conflictos.
title

Representa el título de la tarea. Se usa para la acción de setTitle cambio.
type

Representa el tipo de acción del registro de cambio de tarea. Algunos ejemplos de tipos de acción son assign, undoy setPriority.
undoChangeId

Representa la DocumentTaskChange.id propiedad que se deshacía para la acción de undo cambio.

Métodos

load(options)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
newObject(context)

Creación de una nueva instancia del objeto Excel.DocumentTaskChange
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.DocumentTaskChange original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.DocumentTaskChangeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

assignee

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa el usuario asignado a la tarea para una assign acción de cambio o el usuario no asignado a la tarea para una unassign acción de cambio.

readonly assignee: Excel.EmailIdentity;

Valor de propiedad

Excel.EmailIdentity

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

changedBy

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa la identidad del usuario que realizó el cambio de tarea.

readonly changedBy: Excel.EmailIdentity;

Valor de propiedad

Excel.EmailIdentity

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

commentId

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa el identificador de comment o commentReply al que está delimitado el cambio de tarea.

readonly commentId: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

context

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Excel.RequestContext

createdDateTime

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa la fecha y hora de creación del registro de cambio de tarea. Todas las fechas están en UTC.

readonly createdDateTime: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

dueDateTime

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa la fecha y hora de vencimiento de la tarea. Se usa para la acción de setSchedule cambio. Está en la zona horaria UTC. Se puede establecer en null para quitar la fecha y hora de vencimiento. Debe establecerse junto con startDateTime para evitar conflictos.

readonly dueDateTime: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

id

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

El GUID único del cambio de tarea.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

percentComplete

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa el porcentaje de finalización de la tarea. Se usa para la acción de setPercentComplete cambio. Se trata de un valor entre 0 y 100, donde 100 representa una tarea completada. Al cambiar este valor a 100, también se completa el comentario asociado. Al cambiar la finalización de 100 a un valor inferior, se reactiva el comentario asociado.

readonly percentComplete: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

priority

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa la prioridad de la tarea. Se usa para la acción de setPriority cambio. Se trata de un valor entre 0 y 10, con 5 como prioridad predeterminada si no se establece y donde 0 representa la prioridad más alta.

readonly priority: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

startDateTime

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa la fecha y hora de inicio de la tarea. Se usa para la acción de setSchedule cambio. Está en la zona horaria UTC. Se puede establecer en null para quitar la fecha y hora de inicio. Debe establecerse junto con dueDateTime para evitar conflictos.

readonly startDateTime: Date;

Valor de propiedad

Date

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

title

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa el título de la tarea. Se usa para la acción de setTitle cambio.

readonly title: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

type

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa el tipo de acción del registro de cambio de tarea. Algunos ejemplos de tipos de acción son assign, undoy setPriority.

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

Valor de propiedad

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

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

undoChangeId

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Representa la DocumentTaskChange.id propiedad que se deshacía para la acción de undo cambio.

readonly undoChangeId: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi BETA (SOLO VERSIÓN PRELIMINAR) ]

Detalles del método

load(options)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

options
Excel.Interfaces.DocumentTaskChangeLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.DocumentTaskChange

load(propertyNames)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.DocumentTaskChange;

Parámetros

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.DocumentTaskChange

load(propertyNamesAndPaths)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.DocumentTaskChange;

Parámetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.DocumentTaskChange

newObject(context)

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Creación de una nueva instancia del objeto Excel.DocumentTaskChange

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

Parámetros

context
OfficeExtension.ClientRequestContext

Devoluciones

Excel.DocumentTaskChange

toJSON()

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto Excel.DocumentTaskChange original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.DocumentTaskChangeData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.DocumentTaskChangeData;

Devoluciones

Excel.Interfaces.DocumentTaskChangeData