Office. Appointment Compose interface

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// This example gets the body of the item as plain text.
Office.context.mailbox.item.body.getAsync(
    "text",
    { asyncContext: "This is passed to the callback" },
    function callback(result) {
        // Do something with the result.
    });

// The following is an example of an object that is passed as the result parameter to the callback function.
{
    "value": "TEXT of whole body (including threads below)",
    "status": "succeeded",
    "asyncContext": "This is passed to the callback"
}

end

Obtiene o establece la fecha y la hora de finalización de la cita.

La end propiedad es un objeto Time expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor de propiedad end en la fecha y hora locales del cliente.

Si usa el método Time.setAsync para establecer la hora de finalización, use el método convertToUtcClientTime para convertir la hora local del cliente en un valor UTC para el servidor.

Importante: En el cliente de Windows, no puede usar esta propiedad para actualizar el final de una periodicidad.

end: Time;

Valor de propiedad

Office.Time

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// The following example sets the end time of an appointment in compose mode by
// using the `setAsync` method of the `Time` object.
const endTime = new Date("3/14/2015");
const options = {
    // Pass information that can be used in the callback.
    asyncContext: {verb: "Set"}
};
Office.context.mailbox.item.end.setAsync(endTime, options, function(result) {
    if (result.error) {
        console.debug(result.error);
    } else {
        // Access the asyncContext that was passed to the setAsync method.
        console.debug("End Time " + result.asyncContext.verb);
    }
});

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-end-appointment-organizer.yaml

Office.context.mailbox.item.end.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment ends: ${result.value}`);
});

...

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Get start date failed with message ${result.error.message}`);
    return;
  }

  const end = result.value; // Set end to current start date and time.
  end.setDate(end.getDate() + 1); // Set end as 1 day later than start date.
  Office.context.mailbox.item.end.setAsync(end, (result) => {
    if (result.status !== Office.AsyncResultStatus.Succeeded) {
      console.error(`Set end date failed with message ${result.error.message}`);
      return;
    }
    console.log(`Successfully set end date and time to ${end}`);
  });
});

itemType

Obtiene el tipo de elemento que representa una instancia.

La propiedad itemType devuelve uno de los valores de enumeración de ItemType, lo que indica si la instancia del objeto item es un mensaje o una cita.

itemType: MailboxEnums.ItemType | string;

Valor de propiedad

Office.MailboxEnums.ItemType | string

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

const itemType = Office.context.mailbox.item.itemType;
switch (itemType) {
    case Office.MailboxEnums.ItemType.Appointment:
        console.log(`Current item is an ${itemType}.`);
        break;
    case Office.MailboxEnums.ItemType.Message:
        console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
        break;
}

location

Obtiene o establece la ubicación de una cita. La location propiedad devuelve un objeto Location que proporciona métodos que se usan para obtener y establecer la ubicación de la cita.

location: Location;

Valor de propiedad

Office.Location

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

const userContext = { value : 1 };
Office.context.mailbox.item.location.getAsync( { context: userContext}, callback);

function callback(asyncResult) {
    const context = asyncResult.context;
    const location = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-location-appointment-organizer.yaml

Office.context.mailbox.item.location.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment location: ${result.value}`);
});

...

const location = "my office";
Office.context.mailbox.item.location.setAsync(location, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set location to ${location}`);
});

notificationMessages

Obtiene los mensajes de notificación de un elemento.

notificationMessages: NotificationMessages;

Valor de propiedad

Office.NotificationMessages

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/35-notifications/add-getall-remove.yaml

// Adds a progress indicator to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.ProgressIndicator,
    message: "Progress indicator with id = " + id
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds an informational notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Non-persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: false
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Adds a persistent information notification to the mail item.
const id = $("#notificationId").val().toString();
const details =
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Persistent informational notification message with id = " + id,
    icon: "icon1",
    persistent: true
  };
Office.context.mailbox.item.notificationMessages.addAsync(id, details, handleResult);

