Office.SessionData interface

Referencia

Paquete:: outlook

Proporciona métodos para administrar los datos de sesión de un elemento.

Los datos de sesión son específicos de un solo elemento de correo. No se comparte entre varios elementos aunque se use el mismo complemento para establecer o recuperar datos.

Comentarios

[ Conjunto de API: Buzón 1.11 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose

Importante: Para cada elemento de correo, todo el objeto SessionData está limitado a 50 000 caracteres por complemento.

Métodos

clearAsync(options, callback)	Borra todos los pares clave-valor de datos de sesión.
clearAsync(callback)	Borra todos los pares clave-valor de datos de sesión.
getAllAsync(callback)	Obtiene todos los pares clave-valor de datos de sesión.
getAsync(name, callback)	Obtiene el valor de datos de sesión de la clave especificada.
removeAsync(name, options, callback)	Quita un par clave-valor de datos de sesión.
removeAsync(name, callback)	Quita un par clave-valor de datos de sesión.
setAsync(name, value, options, callback)	Establece un par clave-valor de datos de sesión.
setAsync(name, value, callback)	Establece un par clave-valor de datos de sesión.

Detalles del método

clearAsync(options, callback)

Borra todos los pares clave-valor de datos de sesión.

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

Parámetros

options: Office.AsyncContextOptions

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.

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.11 ]

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

Modo de Outlook aplicable: Compose

Ejemplos

// 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)

Borra todos los pares clave-valor de datos de sesión.

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

Parámetros

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.11 ]

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

Modo de Outlook aplicable: Compose

getAllAsync(callback)

Obtiene todos los pares clave-valor de datos de sesión.

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

Parámetros

callback: (asyncResult: Office.AsyncResult<object>) => 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 .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.11 ]

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

Modo de Outlook aplicable: Compose

Ejemplos

// 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)

Obtiene el valor de datos de sesión de la clave especificada.

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

Parámetros

name: string

Clave de datos de sesión.

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

Comentarios

[ Conjunto de API: Buzón 1.11 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose

Ejemplos

// 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)

Quita un par clave-valor de datos de sesión.

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

Parámetros

name: string

Clave de datos de sesión.

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.11 ]

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

Modo de Outlook aplicable: Compose

Ejemplos

// 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)

Quita un par clave-valor de datos de sesión.

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

Parámetros

name: string

Clave de datos de sesión.

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, asyncResult, que es un Office.AsyncResult objeto .

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.11 ]

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

Modo de Outlook aplicable: Compose

setAsync(name, value, options, callback)

Establece un par clave-valor de datos de sesión.

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

Parámetros

name: string

Clave de datos de sesión.

value: string

Valor de datos de sesión como una cadena.

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.

Devoluciones

void

Comentarios

[ Conjunto de API: Buzón 1.11 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose

Importante: Para cada elemento de correo, todo el objeto SessionData está limitado a 50 000 caracteres por complemento.

Ejemplos

// 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)

Establece un par clave-valor de datos de sesión.

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

Parámetros

name: string

Clave de datos de sesión.

value: string

Valor de datos de sesión como una cadena.

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

[ Conjunto de API: Buzón 1.11 ]

Nivel mínimo de permiso: elemento de lectura

Modo de Outlook aplicable: Compose

Importante: Para cada elemento de correo, todo el objeto SessionData está limitado a 50 000 caracteres por complemento.

Compartir a través de

Office.SessionData interface

Comentarios

Métodos

Detalles del método

clearAsync(options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

clearAsync(callback)

Parámetros

Devoluciones

Comentarios

getAllAsync(callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

getAsync(name, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

removeAsync(name, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

removeAsync(name, callback)

Parámetros

Devoluciones

Comentarios

setAsync(name, value, options, callback)

Parámetros

Devoluciones

Comentarios

Ejemplos

setAsync(name, value, callback)

Parámetros

Devoluciones

Comentarios

Recursos adicionales