Compartir a través de

Office.DisplayedBody interface

  • Referencia
Paquete:
outlook

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 un método para establecer temporalmente el contenido mostrado en el cuerpo de un mensaje en modo de lectura.

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

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

Modo de Outlook aplicable: Lectura de mensajes

Métodos

setAsync(data, options, callback)

Establece temporalmente el contenido que se muestra en el cuerpo de un mensaje en modo de lectura. El contenido del conjunto permanece visible hasta que el usuario cambia a un mensaje diferente o cierra la ventana del mensaje actual.
setAsync(data, callback)

Establece temporalmente el contenido que se muestra en el cuerpo de un mensaje en modo de lectura. El contenido del conjunto permanecerá visible hasta que el usuario cambie a otro mensaje o cierre la ventana del mensaje actual.

Detalles del método

setAsync(data, 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 temporalmente el contenido que se muestra en el cuerpo de un mensaje en modo de lectura. El contenido del conjunto permanece visible hasta que el usuario cambia a un mensaje diferente o cierra la ventana del mensaje actual.

setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Parámetros

data

string

Cadena que se mostrará temporalmente en el cuerpo de un mensaje. La cadena está limitada a 1 000 000 caracteres.

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

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. coercionType: formato de los datos que se mostrarán temporalmente. La cadena del parámetro data se convertirá a este formato.

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 . Cualquier error que se detecte se proporcionará en la propiedad asyncResult.error.

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

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

Modo de Outlook aplicable: Lectura de mensajes

Recomendado: llame a Office.context.mailbox.item.body.getTypeAsync y, a continuación, pase el valor devuelto al options.coercionType parámetro .

Importante:

  • Si varios complementos que implementan setAsync se ejecutan simultáneamente, el contenido establecido por el último complemento que completa la setAsync operación se muestra en el cuerpo.

  • El contenido establecido por el setAsync método solo se muestra mientras el usuario está viendo el elemento. No se almacena en caché en Outlook y no se sincroniza con otros clientes de Outlook.

  • Si guarda un mensaje después de llamar a setAsync, el contenido original del cuerpo del mensaje aparece en el elemento guardado.

  • El setAsync método no se admite en varios mensajes seleccionados.

setAsync(data, 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 temporalmente el contenido que se muestra en el cuerpo de un mensaje en modo de lectura. El contenido del conjunto permanecerá visible hasta que el usuario cambie a otro mensaje o cierre la ventana del mensaje actual.

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

Parámetros

data

string

Cadena que se mostrará temporalmente en el cuerpo de un mensaje. La cadena está limitada a 1 000 000 caracteres.

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 . Cualquier error que se detecte se proporcionará en la propiedad asyncResult.error.

Devoluciones

void

Comentarios

[ Conjunto de API: versión preliminar del buzón ]

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

Modo de Outlook aplicable: Lectura de mensajes

Importante:

  • Si varios complementos que implementan setAsync se ejecutan simultáneamente, el contenido establecido por el último complemento que completa la setAsync operación se muestra en el cuerpo.

  • El contenido establecido por el setAsync método solo se muestra mientras el usuario está viendo el elemento. No se almacena en caché en Outlook y no se sincroniza con otros clientes de Outlook.

  • Si guarda un mensaje después de llamar a setAsync, el contenido original del cuerpo del mensaje aparece en el elemento guardado.

  • El setAsync método no se admite en varios mensajes seleccionados.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/99-preview-apis/set-displayed-body-subject.yaml

// This snippet temporarily sets the content displayed in the body of a message in read mode.
// The set content will remain visible until the user switches to a different message in the Reading Pane or closes the window of the current message.
const bodyText = $("#body-text-field")
  .val()
  .toString();
Office.context.mailbox.item.display.body.setAsync(bodyText, (asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(`Action failed with error: ${asyncResult.error.message}`);
    return;
  }

  console.log("Temporarily set the content displayed in the body.");
});