Office.SessionData interface

  • Referência
Pacote:
outlook

Fornece métodos para gerenciar os dados de sessão de um item.

Importante: todo o objeto SessionData é limitado a 50.000 caracteres por suplemento.

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose

Métodos

clearAsync(options, callback)

Limpa todos os pares de valor de chave de dados de sessão.
clearAsync(callback)

Limpa todos os pares de valor de chave de dados de sessão.
getAllAsync(callback)

Obtém todos os pares de valor de chave de dados de sessão.
getAsync(name, callback)

Obtém o valor de dados da sessão da chave especificada.
removeAsync(name, options, callback)

Remove um par de valores de chave de dados de sessão.
removeAsync(name, callback)

Remove um par de valores de chave de dados de sessão.
setAsync(name, value, options, callback)

Define um par de valores de chave de dados de sessão.

Importante: todo o objeto SessionData é limitado a 50.000 caracteres por suplemento.
setAsync(name, value, callback)

Define um par de valores de chave de dados de sessão.

Importante: todo o objeto SessionData é limitado a 50.000 caracteres por suplemento.

Detalhes do método

clearAsync(options, callback)

Limpa todos os pares de valor de chave de dados de sessão.

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

Parâmetros

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

Exemplos

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

Limpa todos os pares de valor de chave de dados de sessão.

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

Parâmetros

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

getAllAsync(callback)

Obtém todos os pares de valor de chave de dados de sessão.

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

Parâmetros

callback

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

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

Exemplos

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

Obtém o valor de dados da sessão da chave especificada.

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

Parâmetros

name

string

A chave de dados da sessão.

callback

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

Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose

Exemplos

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

Remove um par de valores de chave de dados de sessão.

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

Parâmetros

name

string

A chave de dados da sessão.

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

Exemplos

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

Remove um par de valores de chave de dados de sessão.

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

Parâmetros

name

string

A chave de dados da sessão.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro, , asyncResultque é um Office.AsyncResult objeto.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

Nível mínimo de permissão: item de leitura/gravação

Modo outlook aplicável: compose

setAsync(name, value, options, callback)

Define um par de valores de chave de dados de sessão.

Importante: todo o objeto SessionData é limitado a 50.000 caracteres por suplemento.

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

Parâmetros

name

string

A chave de dados da sessão.

value

string

O valor dos dados da sessão como uma cadeia de caracteres.

options
Office.AsyncContextOptions

Um literal de objeto que contém uma ou mais das seguintes propriedades:- asyncContext: Os desenvolvedores podem fornecer qualquer objeto que desejam acessar na função de retorno de chamada.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose

Exemplos

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

Define um par de valores de chave de dados de sessão.

Importante: todo o objeto SessionData é limitado a 50.000 caracteres por suplemento.

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

Parâmetros

name

string

A chave de dados da sessão.

value

string

O valor dos dados da sessão como uma cadeia de caracteres.

callback

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

Opcional. Quando o método é concluído, a função passada no callback parâmetro é chamada com um único parâmetro do tipo Office.AsyncResult.

Retornos

void

Comentários

[ Conjunto de API: Caixa de correio 1.11 ]

Nível mínimo de permissão: item de leitura

Modo outlook aplicável: compose