context (ensemble de conditions requises de la préversion de boîte aux lettres)

  • Article

Office.context

Office.context fournit des interfaces partagées utilisées par les compléments dans toutes les applications Office. Cette liste documente uniquement les interfaces utilisées par les compléments Outlook. Pour obtenir la liste complète de l’espace de noms Office.context, consultez la référence Office.context dans l’API commune.

Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture

Propriétés

Propriété Modes Type de retour Minimum
Ensemble de conditions requises
Auth Composition
Lecture		 Auth IdentityAPI 1.3
contentLanguage Composition
Lecture		 String 1.1
diagnostics Composition
Lecture		 ContextInformation 1,5
displayLanguage Composition
Lecture		 String 1.1
Hôte Composition
Lecture		 HostType 1,5
mailbox Composition
Lecture		 Boîte aux lettres 1.1
officeTheme Composition
Lecture		 OfficeTheme Aperçu
Plate-forme Composition
Lecture		 PlatformType 1,5
Exigences Composition
Lecture		 RequirementSetSupport 1.1
roamingSettings Composition
Lecture		 RoamingSettings 1.1
sensitivityLabelsCatalog Composition SensitivityLabelsCatalog 1.13
ui Composition
Lecture		 UI 1.1
Url Composition
Lecture		 URL Aperçu

Détails de la propriété

auth : Auth

Prend en charge l’authentification unique (SSO) en fournissant une méthode qui permet à l’application Office d’obtenir un jeton d’accès à l’application web du complément. Indirectement, ceci active également le complément pour accéder aux données de Microsoft Graph de l’utilisateur sans que l’utilisateur ne doive se connecter une deuxième fois.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres Aperçu
Mode Outlook applicable Rédaction ou lecture
Exemple
Office.context.auth.getAccessTokenAsync(function(result) {
    if (result.status === "succeeded") {
        const token = result.value;
        // ...
    } else {
        console.log("Error obtaining token", result.error);
    }
});

contentLanguage : chaîne

Obtient les paramètres régionaux (langue) spécifiés par l’utilisateur pour la modification de l’élément.

La contentLanguage valeur reflète le paramètre Langue d’édition actuel spécifié avec La langue des options > de fichier > dans l’application cliente Office.

Type
  • String
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture
Exemple
function sayHelloWithContentLanguage() {
  const myContentLanguage = Office.context.contentLanguage;
  switch (myContentLanguage) {
    case 'en-US':
      write('Hello!');
      break;
    case 'en-NZ':
      write('G\'day mate!');
      break;
  }
}

// Function that writes to a div with id='message' on the page.
function write(message){
  document.getElementById('message').innerText += message;
}

diagnostics : ContextInformation

Obtient des informations sur l’environnement dans lequel le complément s’exécute.

Remarque

Pour tous les ensembles de conditions requises de boîte aux lettres, vous pouvez également utiliser la propriété Office.context.mailbox.diagnostics pour obtenir des informations similaires.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1,5
Mode Outlook applicable Rédaction ou lecture
Exemple
const contextInfo = Office.context.diagnostics;
console.log("Office application: " + contextInfo.host);
console.log("Office version: " + contextInfo.version);
console.log("Platform: " + contextInfo.platform);

displayLanguage : Chaîne

Obtient les paramètres régionaux (langue) au format de balise de langue RFC 1766 spécifié par l’utilisateur pour l’interface utilisateur de l’application cliente Office.

La displayLanguage valeur reflète le paramètre Langue d’affichage actuel spécifié avec Lalangue desoptions> de fichier> dans l’application cliente Office.

Type
  • String
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture
Exemple
function sayHelloWithDisplayLanguage() {
  const myDisplayLanguage = Office.context.displayLanguage;
  switch (myDisplayLanguage) {
    case 'en-US':
      write('Hello!');
      break;
    case 'en-NZ':
      write('G\'day mate!');
      break;
  }
}

// Function that writes to a div with id='message' on the page.
function write(message){
  document.getElementById('message').innerText += message;
}

host : HostType

Obtient l’application Office qui héberge le complément.

Remarque

