Office.SessionData interface

Paquet:: outlook

Fournit des méthodes pour gérer les données de session d’un élément.

Les données de session sont spécifiques à un seul élément de courrier. Il n’est pas partagé entre plusieurs éléments, même si le même complément est utilisé pour définir ou récupérer des données.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Compose

Important : pour chaque élément de courrier, l’objet SessionData entier est limité à 50 000 caractères par complément.

Méthodes

clearAsync(options, callback)	Efface toutes les paires clé-valeur des données de session.
clearAsync(callback)	Efface toutes les paires clé-valeur des données de session.
getAllAsync(callback)	Obtient toutes les paires clé-valeur des données de session.
getAsync(name, callback)	Obtient la valeur des données de session de la clé spécifiée.
removeAsync(name, options, callback)	Supprime une paire clé-valeur de données de session.
removeAsync(name, callback)	Supprime une paire clé-valeur de données de session.
setAsync(name, value, options, callback)	Définit une paire clé-valeur de données de session.
setAsync(name, value, callback)	Définit une paire clé-valeur de données de session.

Détails de la méthode

clearAsync(options, callback)

Efface toutes les paires clé-valeur des données de session.

clearAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

options: Office.AsyncContextOptions

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.

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 .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

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

Mode Outlook applicable : Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.clearAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("sessionData.clearAsync succeeded");
  } else {
    console.log("Failed to clear sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

clearAsync(callback)

Efface toutes les paires clé-valeur des données de session.

clearAsync(callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

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 .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

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

Mode Outlook applicable : Compose

getAllAsync(callback)

Obtient toutes les paires clé-valeur des données de session.

getAllAsync(callback: (asyncResult: Office.AsyncResult<object>) => void): void;

Paramètres

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

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 .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

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

Mode Outlook applicable : Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAllAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get all sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

getAsync(name, callback)

Obtient la valeur des données de session de la clé spécifiée.

getAsync(name: string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Paramètres

name: string

Clé de données de session.

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

Une fois la méthode terminée, la fonction passée dans le callback paramètre est appelée avec un seul paramètre de type Office.AsyncResult.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.getAsync(
  "Date",
  function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("The sessionData value is " + JSON.stringify(asyncResult.value));
  } else {
    console.log("Failed to get sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

removeAsync(name, options, callback)

Supprime une paire clé-valeur de données de session.

removeAsync(name: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

name: string

Clé de données de session.

options: Office.AsyncContextOptions

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 .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

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

Mode Outlook applicable : Compose

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.removeAsync(
  "Date",
  function callback(asyncResult) {
    if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
      console.log("sessionData.removeAsync succeeded");
    } else {
      console.log("Failed to remove sessionData. Error: " + JSON.stringify(asyncResult.error));
    }
  }
);

removeAsync(name, callback)

Supprime une paire clé-valeur de données de session.

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

Paramètres

name: string

Clé de données de session.

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 .

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

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

Mode Outlook applicable : Compose

setAsync(name, value, options, callback)

Définit une paire clé-valeur de données de session.

setAsync(name: string, value: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<void>) => void): void;

Paramètres

name: string

Clé de données de session.

value: string

Valeur des données de session sous forme de chaîne.

options: Office.AsyncContextOptions

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 de type Office.AsyncResult.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Compose

Important : Dans les clients Outlook qui prennent en charge la boîte aux lettres 1.15 ou une version antérieure, l’ensemble de l’objet SessionData pour chaque élément de courrier est limité à 50 000 caractères par complément. Dans Outlook classique sur Windows, vous pouvez afficher un aperçu d’une limite de caractères augmentée pouvant atteindre 2 621 440 caractères par complément. Pour tester la limite mise à jour, rejoignez le programme Microsoft 365 Insider, puis choisissez le canal bêta dans le client Outlook sur Windows classique. Votre client doit être sur la version 2510 (build 19317.20000) ou ultérieure.

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/session-data-apis.yaml

Office.context.mailbox.item.sessionData.setAsync(
  "Date",
  "7/24/2020",
  function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("sessionData.setAsync succeeded");
  } else {
    console.log("Failed to set sessionData. Error: " + JSON.stringify(asyncResult.error));
  }
});

setAsync(name, value, callback)

Définit une paire clé-valeur de données de session.

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

Paramètres

name: string

Clé de données de session.

value: string

Valeur des données de session sous forme de chaîne.

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 de type Office.AsyncResult.

Retours

void

Remarques

[ Ensemble d’API : Boîte aux lettres 1.11 ]

Niveau d’autorisation minimal : élément de lecture

Mode Outlook applicable : Compose

Commentaires

Cette page a-t-elle été utile ?

Partager via

Office.SessionData interface

Remarques

Méthodes

Détails de la méthode

clearAsync(options, callback)

Paramètres

Retours

Remarques

Exemples

clearAsync(callback)

Paramètres

Retours

Remarques

getAllAsync(callback)

Paramètres

Retours

Remarques

Exemples

getAsync(name, callback)

Paramètres

Retours

Remarques

Exemples

removeAsync(name, options, callback)

Paramètres

Retours

Remarques

Exemples

removeAsync(name, callback)

Paramètres

Retours

Remarques

setAsync(name, value, options, callback)

Paramètres

Retours

Remarques

Exemples

setAsync(name, value, callback)

Paramètres

Retours

Remarques

Commentaires