Office.Recurrence interface
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: Redacción o lectura
Estados
| Estado | ¿Editable? | ¿Visible? |
|---|---|---|
| Organizador de citas: redacción de series | 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
| recurrence |
Obtiene o establece las propiedades de la serie de citas periódicas. |
| recurrence |
Obtiene o establece las propiedades de la serie de citas periódicas. |
| recurrence |
Obtiene o establece el tipo de la serie de citas periódicas. |
| series |
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 |
Métodos
| get |
Devuelve el objeto de periodicidad actual de una serie de citas. Este método devuelve todo |
| get |
Devuelve el objeto de periodicidad actual de una serie de citas. Este método devuelve todo |
| set |
Establece el patrón de periodicidad de una serie de citas. Nota: |
| set |
Establece el patrón de periodicidad de una serie de citas. Nota: |
Detalles de las propiedades
recurrenceProperties
Obtiene o establece las propiedades de la serie de citas periódicas.
recurrenceProperties?: RecurrenceProperties;Valor de propiedad
Comentarios
[ Conjunto de API: Buzón 1.7 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Redacción o lectura
recurrenceTimeZone
Obtiene o establece las propiedades de la serie de citas periódicas.
recurrenceTimeZone?: RecurrenceTimeZone;Valor de propiedad
Comentarios
[ Conjunto de API: Buzón 1.7 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Redacción 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: Redacción 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
Comentarios
[ Conjunto de API: Buzón 1.7 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Redacción 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: Redacción 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: Redacción o lectura
setAsync(recurrencePattern, options, callback)
Establece el patrón de periodicidad de una serie de citas.
Nota: setAsync solo debe estar disponible para elementos de serie y no para elementos de instancia.
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: Redacción
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.
Nota: setAsync solo debe estar disponible para elementos de serie y no para elementos de instancia.
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: Redacción
Errores:
InvalidEndTime: la hora de finalización de la cita es anterior a su hora de inicio.
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de