Office.IsAllDayEvent interface
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.
Proporciona métodos para obtener y establecer el estado de evento de todo el día de una reunión en un complemento de Outlook.
Comentarios
[ Conjunto de API: versión preliminar del buzón ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose
Métodos
| get |
Obtiene el valor booleano que indica si el evento es todo el día o no. |
| get |
Obtiene el valor booleano que indica si el evento es todo el día o no. |
| set |
Establece el estado de evento de todo el día de una cita. |
| set |
Establece el estado de evento de todo el día de una cita. |
Detalles del método
getAsync(options, callback)
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.
Obtiene el valor booleano que indica si el evento es todo el día o no.
getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<boolean>) => 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<boolean>) => 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.
Devoluciones
void
Comentarios
[ Conjunto de API: versión preliminar del buzón ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose
getAsync(callback)
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.
Obtiene el valor booleano que indica si el evento es todo el día o no.
getAsync(callback: (asyncResult: Office.AsyncResult<boolean>) => void): void;Parámetros
- callback
-
(asyncResult: Office.AsyncResult<boolean>) => 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.
Devoluciones
void
Comentarios
[ Conjunto de API: versión preliminar del buzón ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Compose
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Is this an all-day event? " + asyncResult.value);
} else {
console.log("Failed to get if this is an all-day event. Error: " + JSON.stringify(asyncResult.error));
}
});
setAsync(isAllDayEvent, options, callback)
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.
Establece el estado de evento de todo el día de una cita.
setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- isAllDayEvent
-
boolean
valor booleano para establecer el estado del evento de todo el día.
- 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: versión preliminar del buzón ]
Si una cita está marcada como un evento de todo el día: - La hora de inicio y finalización se marcará como a las 12:00 (al igual que en la interfaz de usuario de Outlook). La hora de inicio volverá a las 12:00 a.m. y la hora de finalización será a las 12:00 am del día siguiente.
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Compose
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/get-set-isalldayevent.yaml
Office.context.mailbox.item.isAllDayEvent.setAsync(true, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Failed) {
console.log("Failed to set all-day event: " + JSON.stringify(asyncResult.error));
} else {
console.log("Appointment set to all-day event.");
}
});
setAsync(isAllDayEvent, callback)
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.
Establece el estado de evento de todo el día de una cita.
setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;Parámetros
- isAllDayEvent
-
boolean
valor booleano para establecer el estado del evento de todo el día.
- 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: versión preliminar del buzón ]
Si una cita está marcada como un evento de todo el día: - La hora de inicio y finalización se marcará como a las 12:00 (al igual que en la interfaz de usuario de Outlook). La hora de inicio volverá a las 12:00 a.m. y la hora de finalización será a las 12:00 am del día siguiente.
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Compose