Office.SharedProperties interface

  • Référence
Paquet:
outlook

Représente les propriétés d’un rendez-vous ou d’un message dans un dossier partagé ou une boîte aux lettres partagée.

Pour plus d’informations sur l’utilisation de cet objet, voir Activer les dossiers partagés et les scénarios de boîte aux lettres partagées dans un complément Outlook.

Remarques

[ Ensemble d’API : Boîte aux lettres 1.8 pour la prise en charge des dossiers partagés, Boîte aux lettres 1.13 pour la prise en charge des boîtes aux lettres partagées ]

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

Mode Outlook applicable : Rédiger ou Lire

Exemples

function performOperation() {
  Office.context.mailbox.getCallbackTokenAsync({
      isRest: true
    },
    function (asyncResult) {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value !== "") {
        Office.context.mailbox.item.getSharedPropertiesAsync({
            // Pass auth token along.
            asyncContext: asyncResult.value
          },
          function (asyncResult1) {
            let sharedProperties = asyncResult1.value;
            let delegatePermissions = sharedProperties.delegatePermissions;

            // Determine if user can do the expected operation.
            // E.g., do they have Write permission?
            if ((delegatePermissions & Office.MailboxEnums.DelegatePermissions.Write) != 0) {
              // Construct REST URL for your operation.
              // Update <version> placeholder with actual Outlook REST API version e.g. "v2.0".
              // Update <operation> placeholder with actual operation.
              let rest_url = sharedProperties.targetRestUrl + "/<version>/users/" + sharedProperties.targetMailbox + "/<operation>";
  
              $.ajax({
                  url: rest_url,
                  dataType: 'json',
                  headers:
                  {
                    "Authorization": "Bearer " + asyncResult1.asyncContext
                  }
                }
              ).done(
                function (response) {
                  console.log("success");
                }
              ).fail(
                function (error) {
                  console.log("error message");
                }
              );
            }
          }
        );
      }
    }
  );
}

Propriétés

delegatePermissions

Autorisations dont dispose le délégué sur un dossier partagé ou l’utilisateur sur une boîte aux lettres partagée.
owner

Adresse e-mail du propriétaire d’un élément partagé.
targetMailbox

Emplacement de la boîte aux lettres du propriétaire pour l’accès du délégué. Cet emplacement peut différer en fonction du client Outlook.

Utilisez avec targetRestUrl pour construire l’URL de l’opération REST.

Exemple d’utilisation : targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"
targetRestUrl

URL de base de l’API REST (actuellement https://outlook.office.com/api).

Utilisez avec targetMailbox pour construire l’URL de l’opération REST.

Exemple d’utilisation : targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"

Détails de la propriété

delegatePermissions

Autorisations dont dispose le délégué sur un dossier partagé ou l’utilisateur sur une boîte aux lettres partagée.

delegatePermissions: MailboxEnums.DelegatePermissions;

Valeur de propriété

Office.MailboxEnums.DelegatePermissions

Exemples

function performOperation() {
  Office.context.mailbox.getCallbackTokenAsync({
      isRest: true
    },
    function (asyncResult) {
      if (asyncResult.status === Office.AsyncResultStatus.Succeeded && asyncResult.value !== "") {
        Office.context.mailbox.item.getSharedPropertiesAsync({
            // Pass auth token along.
            asyncContext: asyncResult.value
          },
          function (asyncResult1) {
            let sharedProperties = asyncResult1.value;
            let delegatePermissions = sharedProperties.delegatePermissions;

            // Determine if user can do the expected operation.
            // E.g., do they have Write permission?
            if ((delegatePermissions & Office.MailboxEnums.DelegatePermissions.Write) != 0) {
              // Construct REST URL for your operation.
              // Update <version> placeholder with actual Outlook REST API version e.g. "v2.0".
              // Update <operation> placeholder with actual operation.
              let rest_url = sharedProperties.targetRestUrl + "/<version>/users/" + sharedProperties.targetMailbox + "/<operation>";
  
              $.ajax({
                  url: rest_url,
                  dataType: 'json',
                  headers:
                  {
                    "Authorization": "Bearer " + asyncResult1.asyncContext
                  }
                }
              ).done(
                function (response) {
                  console.log("success");
                }
              ).fail(
                function (error) {
                  console.log("error message");
                }
              );
            }
          }
        );
      }
    }
  );
}

owner

Adresse e-mail du propriétaire d’un élément partagé.

owner: string;

Valeur de propriété

string

targetMailbox

Emplacement de la boîte aux lettres du propriétaire pour l’accès du délégué. Cet emplacement peut différer en fonction du client Outlook.

Utilisez avec targetRestUrl pour construire l’URL de l’opération REST.

Exemple d’utilisation : targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"

targetMailbox: string;

Valeur de propriété

string

targetRestUrl

URL de base de l’API REST (actuellement https://outlook.office.com/api).

Utilisez avec targetMailbox pour construire l’URL de l’opération REST.

Exemple d’utilisation : targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"

targetRestUrl: string;

Valeur de propriété

string