Office.Time interface

  • Referencia
Paquete:
outlook

El Time objeto se devuelve como la propiedad start o end de una cita en modo de redacción.

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción

Métodos

getAsync(options, callback)

Obtiene la hora de inicio o finalización de una cita.

La fecha y hora se proporcionan como un Date objeto de la asyncResult.value propiedad . El valor se encuentra en la hora UTC (hora universal coordinada). Puede convertir la hora UTC a la hora del cliente local mediante el convertToLocalClientTime método .
getAsync(callback)

Obtiene la hora de inicio o finalización de una cita.

La fecha y hora se proporcionan como un Date objeto de la asyncResult.value propiedad . El valor se encuentra en la hora UTC (hora universal coordinada). Puede convertir la hora UTC a la hora del cliente local mediante el convertToLocalClientTime método .
setAsync(dateTime, options, callback)

Establece la hora de inicio o finalización de una cita.

Si se llama al setAsync método en la propiedad start, la end propiedad se ajustará para mantener la duración de la cita como se estableció anteriormente. Si se llama al método setAsync en la propiedad end, la duración de la cita se extenderá hasta la nueva hora de finalización.

La hora debe especificarse conforme al sistema UTC. Puede obtener la hora UTC correcta con el método convertToUtcClientTime.

Importante: En el cliente de Windows, no puede usar este método para actualizar el inicio o el final de una periodicidad.
setAsync(dateTime, callback)

Establece la hora de inicio o finalización de una cita.

Si se llama al setAsync método en la propiedad start, la end propiedad se ajustará para mantener la duración de la cita como se estableció anteriormente. Si se llama al método setAsync en la propiedad end, la duración de la cita se extenderá hasta la nueva hora de finalización.

La hora debe especificarse conforme al sistema UTC. Puede obtener la hora UTC correcta con el método convertToUtcClientTime.

Importante: En el cliente de Windows, no puede usar este método para actualizar el inicio o el final de una periodicidad.

Detalles del método

getAsync(options, callback)

Obtiene la hora de inicio o finalización de una cita.

La fecha y hora se proporcionan como un Date objeto de la asyncResult.value propiedad . El valor se encuentra en la hora UTC (hora universal coordinada). Puede convertir la hora UTC a la hora del cliente local mediante el convertToLocalClientTime método .

getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<Date>) => void): void;

Parámetros

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<Date>) => void

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. La value propiedad del resultado es un Date objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción

getAsync(callback)

Obtiene la hora de inicio o finalización de una cita.

La fecha y hora se proporcionan como un Date objeto de la asyncResult.value propiedad . El valor se encuentra en la hora UTC (hora universal coordinada). Puede convertir la hora UTC a la hora del cliente local mediante el convertToLocalClientTime método .

getAsync(callback: (asyncResult: Office.AsyncResult<Date>) => void): void;

Parámetros

callback

(asyncResult: Office.AsyncResult<Date>) => void

Cuando se completa el método, se llama a la función pasada en el parámetro de devolución de llamada con un único parámetro de tipo Office.AsyncResult. La value propiedad del resultado es un Date objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Redacción

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment starts: ${result.value}`);
});

setAsync(dateTime, options, callback)

Establece la hora de inicio o finalización de una cita.

Si se llama al setAsync método en la propiedad start, la end propiedad se ajustará para mantener la duración de la cita como se estableció anteriormente. Si se llama al método setAsync en la propiedad end, la duración de la cita se extenderá hasta la nueva hora de finalización.

La hora debe especificarse conforme al sistema UTC. Puede obtener la hora UTC correcta con el método convertToUtcClientTime.

Importante: En el cliente de Windows, no puede usar este método para actualizar el inicio o el final de una periodicidad.

setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

dateTime

Date

Un objeto date-time en Hora universal coordinada (UTC).

options
Office.AsyncContextOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada.

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si al establecer la fecha y la hora se produce un error, la propiedad asyncResult.error contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Errores:

  • InvalidEndTime: la hora de finalización de la cita es anterior a la hora de inicio de la cita.

Ejemplos

const startTime = new Date("3/14/2015");
const options = {
    // Pass information that can be used in the callback.
    asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.start.setAsync(startTime, options, function(result) {
    if (result.error) {
        console.debug(result.error);
    } else {
        // Access the asyncContext that was passed to the setAsync method.
        console.debug("Start Time " + result.asyncContext.verb);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml

const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

...

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  const end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

setAsync(dateTime, callback)

Establece la hora de inicio o finalización de una cita.

Si se llama al setAsync método en la propiedad start, la end propiedad se ajustará para mantener la duración de la cita como se estableció anteriormente. Si se llama al método setAsync en la propiedad end, la duración de la cita se extenderá hasta la nueva hora de finalización.

La hora debe especificarse conforme al sistema UTC. Puede obtener la hora UTC correcta con el método convertToUtcClientTime.

Importante: En el cliente de Windows, no puede usar este método para actualizar el inicio o el final de una periodicidad.

setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

dateTime

Date

Un objeto date-time en Hora universal coordinada (UTC).

callback

(asyncResult: Office.AsyncResult<void>) => void

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si al establecer la fecha y la hora se produce un error, la propiedad asyncResult.error contendrá un código de error.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.1 ]

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Redacción

Errores:

  • InvalidEndTime: la hora de finalización de la cita es anterior a la hora de inicio de la cita.