Office.AppointmentCompose interface
Modo organizador de citas de Office.context.mailbox.item.
Importante: se trata de un objeto interno de Outlook, no expuesto directamente a través de interfaces existentes. Debe tratar esto como un modo de Office.context.mailbox.item. Para obtener más información, consulte la página Modelo de objetos.
Interfaces primarias:
- Extends
Propiedades
| body | Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento. |
| end | Obtiene o establece la fecha y la hora de finalización de la cita. La Si usa el método Importante: En el cliente de Windows, no puede usar esta propiedad para actualizar el final de una periodicidad. |
| item |
Obtiene el tipo de elemento que representa una instancia. La propiedad |
| location | Obtiene o establece la ubicación de una cita. La |
| optional |
Proporciona acceso a los asistentes opcionales de un evento. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual. La propiedad |
| required |
Proporciona acceso a los asistentes necesarios de un evento. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual. La propiedad |
| start | Obtiene o establece la fecha y la hora de inicio de la cita. La Si usa el método Importante: En el cliente de Windows, no puede usar esta propiedad para actualizar el inicio de una periodicidad. |
| subject | Obtiene o establece la descripción que se muestra en el campo de asunto de un elemento. La propiedad La propiedad |
Métodos
| add |
Agrega un archivo a un mensaje o cita como datos adjuntos. El método |
| add |
Agrega un archivo a un mensaje o cita como datos adjuntos. El método |
| add |
Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. El método Después, puede usar el identificador con el método Si el complemento de Office se ejecuta en Outlook en la Web y nuevo Outlook en Windows, el |
| add |
Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita. El método Después, puede usar el identificador con el método Si el complemento de Office se ejecuta en Outlook en la Web y nuevo Outlook en Windows, el |
| load |
Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado. Las propiedades personalizadas se almacenan como pares clave-valor por aplicación y por elemento. Este método devuelve un objeto CustomProperties en la devolución de llamada, que proporciona métodos para acceder a las propiedades personalizadas específicas del elemento actual y del complemento actual. Las propiedades personalizadas no se cifran en el elemento, por lo que no se debe usar como almacenamiento seguro. Las propiedades personalizadas se proporcionan como un objeto |
| remove |
Quita los datos adjuntos de un mensaje o cita. El método |
| remove |
Quita los datos adjuntos de un mensaje o cita. El método |
Detalles de las propiedades
body
Obtiene un objeto que proporciona métodos para manipular el cuerpo de un elemento.
body: Body;
Valor de propiedad
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Organizador de citas
Ejemplos
// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
"text",
{ asyncContext: "This is passed to the callback" },
function callback(result) {
// Do something with the result.
});
// The following is an example of an object that is passed as the result parameter to the callback function.
{
"value": "TEXT of whole body (including threads below)",
"status": "succeeded",
"asyncContext": "This is passed to the callback"
}
end
Obtiene o establece la fecha y la hora de finalización de la cita.
La end propiedad es un objeto Time expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor de propiedad end en la fecha y hora locales del cliente.
Si usa el método Time.setAsync para establecer la hora de finalización, use el método convertToUtcClientTime para convertir la hora local del cliente en un valor UTC para el servidor.
Importante: En el cliente de Windows, no puede usar esta propiedad para actualizar el final de una periodicidad.
end: Time;
Valor de propiedad
Comentarios
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Organizador de citas
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-end-appointment-organizer.yaml
Office.context.mailbox.item.end.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
const time = result.value;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});
...
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}`);
});
});
itemType
Obtiene el tipo de elemento que representa una instancia.
La propiedad itemType devuelve uno de los valores de enumeración de ItemType, lo que indica si la instancia del objeto item es un mensaje o una cita.
itemType: MailboxEnums.ItemType | string;
Valor de propiedad
Office.MailboxEnums.ItemType | string
Comentarios
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Organizador de citas
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-item-type.yaml
const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
case Office.MailboxEnums.ItemType.Appointment:
console.log(`Current item is an ${itemType}.`);
break;
case Office.MailboxEnums.ItemType.Message:
console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
break;
}
location
Obtiene o establece la ubicación de una cita. La location propiedad devuelve un objeto Location que proporciona métodos que se usan para obtener y establecer la ubicación de la cita.
location: Location;
Valor de propiedad
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Organizador de citas
Importante: La enhancedLocation propiedad se introdujo en el conjunto de requisitos de buzón 1.8. Use la enhancedLocation propiedad para identificar y administrar mejor las ubicaciones de citas, especialmente si necesita determinar el tipo de ubicación. Para obtener instrucciones sobre cómo seleccionar la API de ubicación adecuada para su escenario, vea Obtener o establecer la ubicación al redactar un designador en Outlook.
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml
Office.context.mailbox.item.location.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment location: ${result.value}`);
});
...
const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set location to ${location}`);
});
optionalAttendees
Proporciona acceso a los asistentes opcionales de un evento. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.
La propiedad optionalAttendees devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los asistentes opcionales a una reunión. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.
optionalAttendees: Recipients;
Valor de propiedad
Comentarios
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Organizador de citas
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-optional-attendees-appointment-organizer.yaml
Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const apptOptionalAttendees = asyncResult.value;
for (let i = 0; i < apptOptionalAttendees.length; i++) {
console.log(
"Optional attendees: " +
apptOptionalAttendees[i].displayName +
" (" +
apptOptionalAttendees[i].emailAddress +
") - response: " +
apptOptionalAttendees[i].appointmentResponse
);
}
} else {
console.error(asyncResult.error);
}
});
...
const email = (document.getElementById("emailOptional") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Succeeded in setting optional attendees field.");
} else {
console.error(asyncResult.error);
}
});
requiredAttendees
Proporciona acceso a los asistentes necesarios de un evento. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.
La propiedad requiredAttendees devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los asistentes obligatorios a una reunión. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.
requiredAttendees: Recipients;
Valor de propiedad
Comentarios
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Organizador de citas
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-required-attendees-appointment-organizer.yaml
Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
const apptRequiredAttendees = asyncResult.value;
for (let i = 0; i < apptRequiredAttendees.length; i++) {
console.log(
"Required attendees: " +
apptRequiredAttendees[i].displayName +
" (" +
apptRequiredAttendees[i].emailAddress +
") - response: " +
apptRequiredAttendees[i].appointmentResponse
);
}
} else {
console.error(asyncResult.error);
}
});
...
const email = (document.getElementById("emailRequired") as HTMLInputElement).value;
const emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
console.log("Succeeded in setting required attendees field.");
} else {
console.error(asyncResult.error);
}
});
start
Obtiene o establece la fecha y la hora de inicio de la cita.
La start propiedad es un objeto Time expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor en la fecha y hora locales del cliente.
Si usa el método Time.setAsync para establecer la hora de inicio, use el método convertToUtcClientTime para convertir la hora local del cliente en un valor UTC para el servidor.
Importante: En el cliente de Windows, no puede usar esta propiedad para actualizar el inicio de una periodicidad.
start: Time;
Valor de propiedad
Comentarios
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Organizador de citas
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;
}
const time = result.value;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});
...
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}`);
});
subject
Obtiene o establece la descripción que se muestra en el campo de asunto de un elemento.
La propiedad subject obtiene o establece el asunto completo del elemento, como lo ha enviado el servidor de correo electrónico.
La propiedad subject devuelve un objeto Subject que proporciona métodos para obtener y establecer el asunto.
subject: Subject;
Valor de propiedad
Comentarios
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Organizador de citas
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-subject-compose.yaml
Office.context.mailbox.item.subject.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Subject: ${result.value}`);
});
...
let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Successfully set subject to ${subject}`);
});
Detalles del método
addFileAttachmentAsync(uri, attachmentName, options, callback)
Agrega un archivo a un mensaje o cita como datos adjuntos.
El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.
addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Parámetros
- uri
-
string
El URI que proporciona la ubicación del archivo que se va a adjuntar al mensaje o a la cita. La longitud máxima es de 2048 caracteres.
- attachmentName
-
string
El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.
- options
-
Office.AsyncContextOptions & { isInline: boolean }
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.
isInline
: si es true, indica que los datos adjuntos se mostrarán en línea como una imagen en el cuerpo del mensaje y no se mostrarán en la lista de datos adjuntos.
- callback
-
(asyncResult: Office.AsyncResult<string>) => 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 se realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error en la carga de los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del error.
Devoluciones
void
Comentarios
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Organizador de citas
Importante:
Este método no se admite en Outlook en iOS o Android. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
Las imágenes de mapa de bits (BMP) no se admiten si se agregan como datos adjuntos insertados.
En las compilaciones recientes de Outlook clásico en Windows, se introdujo un error que anexa incorrectamente un
Authorization: Bearerencabezado a esta acción (ya sea mediante esta API o la interfaz de usuario de Outlook). Para solucionar este problema, use la API introducida con eladdFileAttachmentFromBase64conjunto de requisitos 1.8.El URI del archivo que se va a adjuntar debe admitir el almacenamiento en caché en producción. El servidor que hospeda la imagen no debe devolver un
Cache-Controlencabezado que especifiqueno-cache,no-storeo opciones similares en la respuesta HTTP. Sin embargo, al desarrollar el complemento y realizar cambios en los archivos, el almacenamiento en caché puede impedir que vea los cambios. Se recomienda usarCache-Controlencabezados durante el desarrollo.Puede usar el mismo URI con el
removeAttachmentAsyncmétodo para quitar los datos adjuntos en la misma sesión.
Errores:
AttachmentSizeExceeded: los datos adjuntos son mayores de lo permitido.FileTypeNotSupported: los datos adjuntos tienen una extensión que no está permitida.NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
const attachmentUrl = (document.getElementById("attachmentUrl") as HTMLInputElement).value;
Office.context.mailbox.item.addFileAttachmentAsync(
attachmentUrl,
getFileName(attachmentUrl),
{ isInline: false },
(result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.log(`Failed to add attachment: ${result.error.message}.`);
return;
}
console.log(`Added attachment with ID: ${result.value}`);
}
);
addFileAttachmentAsync(uri, attachmentName, callback)
Agrega un archivo a un mensaje o cita como datos adjuntos.
El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.
addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Parámetros
- uri
-
string
El URI que proporciona la ubicación del archivo que se va a adjuntar al mensaje o a la cita. La longitud máxima es de 2048 caracteres.
- attachmentName
-
string
El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.
- callback
-
(asyncResult: Office.AsyncResult<string>) => 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 se realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error en la carga de los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del error.
Devoluciones
void
Comentarios
Nivel mínimo de permiso: elemento de lectura y escritura
Modo de Outlook aplicable: Organizador de citas
Importante:
Este método no se admite en Outlook en iOS o Android. Para obtener más información sobre las API admitidas en Outlook mobile, vea API de JavaScript de Outlook compatibles con Outlook en dispositivos móviles.
Las imágenes de mapa de bits (BMP) no se admiten si se agregan como datos adjuntos insertados.
En las compilaciones recientes de Outlook clásico en Windows, se introdujo un error que anexa incorrectamente un
Authorization: Bearerencabezado a esta acción (ya sea mediante esta API o la interfaz de usuario de Outlook). Para solucionar este problema, use la API introducida con eladdFileAttachmentFromBase64conjunto de requisitos 1.8.El URI del archivo que se va a adjuntar debe admitir el almacenamiento en caché en producción. El servidor que hospeda la imagen no debe devolver un
Cache-Controlencabezado que especifiqueno-cache,no-storeo opciones similares en la respuesta HTTP. Sin embargo, al desarrollar el complemento y realizar cambios en los archivos, el almacenamiento en caché puede impedir que vea los cambios. Se recomienda usarCache-Controlencabezados durante el desarrollo.Puede usar el mismo URI con el
removeAttachmentAsyncmétodo para quitar los datos adjuntos en la misma sesión.
Errores:
AttachmentSizeExceeded: los datos adjuntos son mayores de lo permitido.FileTypeNotSupported: los datos adjuntos tienen una extensión que no está permitida.NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.
addItemAttachmentAsync(itemId, attachmentName, options, callback)
Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita.
El método addItemAttachmentAsync asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, asyncResult, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el options parámetro para pasar información de estado a la función de devolución de llamada, si es necesario.
Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.
Si el complemento de Office se ejecuta en Outlook en la Web y nuevo Outlook en Windows, el addItemAttachmentAsync método puede adjuntar elementos a elementos distintos del elemento que está editando. Sin embargo, esto no se admite y no se recomienda.
addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Parámetros
- itemId
-
any
El identificador de Exchange del elemento que debe adjuntarse. La longitud máxima es de 100 caracteres.
- attachmentName
-
string
El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.
- 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<string>) => void
Opcional. 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. Si se realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error al agregar los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del 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: Organizador de citas
Errores:
-
NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.
Ejemplos
// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
// EWS ID of item to attach (shortened for readability).
const itemId = "AAMkADI1...AAA=";
// The values in asyncContext can be accessed in the callback.
const options = { asyncContext: { var1: 1, var2: 2 } };
Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.error("Failed to add attachment: " + result.error.message);
return;
}
console.log("Attachment added successfully.");
console.log("var1: " + result.asyncContext.var1);
console.log("var2: " + result.asyncContext.var2);
});
}
addItemAttachmentAsync(itemId, attachmentName, callback)
Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita.
El método addItemAttachmentAsync asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, asyncResult, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el options parámetro para pasar información de estado a la función de devolución de llamada, si es necesario.
Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.
Si el complemento de Office se ejecuta en Outlook en la Web y nuevo Outlook en Windows, el addItemAttachmentAsync método puede adjuntar elementos a elementos distintos del elemento que está editando. Sin embargo, esto no se admite y no se recomienda.
addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;
Parámetros
- itemId
-
any
El identificador de Exchange del elemento que debe adjuntarse. La longitud máxima es de 100 caracteres.
- attachmentName
-
string
El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.
- callback
-
(asyncResult: Office.AsyncResult<string>) => void
Opcional. 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. Si se realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error al agregar los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del 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: Organizador de citas
Errores:
-
NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.
loadCustomPropertiesAsync(callback, userContext)
Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado.
Las propiedades personalizadas se almacenan como pares clave-valor por aplicación y por elemento. Este método devuelve un objeto CustomProperties en la devolución de llamada, que proporciona métodos para acceder a las propiedades personalizadas específicas del elemento actual y del complemento actual. Las propiedades personalizadas no se cifran en el elemento, por lo que no se debe usar como almacenamiento seguro.
Las propiedades personalizadas se proporcionan como un objeto CustomProperties en la propiedad asyncResult.value. Este objeto se puede usar para obtener, establecer, guardar y quitar propiedades personalizadas del elemento de correo.
loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;
Parámetros
- callback
-
(asyncResult: Office.AsyncResult<Office.CustomProperties>) => 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.
- userContext
-
any
Opcional. Los desarrolladores pueden proporcionar cualquier objeto al que quieran obtener acceso en la función de devolución de llamada. A este objeto se puede acceder mediante la propiedad asyncResult.asyncContext en la función de devolución de llamada.
Devoluciones
void
Comentarios
[ Conjunto de API: Buzón 1.1 ]
Para obtener más información sobre las propiedades personalizadas, vea Obtener y establecer metadatos de complemento para un complemento de Outlook.
Nivel mínimo de permiso: elemento de lectura
Modo de Outlook aplicable: Organizador de citas
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml
Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
return;
}
customProps = result.value;
console.log("Loaded the CustomProperties object.");
});
removeAttachmentAsync(attachmentId, options, callback)
Quita los datos adjuntos de un mensaje o cita.
El método removeAttachmentAsync quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la Web, en dispositivos móviles y en la nueva Outlook en Windows, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.
removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parámetros
- attachmentId
-
string
El identificador de los datos adjuntos para quitar. La longitud máxima de la attachmentId cadena es de 200 caracteres en Outlook en la Web y en Windows (nuevo y clásico).
- 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 se produce un error en la eliminación de los datos adjuntos, la propiedad asyncResult.error contendrá un código de error con el motivo del 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: Organizador de citas
Importante*: El removeAttachmentAsync método no quita los datos adjuntos insertados de un elemento de correo. Para quitar los datos adjuntos insertados, primero obtenga el cuerpo del elemento y, a continuación, quite las referencias de los datos adjuntos de su contenido. Use las API de Office.Body para obtener y establecer el cuerpo de un elemento.
Errores:
-
InvalidAttachmentId: el identificador de datos adjuntos no existe.
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml
Office.context.mailbox.item.removeAttachmentAsync(
(document.getElementById("attachmentId") as HTMLInputElement).value,
(result) => {
if (result.status === Office.AsyncResultStatus.Failed) {
console.error(result.error.message);
return;
}
console.log(`Attachment removed successfully.`);
}
);
removeAttachmentAsync(attachmentId, callback)
Quita los datos adjuntos de un mensaje o cita.
El método removeAttachmentAsync quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la Web, en dispositivos móviles y en la nueva Outlook en Windows, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.
removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;
Parámetros
- attachmentId
-
string
El identificador de los datos adjuntos para quitar. La longitud máxima de la attachmentId cadena es de 200 caracteres en Outlook en la Web y en Windows (nuevo y clásico).
- 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 se produce un error en la eliminación de los datos adjuntos, la propiedad asyncResult.error contendrá un código de error con el motivo del 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: Organizador de citas
Importante*: El removeAttachmentAsync método no quita los datos adjuntos insertados de un elemento de correo. Para quitar los datos adjuntos insertados, primero obtenga el cuerpo del elemento y, a continuación, quite las referencias de los datos adjuntos de su contenido. Use las API de Office.Body para obtener y establecer el cuerpo de un elemento.
Errores:
-
InvalidAttachmentId: el identificador de datos adjuntos no existe.