...

// Gets all the notification messages and their keys for the current mail item.
Office.context.mailbox.item.notificationMessages.getAllAsync((asyncResult) => {
  if (asyncResult.status === Office.AsyncResultStatus.Failed) {
    console.log(asyncResult.error.message);
    return;
  }

  console.log(asyncResult.value);
});

...

// Replaces a notification message of a given key with another message.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.replaceAsync(
  id,
  {
    type: Office.MailboxEnums.ItemNotificationMessageType.InformationalMessage,
    message: "Notification message with id = " + id + " has been replaced with an informational message.",
    icon: "icon2",
    persistent: false
  },
  handleResult);

...

// Removes a notification message from the current mail item.
const id = $("#notificationId").val().toString();
Office.context.mailbox.item.notificationMessages.removeAsync(id, handleResult);

optionalAttendees

Proporciona acceso a los asistentes opcionales de un evento. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.

La propiedad optionalAttendees devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los asistentes opcionales a una reunión. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

optionalAttendees: Recipients;

Valor de propiedad

Office.Recipients

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

Office.context.mailbox.item.optionalAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.optionalAttendees.getAsync(callback);

function callback(asyncResult) {
    const arrayOfOptionalAttendeesRecipients = asyncResult.value;
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-optional-attendees-appointment-organizer.yaml

Office.context.mailbox.item.optionalAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptOptionalAttendees = asyncResult.value;
    for (let i = 0; i < apptOptionalAttendees.length; i++) {
      console.log(
        "Optional attendees: " +
          apptOptionalAttendees[i].displayName +
          " (" +
          apptOptionalAttendees[i].emailAddress +
          ") - response: " +
          apptOptionalAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailOptional")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.optionalAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting optional attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

requiredAttendees

Proporciona acceso a los asistentes necesarios de un evento. El tipo de objeto y el nivel de acceso dependen del modo del elemento actual.

La propiedad requiredAttendees devuelve un objeto Recipients que proporciona métodos para obtener o actualizar los asistentes obligatorios a una reunión. Sin embargo, dependiendo del cliente o la plataforma (es decir, Windows, Mac, etc.), se pueden aplicar límites en cuanto a cuántos destinatarios puede obtener o actualizar. Consulte el objeto Recipients para obtener más detalles.

requiredAttendees: Recipients;

Valor de propiedad

Office.Recipients

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

Office.context.mailbox.item.requiredAttendees.setAsync( ['alice@contoso.com', 'bob@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.addAsync( ['jason@contoso.com'] );
Office.context.mailbox.item.requiredAttendees.getAsync(callback);

function callback(asyncResult) {
    const arrayOfRequiredAttendeesRecipients = asyncResult.value;
    console.log(JSON.stringify(arrayOfRequiredAttendeesRecipients));
}

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/30-recipients-and-attendees/get-set-required-attendees-appointment-organizer.yaml

Office.context.mailbox.item.requiredAttendees.getAsync(function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const apptRequiredAttendees = asyncResult.value;
    for (let i = 0; i < apptRequiredAttendees.length; i++) {
      console.log(
        "Required attendees: " +
          apptRequiredAttendees[i].displayName +
          " (" +
          apptRequiredAttendees[i].emailAddress +
          ") - response: " +
          apptRequiredAttendees[i].appointmentResponse
      );
    }
  } else {
    console.error(asyncResult.error);
  }
});

...

const email = $("#emailRequired")
  .val()
  .toString();
const emailArray = [email];
Office.context.mailbox.item.requiredAttendees.setAsync(emailArray, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Succeeded in setting required attendees field.");
  } else {
    console.error(asyncResult.error);
  }
});

start

Obtiene o establece la fecha y la hora de inicio de la cita.

La start propiedad es un objeto Time expresado como un valor de fecha y hora de hora universal coordinada (UTC). Puede usar el convertToLocalClientTime método para convertir el valor en la fecha y hora locales del cliente.

Si usa el método Time.setAsync para establecer la hora de inicio, use el método convertToUtcClientTime para convertir la hora local del cliente en un valor UTC para el servidor.

Importante: En el cliente de Windows, no puede usar esta propiedad para actualizar el inicio de una periodicidad.

start: Time;

Valor de propiedad

Office.Time

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml

Office.context.mailbox.item.start.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Appointment starts: ${result.value}`);
});

...

const start = new Date(); // Represents current date and time.
start.setDate(start.getDate() + 2); // Add 2 days to current date.
Office.context.mailbox.item.start.setAsync(start, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set start date and time to ${start}`);
});

