Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
El subconjunto de API de complementos de Outlook de la API de JavaScript de Office incluye objetos, métodos, propiedades y eventos que puede usar en un complemento de Outlook.
Nota:
Esta documentación es para un conjunto de requisitos que no sea el último conjunto de requisitos.
Novedades de la versión 1.8
El conjunto de requisitos del buzón 1.8 incluye todas las características del conjunto de requisitos 1.7. Se han agregado las siguientes características.
- Se han agregado métodos para obtener el contenido de los datos adjuntos u obtener todos los datos adjuntos de un elemento en modo de redacción. Para obtener más información, vea Administrar los datos adjuntos de un elemento en un formulario de redacción en Outlook.
- Se ha agregado un método para agregar un archivo como datos adjuntos mediante una cadena codificada en base64.
- Se han agregado propiedades y métodos para administrar categorías en elementos y en la lista maestra de categorías del buzón.
- Se ha agregado compatibilidad con escenarios de acceso delegado , incluido un método para obtener propiedades compartidas y un elemento de manifiesto para habilitar complementos en carpetas compartidas.
- Se ha agregado un objeto para administrar el conjunto de ubicaciones en una cita. Para obtener más información, consulte Obtener o establecer la ubicación al redactar una cita en Outlook.
- Se ha agregado un objeto para obtener y establecer encabezados de Internet personalizados en un elemento de mensaje en modo de redacción.
- Se ha agregado un método para obtener todos los encabezados de Internet en un elemento de mensaje en modo lectura.
- Se ha agregado un método para obtener los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable.
- Se ha agregado un método para obtener el id. de una cita o un elemento de mensaje guardado.
- Se ha agregado un parámetro opcional
optionsa la llamada para cancelar laevent.completedejecución de un evento. - Se agregaron eventos que se producen cuando se agrega o quita un archivo adjunto y cuando se cambia la ubicación de la cita.
Lista de API
En la tabla siguiente se enumeran las API introducidas en el conjunto de requisitos de buzón 1.8. Para ver la documentación de referencia de API para todas las API admitidas por el conjunto de requisitos de buzón 1.8 o anteriores, consulte API de Outlook.
| Clase | Campos | Descripción |
|---|---|---|
| AppointmentCompose | addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un archivo a un mensaje o cita como datos adjuntos. |
| addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un archivo a un mensaje o cita como datos adjuntos. | |
| categorías | Obtiene un objeto que proporciona métodos para administrar las categorías del elemento. | |
| enhancedLocation | Obtiene o establece las ubicaciones de la cita. | |
| getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto. |
|
| getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto. |
|
| getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) | Obtiene los datos adjuntos del elemento como una matriz. | |
| getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) | Obtiene los datos adjuntos del elemento como una matriz. | |
| getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable. | |
| getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable. | |
| getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene de forma asincrónica el identificador de elemento de los servicios Web Exchange (EWS) | |
| getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: cadena> Office.AsyncResult<) => void) | Obtiene de forma asincrónica el identificador de elemento de los servicios Web Exchange (EWS) | |
| getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido. | |
| getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido. | |
| AppointmentRead | categorías | Obtiene un objeto que proporciona métodos para administrar las categorías del elemento. |
| enhancedLocation | Obtiene las ubicaciones de una cita. | |
| getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto. |
|
| getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto. |
|
| getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable. | |
| getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable. | |
| getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido. | |
| getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido. | |
| AttachmentContent | content | El contenido de un adjunto como una cadena. |
| format | El formato de cadena que se va a usar para el contenido de los datos adjuntos. | |
| AttachmentDetailsCompose | attachmentType | Obtiene un valor que indica el tipo de datos adjuntos. |
| id | Obtiene el identificador de un dato adjunto. | |
| isInline | Obtiene un valor que indica si los datos adjuntos aparecen como una imagen en el cuerpo del elemento en lugar de en la lista de datos adjuntos. | |
| isServiceAccessible | En Outlook en la Web y en el nuevo Outlook en Windows, indica si un dato adjunto insertado en un mensaje se ha cargado en el servidor y se le ha asignado un Id. de servicios Web Exchange (EWS). | |
| name | Obtiene el nombre de los datos adjuntos | |
| size | Obtiene el tamaño de los datos adjuntos en bytes. | |
| url | Obtiene la dirección URL de los datos adjuntos, si su tipo es MailboxEnums.AttachmentType.Cloud. |
|
| AttachmentsChangedEventArgs | attachmentDetails | Obtiene el objeto que representa los datos adjuntos que se agregaron o quitaron de |
| attachmentStatus | Especifica si el dato adjunto se agregó o quitó de un elemento de correo. | |
| type | Obtiene el tipo de evento que se generó. | |
| Categories | addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega categorías a un elemento. |
| addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega categorías a un elemento. | |
| getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) | Obtiene las categorías de un artículo. | |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) | Obtiene las categorías de un artículo. | |
| removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita las categorías de un elemento. | |
| removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita las categorías de un elemento. | |
| CategoryDetails | color | El color de la categoría. |
| displayName | Nombre de la categoría. | |
| EnhancedLocation | addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Se suma al conjunto de ubicaciones asociadas a la cita. |
| addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Se suma al conjunto de ubicaciones asociadas a la cita. | |
| getAsync(callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void) | Obtiene el conjunto de ubicaciones asociadas a la cita. | |
| getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<LocationDetails[]>) => void) | Obtiene el conjunto de ubicaciones asociadas a la cita. | |
| removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita el conjunto de ubicaciones asociadas a la cita. | |
| removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita el conjunto de ubicaciones asociadas a la cita. | |
| EnhancedLocationsChangedEventArgs | enhancedLocations | Obtiene el conjunto de ubicaciones mejoradas. |
| type | Obtiene el tipo del evento. | |
| InternetHeaders | getAsync(names: string[], callback: (asyncResult: Registro Office.AsyncResult<string, string>>) => void)< | Dada una matriz de nombres de encabezado de Internet, este método devuelve un registro que contiene esos encabezados de Internet y sus valores. |
| getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Registro Office.AsyncResult<string, string>>) => void)< | Dada una matriz de nombres de encabezado de Internet, este método devuelve un registro que contiene esos encabezados de Internet y sus valores. | |
| removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Dada una matriz de nombres de encabezado de Internet, este método quita los encabezados especificados de la colección de encabezados de Internet. | |
| removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Dada una matriz de nombres de encabezado de Internet, este método quita los encabezados especificados de la colección de encabezados de Internet. | |
| setAsync(headers: Record<string, string>, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece los encabezados de Internet especificados en los valores especificados. | |
| setAsync(headers: Record<string, string>, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Establece los encabezados de Internet especificados en los valores especificados. | |
| LocationDetails | displayName | El nombre para mostrar de la ubicación. |
| emailAddress | La dirección de correo electrónico asociada con la ubicación. | |
| locationIdentifier | El LocationIdentifier de la ubicación. |
|
| LocationIdentifier | id | Id. exclusivo de la ubicación. |
| type | El tipo de ubicación. | |
| Buzón | masterCategories | Obtiene un objeto que proporciona métodos para administrar la lista maestra de categorías asociada a un buzón. |
| MasterCategories | addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega categorías a la lista maestra de un buzón. |
| addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Agrega categorías a la lista maestra de un buzón. | |
| getAsync(callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) | Obtiene la lista maestra de categorías de un buzón. | |
| getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<CategoryDetails[]>) => void) | Obtiene la lista maestra de categorías de un buzón. | |
| removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita categorías de la lista maestra de un buzón. | |
| removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void) | Quita categorías de la lista maestra de un buzón. | |
| MessageCompose | addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un archivo a un mensaje o cita como datos adjuntos. |
| addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Agrega un archivo a un mensaje o cita como datos adjuntos. | |
| categorías | Obtiene un objeto que proporciona métodos para administrar las categorías del elemento. | |
| getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto. |
|
| getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto. |
|
| getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) | Obtiene los datos adjuntos del elemento como una matriz. | |
| getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentDetailsCompose[]>) => void) | Obtiene los datos adjuntos del elemento como una matriz. | |
| getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable. | |
| getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable. | |
| getItemIdAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene de forma asincrónica el identificador de elemento de los servicios Web Exchange (EWS) | |
| getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: cadena> Office.AsyncResult<) => void) | Obtiene de forma asincrónica el identificador de elemento de los servicios Web Exchange (EWS) | |
| getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido. | |
| getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido. | |
| internetHeaders | Obtiene o establece los encabezados de Internet personalizados de un mensaje. | |
| MessageRead | categorías | Obtiene un objeto que proporciona métodos para administrar las categorías del elemento. |
| getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene todos los encabezados de Internet del mensaje como una cadena. | |
| getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene todos los encabezados de Internet del mensaje como una cadena. | |
| getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto. |
|
| getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<AttachmentContent>) => void) | Obtiene un archivo adjunto de un mensaje o cita y lo devuelve como un AttachmentContent objeto. |
|
| getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable. | |
| getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<string>) => void) | Obtiene los datos de inicialización pasados cuando el complemento se activa mediante un mensaje accionable. | |
| getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido. | |
| getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<SharedProperties>) => void) | Obtiene las propiedades de una cita o un mensaje en una carpeta compartida o un buzón compartido. | |
| AttachmentContentFormat | Base 64 | El contenido de los datos adjuntos se devuelve como una cadena codificada en base64. |
| Eml | El contenido de los datos adjuntos se devuelve como una cadena que representa un archivo con formato de .eml. | |
| ICalendar | El contenido de los datos adjuntos se devuelve como una cadena que representa un archivo con formato .icalendar. | |
| Url | El contenido de los datos adjuntos se devuelve como una cadena que representa una dirección URL. | |
| AttachmentStatus | Se agregó | Se ha agregado un archivo adjunto al elemento. |
| Eliminación | Se han quitado datos adjuntos del elemento. | |
| CategoryColor | Ninguno | Color predeterminado o sin color asignado. |
| Preset0 | Rojo | |
| Preset1 | Naranja | |
| Preset10 | Acero | |
| Preset11 | Acero oscuro | |
| Preset12 | Gris | |
| Preset13 | Gris oscuro | |
| Preset14 | Negro | |
| Preset15 | Rojo oscuro | |
| Preset16 | Anaranjado oscuro | |
| Preset17 | Marrón oscuro | |
| Preset18 | Amarillo oscuro | |
| Preset19 | Verde oscuro | |
| Preset2 | Marrón | |
| Preset20 | Verde azulado oscuro | |
| Preset21 | Oliva oscuro | |
| Preset22 | Azul oscuro | |
| Preset23 | Púrpura oscuro | |
| Preset24 | Arándano oscuro | |
| Preset3 | Amarillo | |
| Preset4 | Verde | |
| Preset5 | Verde azulado | |
| Preset6 | Oliva | |
| Preset7 | Azul | |
| Preset8 | Púrpura | |
| Preset9 | Arándano | |
| DelegatePermissions | DeleteAll | El delegado tiene permiso para eliminar cualquier elemento. |
| DeleteOwn | El delegado tiene permiso para eliminar solo los elementos que creó. | |
| Editar todo | El delegado tiene permiso para editar cualquier elemento. | |
| EditOwn | El delegado tiene permiso para editar solo los elementos que creó. | |
| Lectura | El delegado tiene permiso para leer los elementos. | |
| Escritura | El delegado tiene permiso para crear y escribir elementos. | |
| LocationType | Personalizado | Una ubicación personalizada. |
| Sala | Una sala de conferencias o un recurso similar que tenga una dirección SMTP. | |
| SharedProperties | delegatePermissions | Los permisos que tiene el delegado en una carpeta compartida o que el usuario tiene en un buzón compartido. |
| owner | La dirección de correo electrónico del propietario de un elemento compartido. | |
| targetMailbox | Ubicación del buzón del propietario para el acceso del delegado. | |
| targetRestUrl | La dirección URL base de la API de REST (actualmente https://outlook.office.com/api). |
Eventos
En la tabla siguiente se enumeran los eventos introducidos en el conjunto de requisitos 1.8. Para obtener una lista de todos los eventos admitidos que se pueden controlar con los addHandlerAsync métodos and removeHandlerAsync , vea Office.EventType.
| Evento | Descripción | Object |
|---|---|---|
| AttachmentsChanged | Se ha agregado o quitado datos adjuntos de un elemento. | Elemento |
| EnhancedLocationsChanged | Se cambió la ubicación de la cita. | Elemento |
Actualizaciones de manifiestos
En la tabla siguiente se enumeran las actualizaciones de manifiestos introducidas en el conjunto de requisitos de buzón 1.8. Para obtener más información sobre los tipos de manifiestos de complementos de Office, vea Manifiesto de complementos de Office.
| Característica | Manifiesto unificado para Microsoft 365 | Manifiesto de solo complemento | Descripción |
|---|---|---|---|
| Compatibilidad con carpetas compartidas |
"authorization.permissions.resourceSpecific.name" Establecer en "Mailbox.SharedFolder" |
SupportsSharedFolders | Define si el complemento está disponible en escenarios de carpetas compartidas. |
Vea también
Colaborar con nosotros en GitHub
El origen de este contenido se puede encontrar en GitHub, donde también puede crear y revisar problemas y solicitudes de incorporación de cambios. Para más información, consulte nuestra guía para colaboradores.