Office.SharedProperties interface

Paquete:

outlook

Representa las propiedades de una cita o mensaje en una carpeta compartida o un buzón compartido.

Para obtener más información sobre cómo se usa este objeto, vea Habilitar carpetas compartidas y escenarios de buzón compartido en un complemento de Outlook.

Comentarios

[ Conjunto de API: Buzón 1.8 para compatibilidad con carpetas compartidas, Buzón 1.13 para compatibilidad con buzones compartidos ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose o lectura

Ejemplos

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

Propiedades

delegatePermissions	Permisos que el delegado tiene en una carpeta compartida o que el usuario tiene en un buzón compartido.
owner	Dirección de correo electrónico del propietario de un elemento compartido.
targetMailbox	Ubicación del buzón del propietario para el acceso del delegado. Esta ubicación puede diferir en función del cliente de Outlook. Use con targetRestUrl para construir la dirección URL de la operación REST. Ejemplo de uso: targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"
targetRestUrl	Dirección URL base de la API REST (actualmente https://outlook.office.com/api). Use con targetMailbox para construir la dirección URL de la operación REST. Ejemplo de uso: targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"

Detalles de las propiedades

delegatePermissions

Permisos que el delegado tiene en una carpeta compartida o que el usuario tiene en un buzón compartido.

delegatePermissions: MailboxEnums.DelegatePermissions;

Valor de propiedad

Office.MailboxEnums.DelegatePermissions

Ejemplos

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

Dirección de correo electrónico del propietario de un elemento compartido.

owner: string;

Valor de propiedad

string

targetMailbox

Ubicación del buzón del propietario para el acceso del delegado. Esta ubicación puede diferir en función del cliente de Outlook.

Use con targetRestUrl para construir la dirección URL de la operación REST.

Ejemplo de uso: targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"

targetMailbox: string;

Valor de propiedad

string

targetRestUrl

Dirección URL base de la API REST (actualmente https://outlook.office.com/api).

Use con targetMailbox para construir la dirección URL de la operación REST.

Ejemplo de uso: targetRestUrl + "/{api_version}/users/" + targetMailbox + "/{REST_operation}"

targetRestUrl: string;

Valor de propiedad

string