subject

Obtiene o establece la descripción que se muestra en el campo de asunto de un elemento.

La propiedad subject obtiene o establece el asunto completo del elemento, como lo ha enviado el servidor de correo electrónico.

La propiedad subject devuelve un objeto Subject que proporciona métodos para obtener y establecer el asunto.

subject: Subject;

Valor de propiedad

Office.Subject

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

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

Office.context.mailbox.item.subject.getAsync((result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Subject: ${result.value}`);
});

...

let subject = "Hello World!";
Office.context.mailbox.item.subject.setAsync(subject, (result) => {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
    return;
  }
  console.log(`Successfully set subject to ${subject}`);
});

Detalles del método

addFileAttachmentAsync(uri, attachmentName, options, callback)

Agrega un archivo a un mensaje o cita como datos adjuntos.

El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

Importante: En las compilaciones recientes de Outlook en Windows, se introdujo un error que anexa incorrectamente un Authorization: Bearer encabezado a esta acción (ya sea mediante esta API o la interfaz de usuario de Outlook). Para solucionar este problema, puede intentar usar la API introducida con el addFileAttachmentFromBase64 conjunto de requisitos 1.8.

addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

uri: string

El URI que proporciona la ubicación del archivo que se va a adjuntar al mensaje o a la cita. La longitud máxima es de 2048 caracteres.

attachmentName: string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

options: Office.AsyncContextOptions & { isInline: boolean }

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada. isInline: si es true, indica que los datos adjuntos se mostrarán alineados en el cuerpo del mensaje y no deben mostrarse en la lista de datos adjuntos.

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error en la carga de los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del error.

Devoluciones

void

Comentarios

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Errores:

AttachmentSizeExceeded: los datos adjuntos son mayores de lo permitido.
FileTypeNotSupported: los datos adjuntos tienen una extensión que no está permitida.
NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

const attachmentUrl = $("#attachmentUrl")
  .val()
  .toString();
Office.context.mailbox.item.addFileAttachmentAsync(
  attachmentUrl,
  getFileName(attachmentUrl),
  { isInline: false },
  (result) => {
    console.log(result);
  }
);

addFileAttachmentAsync(uri, attachmentName, callback)

Agrega un archivo a un mensaje o cita como datos adjuntos.

El método addFileAttachmentAsync carga el archivo en el URI especificado y lo asocia al elemento en el formulario de redacción.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

uri: string

El URI que proporciona la ubicación del archivo que se va a adjuntar al mensaje o a la cita. La longitud máxima es de 2048 caracteres.

attachmentName: string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

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

Devoluciones

void

Comentarios

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Errores:

AttachmentSizeExceeded: los datos adjuntos son mayores de lo permitido.
FileTypeNotSupported: los datos adjuntos tienen una extensión que no está permitida.
NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

addItemAttachmentAsync(itemId, attachmentName, options, callback)

Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita.

El método addItemAttachmentAsync asocia el elemento con el identificador especificado de Exchange al elemento en el formulario de redacción. Si especifica una función de devolución de llamada, se llama al método con un parámetro, asyncResult, que contiene el identificador de datos adjuntos o un código que indica cualquier error que se haya producido al adjuntar el elemento. Puede usar el options parámetro para pasar información de estado a la función de devolución de llamada, si es necesario.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

Si el complemento de Office se ejecuta en Outlook en la Web, el método addItemAttachmentAsync puede adjuntar elementos a otros elementos distintos del que quiere editar. No obstante, esta acción no es compatible y no se recomienda.

addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

itemId: any

El identificador de Exchange del elemento que debe adjuntarse. La longitud máxima es de 100 caracteres.

attachmentName: string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

options: Office.AsyncContextOptions

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

Opcional. Cuando se completa el método, se llama a la función pasada en el parámetro de devolución de llamada con un único parámetro de tipo Office.AsyncResult. Si se realiza correctamente, se proporcionará el identificador de los datos adjuntos en la propiedad asyncResult.value. Si se produce un error al agregar los datos adjuntos, el objeto asyncResult contendrá un objeto Error que proporciona una descripción del error.

Devoluciones

void

Comentarios

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Errores:

NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

Ejemplos

// The following example adds an existing Outlook item as an attachment
// with the name "My Attachment".
function addAttachment() {
    // EWS ID of item to attach (shortened for readability).
    const itemId = "AAMkADI1...AAA=";

    // The values in asyncContext can be accessed in the callback.
    const options = { asyncContext: { var1: 1, var2: 2 } };

    Office.context.mailbox.item.addItemAttachmentAsync(itemId, "My Attachment", options, (result) => {
        if (result.status === Office.AsyncResultStatus.Failed) {
            console.error("Failed to add attachment: " + result.error.message);
            return;
        }

        console.log("Attachment added successfully.");
        console.log("var1: " + result.asyncContext.var1);
        console.log("var2: " + result.asyncContext.var2);
    });
}

addItemAttachmentAsync(itemId, attachmentName, callback)

Agrega un elemento de Exchange (por ejemplo, un mensaje) como datos adjuntos al mensaje o a la cita.

Después, puede usar el identificador con el método removeAttachmentAsync para quitar los datos adjuntos en la misma sesión.

addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

itemId: any

El identificador de Exchange del elemento que debe adjuntarse. La longitud máxima es de 100 caracteres.

attachmentName: string

El nombre de los datos adjuntos que se muestra mientras estos se cargan. La longitud máxima es 255 caracteres.

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

Devoluciones

void

Comentarios

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Errores:

NumberOfAttachmentsExceeded: el mensaje o la cita tiene demasiados datos adjuntos.

close()

Cierra el elemento actual que se está redactando.

El comportamiento del método close depende del estado actual del elemento que se está redactando. Si el elemento tiene cambios no guardados, el cliente solicita al usuario que guarde, descarte o cierre la acción.

En el cliente de escritorio de Outlook, el close método no tiene ningún efecto en una respuesta en el panel de lectura.

close(): void;

Devoluciones

void

Comentarios

Nivel mínimo de permiso: restringido

Modo de Outlook aplicable: Organizador de citas

Importante: En Outlook en la web, si el elemento es una cita y se ha guardado anteriormente con saveAsync, se le pide al usuario que guarde, descarte o cancele incluso si no se ha producido ningún cambio desde la última vez que se guardó el elemento.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/close.yaml

Office.context.mailbox.item.close();

getSelectedDataAsync(coercionType, options, callback)

Devuelve asincrónicamente datos seleccionados desde el asunto o el cuerpo de un mensaje.

Si no hay ninguna selección pero el cursor está en el cuerpo o el asunto, el método devuelve una cadena vacía para los datos seleccionados. Si se selecciona un campo que no sea el cuerpo o el asunto, el método devuelve el error InvalidSelection.

Para acceder a los datos seleccionados desde la función de devolución de llamada, llame a asyncResult.value.data. Para acceder a la source propiedad de la que procede la selección, llame aasyncResult.value.sourceProperty , que será o bodysubject.

getSelectedDataAsync(coercionType: Office.CoercionType | string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult<any>) => void): void;

Parámetros

coercionType: Office.CoercionType | string

Solicita un formato para los datos. Si Textes , el método devuelve el texto sin formato como una cadena, quitando las etiquetas HTML presentes. Si HTMLes , el método devuelve el texto seleccionado, ya sea texto sin formato o HTML.

options: Office.AsyncContextOptions

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Los datos seleccionados como una cadena con formato determinado por coercionType.

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Get selected data.
Office.initialize = function () {
    Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, {}, getCallback);
};

function getCallback(asyncResult) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;

    console.log("Selected text in " + prop + ": " + text);
}

getSelectedDataAsync(coercionType, callback)

Devuelve asincrónicamente datos seleccionados desde el asunto o el cuerpo de un mensaje.

getSelectedDataAsync(coercionType: Office.CoercionType | string, callback: (asyncResult: Office.AsyncResult<string>) => void): void;

Parámetros

coercionType: Office.CoercionType | string

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Los datos seleccionados como una cadena con formato determinado por coercionType.

Comentarios

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/20-item-body/get-selected-data.yaml

Office.context.mailbox.item.getSelectedDataAsync(Office.CoercionType.Text, function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    const text = asyncResult.value.data;
    const prop = asyncResult.value.sourceProperty;
    console.log("Selected text in " + prop + ": " + text);
  } else {
    console.error(asyncResult.error);
  }
});

loadCustomPropertiesAsync(callback, userContext)

Carga de forma asincrónica las propiedades personalizadas de este complemento en el elemento seleccionado.

Las propiedades personalizadas se almacenan como pares clave-valor por aplicación y por elemento. Este método devuelve un objeto CustomProperties en la devolución de llamada, que proporciona métodos para acceder a las propiedades personalizadas específicas del elemento actual y del complemento actual. Las propiedades personalizadas no se cifran en el elemento, por lo que no se debe usar como almacenamiento seguro.

Las propiedades personalizadas se proporcionan como un objeto CustomProperties en la propiedad asyncResult.value. Este objeto se puede usar para obtener, establecer, guardar y quitar propiedades personalizadas del elemento de correo.

loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult<CustomProperties>) => void, userContext?: any): void;

Parámetros

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

userContext: any

Opcional. Los desarrolladores pueden proporcionar cualquier objeto al que quieran obtener acceso en la función de devolución de llamada. A este objeto se puede acceder mediante la propiedad asyncResult.asyncContext en la función de devolución de llamada.

Devoluciones

void

Comentarios

Para obtener más información sobre las propiedades personalizadas, vea Obtener y establecer metadatos de complemento para un complemento de Outlook.

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Organizador de citas

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/15-item-custom-properties/load-set-get-save.yaml

Office.context.mailbox.item.loadCustomPropertiesAsync((result) => {
  if (result.status === Office.AsyncResultStatus.Failed) {
    console.error(`loadCustomPropertiesAsync failed with message ${result.error.message}`);
    return;
  }

  customProps = result.value;
  console.log("Loaded the CustomProperties object.");
});

removeAttachmentAsync(attachmentId, options, callback)

Quita los datos adjuntos de un mensaje o cita.

El método removeAttachmentAsync quita del elemento los datos adjuntos con el identificador especificado. Como práctica recomendada, debe usar el identificador de datos adjuntos para quitar datos adjuntos solo si la misma aplicación de correo ha agregado los datos adjuntos en la misma sesión. En Outlook en la web y en dispositivos móviles, el identificador de datos adjuntos solo es válido dentro de la misma sesión. Una sesión termina cuando el usuario cierra la aplicación, o si el usuario comienza a redactar un formulario insertado, a continuación, extrae el formulario para continuar en una ventana independiente.

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

Parámetros

attachmentId: string

El identificador de los datos adjuntos para quitar. La longitud máxima de la attachmentId cadena es de 200 caracteres en Outlook en la web y en Windows.

options: Office.AsyncContextOptions

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult. Si se produce un error en la eliminación de los datos adjuntos, la propiedad asyncResult.error contendrá un código de error con el motivo del error.

Devoluciones

void

Comentarios

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Importante*: El removeAttachmentAsync método no quita los datos adjuntos insertados de un elemento de correo. Para quitar los datos adjuntos insertados, primero obtenga el cuerpo del elemento y, a continuación, quite las referencias de los datos adjuntos de su contenido. Use las API de Office.Body para obtener y establecer el cuerpo de un elemento.

Errores:

InvalidAttachmentId: el identificador de datos adjuntos no existe.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/40-attachments/attachments-compose.yaml

Office.context.mailbox.item.removeAttachmentAsync(
  $("#attachmentId")
    .val()
    .toString(),
  (result) => {
    if (result.status === Office.AsyncResultStatus.Failed) {
      console.error(result.error.message);
      return;
    }

    console.log(`Attachment removed successfully.`);
  }
);

removeAttachmentAsync(attachmentId, callback)

Quita los datos adjuntos de un mensaje o cita.

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

Parámetros

attachmentId: string

El identificador de los datos adjuntos para quitar. La longitud máxima de la attachmentId cadena es de 200 caracteres en Outlook en la web y en Windows.

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

Devoluciones

void

Comentarios

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Errores:

InvalidAttachmentId: el identificador de datos adjuntos no existe.

saveAsync(options, callback)

Guarda un elemento de forma asincrónica.

Puesto que las citas no tienen ningún estado de borrador, si saveAsync se llama a una cita en modo de redacción, el elemento se guarda como una cita normal en el calendario del usuario. En el caso de las nuevas citas que no se han guardado antes, no se envía ninguna invitación. En el caso de las citas existentes, se envía una actualización a los asistentes agregados o quitados.

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

Parámetros

options: Office.AsyncContextOptions

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

Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro, asyncResult, que es un Office.AsyncResult objeto . El identificador de cita se devuelve en la asyncResult.value propiedad .

Devoluciones

void

Comentarios

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Importante:

En el modo en línea de Outlook o en Outlook en la web, el elemento se guarda en el servidor. En modo en caché de Outlook, se guarda el elemento en la caché local.
Al trabajar con contenido con formato HTML, es importante tener en cuenta que el cliente de Outlook puede modificar el contenido. Esto significa que las llamadas posteriores a métodos como Body.getAsync, Body.setAsynce incluso saveAsync pueden no dar lugar al mismo contenido.
Si el complemento llama a saveAsync un elemento en modo de redacción con el fin de obtener un identificador de elemento para usarlo con EWS o la API REST, tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice realmente con el servidor. Hasta que se sincronice el elemento, el uso del identificador de elemento devolverá un error.
En Outlook en Mac, solo la compilación 16.35.308 o posterior admite guardar una reunión. De lo contrario, se produce un error en el saveAsync método cuando se llama desde una reunión en modo de redacción. Para obtener una solución alternativa, consulte No se puede guardar una reunión como borrador en Outlook para Mac mediante la API de Office JS.

Errores:

InvalidAttachmentId: el identificador de datos adjuntos no existe.

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/25-item-save-and-close/save.yaml

Office.context.mailbox.item.saveAsync(function (result) {
  if (result.status === Office.AsyncResultStatus.Succeeded) {
    console.log(`saveAsync succeeded, itemId is ${result.value}`);
  }
  else {
    console.error(`saveAsync failed with message ${result.error.message}`);
  }
});

saveAsync(callback)

Guarda un elemento de forma asincrónica.

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

Parámetros

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

Devoluciones

void

Comentarios

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Importante:

En el modo en línea de Outlook o en Outlook en la web, el elemento se guarda en el servidor. En modo en caché de Outlook, se guarda el elemento en la caché local.
Al trabajar con contenido con formato HTML, es importante tener en cuenta que el cliente de Outlook puede modificar el contenido. Esto significa que las llamadas posteriores a métodos como Body.getAsync, Body.setAsynce incluso saveAsync pueden no dar lugar al mismo contenido.
Si el complemento llama a saveAsync un elemento en modo de redacción con el fin de obtener un identificador de elemento para usarlo con EWS o la API REST, tenga en cuenta que, cuando Outlook está en modo almacenado en caché, puede tardar algún tiempo antes de que el elemento se sincronice realmente con el servidor. Hasta que se sincronice el elemento, el uso del identificador de elemento devolverá un error.
En Outlook en Mac, solo la compilación 16.35.308 o posterior admite guardar una reunión. De lo contrario, se produce un error en el saveAsync método cuando se llama desde una reunión en modo de redacción. Para obtener una solución alternativa, consulte No se puede guardar una reunión como borrador en Outlook para Mac mediante la API de Office JS.

Errores:

InvalidAttachmentId: el identificador de datos adjuntos no existe.

Ejemplos

Office.context.mailbox.item.saveAsync(
    function callback(result) {
        // Process the result.
    });

// The following is an example of the
// `result` parameter passed to the
// callback function. The `value`
// property contains the item ID of
// the item.
{
    "value": "AAMkADI5...AAA=",
    "status": "succeeded"
}

setSelectedDataAsync(data, options, callback)

Inserta asincrónicamente datos en el cuerpo o el asunto de un mensaje.

El setSelectedDataAsync método inserta la cadena especificada en la ubicación del cursor en el asunto o cuerpo del elemento, o bien, si el texto está seleccionado en el editor, reemplaza el texto seleccionado. Si el cursor no está en el cuerpo o el campo subject, se devuelve un error. Después de la inserción, el cursor se coloca al final del contenido insertado.

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

Parámetros

data: string

Datos que se van a insertar. Los datos no deben superar 1.000.000 de caracteres. Si se pasan más de 1.000.000 de caracteres, se produce una excepción ArgumentOutOfRange.

options: Office.AsyncContextOptions & Office.CoercionTypeOptions

Literal de objeto que contiene una o varias de las siguientes propiedades:- asyncContext: los desarrolladores pueden proporcionar cualquier objeto al que quieran acceder en la función de devolución de llamada. coercionType: si es texto, el estilo actual se aplica en Outlook en la web y en Windows. Si el campo es un editor de HTML, se insertan solo los datos de texto, aunque los datos sean HTML. Si html y el campo admiten HTML (el asunto no), el estilo actual se aplica en Outlook en la web y el estilo predeterminado se aplica en outlook en clientes de escritorio. Si el campo es un campo de texto, se devuelve un error InvalidDataFormat. Si coercionType no está establecido, el resultado depende del campo: si el campo es HTML, se usa HTML; si el campo es texto, se usa texto sin formato.

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios

Nivel mínimo de permiso: elemento de lectura y escritura

Modo de Outlook aplicable: Organizador de citas

Errores:

InvalidAttachmentId: el identificador de datos adjuntos no existe.

Ejemplos

Office.context.mailbox.item.setSelectedDataAsync("<b>Hello World!</b>", { coercionType : "html" });

Office.context.mailbox.item.setSelectedDataAsync("Hello World!");

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

Office.context.mailbox.item.setSelectedDataAsync("Replaced", function(asyncResult) {
  if (asyncResult.status === Office.AsyncResultStatus.Succeeded) {
    console.log("Selected text has been updated successfully.");
  } else {
    console.error(asyncResult.error);
  }
});

setSelectedDataAsync(data, callback)

Inserta asincrónicamente datos en el cuerpo o el asunto de un mensaje.

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

Parámetros

data: string

Datos que se van a insertar. Los datos no deben superar 1.000.000 de caracteres. Si se pasan más de 1.000.000 de caracteres, se produce una excepción ArgumentOutOfRange.

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

Opcional. Cuando se completa el método, se llama a la función pasada en el callback parámetro con un único parámetro de tipo Office.AsyncResult.

Devoluciones

void

Comentarios