Compartir a través de

Office.Recurrence interface

  • Referencia
Paquete:
outlook

El Recurrence objeto proporciona métodos para obtener y establecer el patrón de periodicidad de las citas, pero solo obtiene el patrón de periodicidad de las solicitudes de reunión. Tendrá un diccionario con las siguientes claves: seriesTime, recurrenceType, recurrencePropertiesy recurrenceTimeZone (opcional).

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Estados

Estado ¿Editable? ¿Visible?
Organizador de citas: serie Compose Sí (setAsync) Sí (getAsync)
Organizador de citas: instancia de Compose No (setAsync devuelve un error) Sí (getAsync)
Asistente de cita: serie de lectura No (setAsync no disponible) Sí (item.recurrence)
Asistente de cita: instancia de lectura No (setAsync no disponible) Sí (item.recurrence)
Convocatoria de reunión: serie de lectura No (setAsync no disponible) Sí (item.recurrence)
Convocatoria de reunión: instancia de lectura No (setAsync no disponible) Sí (item.recurrence)

Propiedades

recurrenceProperties

Obtiene o establece las propiedades de la serie de citas periódicas.
recurrenceTimeZone

Obtiene o establece las propiedades de la serie de citas periódicas.
recurrenceType

Obtiene o establece el tipo de la serie de citas periódicas.
seriesTime

El objeto SeriesTime permite administrar las fechas de inicio y finalización de la serie de citas periódicas y las horas de inicio y finalización habituales de las instancias. Este objeto no está en hora UTC. En su lugar, se establece en la zona horaria especificada por el recurrenceTimeZone valor o se establece de forma predeterminada en la zona horaria del elemento.

Métodos

getAsync(options, callback)

Devuelve el objeto de periodicidad actual de una serie de citas.

Este método devuelve todo Recurrence el objeto de la serie de citas.
getAsync(callback)

Devuelve el objeto de periodicidad actual de una serie de citas.

Este método devuelve todo Recurrence el objeto de la serie de citas.
setAsync(recurrencePattern, options, callback)

Establece el patrón de periodicidad de una serie de citas.
setAsync(recurrencePattern, callback)

Establece el patrón de periodicidad de una serie de citas.

Detalles de las propiedades

recurrenceProperties

Obtiene o establece las propiedades de la serie de citas periódicas.

recurrenceProperties?: RecurrenceProperties;

Valor de propiedad

Office.RecurrenceProperties

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

recurrenceTimeZone

Obtiene o establece las propiedades de la serie de citas periódicas.

recurrenceTimeZone?: RecurrenceTimeZone;

Valor de propiedad

Office.RecurrenceTimeZone

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

recurrenceType

Obtiene o establece el tipo de la serie de citas periódicas.

recurrenceType: MailboxEnums.RecurrenceType | string;

Valor de propiedad

Office.MailboxEnums.RecurrenceType | string

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

seriesTime

El objeto SeriesTime permite administrar las fechas de inicio y finalización de la serie de citas periódicas y las horas de inicio y finalización habituales de las instancias. Este objeto no está en hora UTC. En su lugar, se establece en la zona horaria especificada por el recurrenceTimeZone valor o se establece de forma predeterminada en la zona horaria del elemento.

seriesTime: SeriesTime;

Valor de propiedad

Office.SeriesTime

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Detalles del método

getAsync(options, callback)

Devuelve el objeto de periodicidad actual de una serie de citas.

Este método devuelve todo Recurrence el objeto de la serie de citas.

getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<Recurrence>) => 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<Office.Recurrence>) => 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, asyncResult, que es un Office.AsyncResult objeto . La value propiedad del resultado es un Recurrence objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

Office.context.mailbox.item.recurrence.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const recurrence = asyncResult.value;
    if (recurrence === null) {
      console.log("This is a single appointment.");
    } else {
      console.log(`Recurrence pattern: ${JSON.stringify(recurrence)}`);
    }
  } else {
    console.error(asyncResult.error);
  }
});

getAsync(callback)

Devuelve el objeto de periodicidad actual de una serie de citas.

Este método devuelve todo Recurrence el objeto de la serie de citas.

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

Parámetros

callback

(asyncResult: Office.AsyncResult<Office.Recurrence>) => 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, asyncResult, que es un Office.AsyncResult objeto . La value propiedad del resultado es un Recurrence objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

setAsync(recurrencePattern, options, callback)

Establece el patrón de periodicidad de una serie de citas.

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

Parámetros

recurrencePattern
Office.Recurrence

Objeto de periodicidad.

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

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

Modo de Outlook aplicable: Compose

Importante:

  • setAsync solo está disponible para elementos de serie y no para elementos de instancia.

  • El setAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

Errores:

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

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/50-recurrence/get-set-recurrence-appointment-organizer.yaml

// Important: Can only set the recurrence pattern of an appointment series.

const currentDate = new Date();
let seriesTimeObject: Office.SeriesTime;
// Set series start date to tomorrow.
seriesTimeObject.setStartDate(currentDate.getFullYear(), currentDate.getMonth(), currentDate.getDay() + 1);
// Set series end date to one year from now.
seriesTimeObject.setEndDate(currentDate.getFullYear() + 1, currentDate.getMonth() + 1, currentDate.getDay());
// Set start time to 1:30 PM.
seriesTimeObject.setStartTime(13, 30);
// Set duration to 30 minutes.
seriesTimeObject.setDuration(30);

const pattern: Office.Recurrence = {
  seriesTime: seriesTimeObject,
  recurrenceType: Office.MailboxEnums.RecurrenceType.Yearly,
  recurrenceProperties: {
    interval: 1,
    dayOfWeek: Office.MailboxEnums.Days.Tue,
    weekNumber: Office.MailboxEnums.WeekNumber.Second,
    month: Office.MailboxEnums.Month.Sep
  },
  recurrenceTimeZone: { name: Office.MailboxEnums.RecurrenceTimeZone.PacificStandardTime }
};

Office.context.mailbox.item.recurrence.setAsync(pattern, (asyncResult) => {
  if (asyncResult.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Failed to set recurrence. Error: ${asyncResult.error.message}`);
    return;
  }
  console.log(`Succeeded in setting recurrence pattern ${JSON.stringify(pattern)}`);
});

setAsync(recurrencePattern, callback)

Establece el patrón de periodicidad de una serie de citas.

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

Parámetros

recurrencePattern
Office.Recurrence

Objeto de periodicidad.

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.7 ]

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

Modo de Outlook aplicable: Compose

Importante:

  • setAsync solo está disponible para elementos de serie y no para elementos de instancia.

  • El setAsync método no se admite en un mensaje que se carga actualmente mediante el loadItemByIdAsync método . Para obtener más información, vea Activar el complemento de Outlook en varios mensajes.

Errores:

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