Office.DisplayedBody interface

  • Référence
Paquet:
outlook

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Fournit une méthode pour définir temporairement le contenu affiché dans le corps d’un message en mode lecture.

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Lecture du message

Méthodes

setAsync(data, options, callback)

Définit temporairement le contenu affiché dans le corps d’un message en mode lecture. Le contenu défini reste visible jusqu’à ce que l’utilisateur bascule vers un autre message ou ferme la fenêtre du message actuel.
setAsync(data, callback)

Définit temporairement le contenu affiché dans le corps d’un message en mode lecture. Le contenu défini reste visible jusqu’à ce que l’utilisateur bascule vers un autre message ou ferme la fenêtre du message actuel.

Détails de la méthode

setAsync(data, options, callback)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Définit temporairement le contenu affiché dans le corps d’un message en mode lecture. Le contenu défini reste visible jusqu’à ce que l’utilisateur bascule vers un autre message ou ferme la fenêtre du message actuel.

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

Paramètres

data

string

Chaîne à afficher temporairement dans le corps d’un message. Elle est limitée à un million de caractères.

options

Office.AsyncContextOptions & Office.CoercionTypeOptions

Littéral d’objet qui contient une ou plusieurs des propriétés suivantes : les asyncContextdéveloppeurs peuvent fournir n’importe quel objet auquel ils souhaitent accéder dans la fonction de rappel. coercionType: format des données à afficher temporairement. La chaîne du paramètre data est convertie dans ce format.

callback

(asyncResult: Office.AsyncResult<void>) => void

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet . Les erreurs rencontrées seront indiquées dans la propriété asyncResult.error.

Retours

void

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Lecture du message

Recommandé : appelez Office.context.mailbox.item.body.getTypeAsync, puis passez la valeur retournée au options.coercionType paramètre .

Important:

  • Si plusieurs compléments qui implémentent setAsync s’exécutent simultanément, le contenu défini par le dernier complément qui termine l’opération setAsync s’affiche dans le corps.

  • Le contenu défini par la setAsync méthode s’affiche uniquement lorsque l’utilisateur affiche l’élément. Il n’est pas mis en cache dans Outlook et ne se synchronise pas avec d’autres clients Outlook.

  • Si vous enregistrez un message après avoir appelé setAsync, le contenu d’origine du corps du message s’affiche dans l’élément enregistré.

  • La setAsync méthode n’est pas prise en charge sur plusieurs messages sélectionnés.

setAsync(data, callback)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Définit temporairement le contenu affiché dans le corps d’un message en mode lecture. Le contenu défini reste visible jusqu’à ce que l’utilisateur bascule vers un autre message ou ferme la fenêtre du message actuel.

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

Paramètres

data

string

Chaîne à afficher temporairement dans le corps d’un message. Elle est limitée à un million de caractères.

callback

(asyncResult: Office.AsyncResult<void>) => void

Facultatif. Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre, asyncResult, qui est un Office.AsyncResult objet . Les erreurs rencontrées seront indiquées dans la propriété asyncResult.error.

Retours

void

Remarques

[ Ensemble d’API : préversion de boîte aux lettres ]

Niveau d’autorisation minimal : élément en lecture/écriture

Mode Outlook applicable : Lecture du message

Important:

  • Si plusieurs compléments qui implémentent setAsync s’exécutent simultanément, le contenu défini par le dernier complément qui termine l’opération setAsync s’affiche dans le corps.

  • Le contenu défini par la setAsync méthode s’affiche uniquement lorsque l’utilisateur affiche l’élément. Il n’est pas mis en cache dans Outlook et ne se synchronise pas avec d’autres clients Outlook.

  • Si vous enregistrez un message après avoir appelé setAsync, le contenu d’origine du corps du message s’affiche dans l’élément enregistré.

  • La setAsync méthode n’est pas prise en charge sur plusieurs messages sélectionnés.

Exemples

// 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.");
});