Vous pouvez également utiliser la propriété Office.context.diagnostics pour obtenir l’hôte. Pour tous les ensembles de conditions requises de boîte aux lettres, vous pouvez également utiliser la propriété Office.context.mailbox.diagnostics pour obtenir des informations similaires.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1,5
Mode Outlook applicable Rédaction ou lecture
Exemple
console.log(JSON.stringify(Office.context.host));

officeTheme : OfficeTheme

Permet d’accéder aux propriétés pour les couleurs du thème Office.

Remarque

Ce membre est uniquement pris en charge dans Outlook sur Windows.

L’utilisation des couleurs de thème Office vous permet de coordonner le jeu de couleurs de votre complément avec le thème Office actuel sélectionné par l’utilisateur avec > l’interface utilisateur du thème Office du compte >Office de fichiers, qui est appliqué à toutes les applications clientes Office. Les couleurs du thème Office s’utilisent avec les compléments de messagerie et du volet Office.

Type
Propriétés
Nom Type Description
bodyBackgroundColor String Obtient la couleur d’arrière-plan du corps du thème Office sous la forme d’un triplet hexadécimal de couleurs.
bodyForegroundColor String Obtient la couleur de premier plan du corps du thème Office sous la forme d’un triplet hexadécimal de couleurs.
controlBackgroundColor String Obtient la couleur d’arrière-plan du contrôle du thème Office sous la forme d’un triplet hexadécimal de couleurs.
controlForegroundColor String Obtient la couleur du contrôle du corps du thème Office sous la forme d’un triplet hexadécimal de couleurs.
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres Aperçu
Mode Outlook applicable Rédaction ou lecture
Exemple
function applyOfficeTheme(){
  // Get office theme colors.
  const bodyBackgroundColor = Office.context.officeTheme.bodyBackgroundColor;
  const bodyForegroundColor = Office.context.officeTheme.bodyForegroundColor;
  const controlBackgroundColor = Office.context.officeTheme.controlBackgroundColor
  const controlForegroundColor = Office.context.officeTheme.controlForegroundColor;

  // Apply body background color to a CSS class.
  $('.body').css('background-color', bodyBackgroundColor);
}

platform : PlatformType

Fournit la plateforme sur laquelle le complément s’exécute.

Remarque

Vous pouvez également utiliser la propriété Office.context.diagnostics pour obtenir la plateforme. Pour tous les ensembles de conditions requises de boîte aux lettres, vous pouvez également utiliser la propriété Office.context.mailbox.diagnostics pour obtenir des informations similaires.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1,5
Mode Outlook applicable Rédaction ou lecture
Exemple
console.log(JSON.stringify(Office.context.platform));

configuration requise : RequirementsSetSupport

Fournit une méthode pour déterminer quels ensembles de conditions requises sont pris en charge sur l’application et la plateforme actuelles.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture
Exemple
console.log(JSON.stringify(Office.context.requirements.isSetSupported("mailbox", "1.1")));

roamingSettings : RoamingSettings

Obtient un objet qui représente les paramètres personnalisés ou l’état d’un complément de messagerie enregistrés dans la boîte aux lettres d’un utilisateur.

L’objet RoamingSettings vous permet de stocker et d’accéder aux données d’un complément de messagerie stocké dans la boîte aux lettres d’un utilisateur, de sorte qu’elles soient disponibles pour ce complément lorsqu’il s’exécute à partir d’un client Outlook utilisé pour accéder à cette boîte aux lettres.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Niveau d’autorisation minimal Restreint
Mode Outlook applicable Rédaction ou lecture

sensitivityLabelsCatalog : SensitivityLabelsCatalog

Obtient l’objet pour case activée la status du catalogue d’étiquettes de confidentialité dans Outlook et récupérer toutes les étiquettes de confidentialité disponibles si le catalogue est activé.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.13
Niveau d’autorisation minimal élément en lecture/écriture
Mode Outlook applicable Composition

ui : interface utilisateur

Fournit des objets et des méthodes que vous pouvez utiliser pour créer et manipuler des composants d’interface utilisateur, tels que des boîtes de dialogue, dans vos compléments Office.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres 1.1
Mode Outlook applicable Rédaction ou lecture

urls : URL

Obtient l’objet pour récupérer les URL d’exécution d’un complément.

Type
Configuration requise
Conditions requises Valeur
Version de l’ensemble minimal de conditions de boîte aux lettres Aperçu
Mode Outlook applicable Rédaction ou lecture