Compartilhar via

Office.RoamingSettings interface

  • Referência
Pacote:
outlook

As configurações criadas com os métodos do objeto RoamingSettings são salvas de acordo de acordo com o suplemento e o usuário. Ou seja, só estão disponíveis para o suplemento que os criou e apenas a partir da caixa de correio do utilizador na qual são guardados.

Embora a API de suplemento do Outlook limite o acesso a estas definições apenas ao suplemento que as criou, estas definições não devem ser consideradas armazenamento seguro. Elas podem ser acessadas pelos Serviços Web do Exchange ou por MAPI estendido. Não devem ser utilizadas para armazenar informações confidenciais, como credenciais de utilizador ou tokens de segurança.

O nome de uma configuração é uma String, enquanto o valor pode ser uma String, um Number, um Boolean, nulo, um Object ou uma Array.

O objeto RoamingSettings pode ser acessado por meio da propriedade roamingSettings no namespace Office.context.

Para saber mais sobre RoamingSettingso , consulte Obter e definir metadados de suplementos para um suplemento do Outlook.

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Importante:

  • O RoamingSettings objeto é inicializado a partir do armazenamento persistente apenas quando o suplemento é carregado pela primeira vez. Para painéis de tarefas, isto significa que só é inicializado quando o painel de tarefas é aberto pela primeira vez. Se o painel de tarefas navegar para outra página ou recarregar a página atual, o objeto dentro da memória será reposto para os respetivos valores iniciais, mesmo que o suplemento tenha persistentes alterações. As alterações persistentes não estarão disponíveis até que o painel de tarefas (ou item no caso de suplementos sem IU) seja fechado e reaberto.

  • Quando definidas e guardadas através do Outlook no Windows (novo ou clássico) ou no Mac, estas definições são refletidas no Outlook na Web apenas após uma atualização do browser.

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Compose ou Leitura

Métodos

get(name)

Recupera a configuração especificada.
remove(name)

Remove a configuração especificada.
saveAsync(callback)

Salva as configurações.

Todas as definições guardadas anteriormente por um suplemento são carregadas quando este é inicializado, pelo que, durante a duração da sessão, pode utilizar o conjunto e obter métodos para trabalhar com a cópia dentro da memória do conjunto de propriedades das definições. Quando quiser manter as definições para que fiquem disponíveis da próxima vez que o suplemento for utilizado, utilize o saveAsync método .
set(name, value)

Define ou cria a configuração especificada.

O set método cria uma nova definição do nome especificado se ainda não existir ou define uma definição existente do nome especificado. O valor é armazenado no documento como a representação JSON serializada do seu tipo de dados.

Está disponível um máximo de 32 KB para as definições de cada suplemento. É apresentado um erro com o código 9057 quando esse limite de tamanho é excedido.

Quaisquer alterações efetuadas às definições com o set método não serão guardadas no servidor até que o saveAsync método seja chamado.

Detalhes do método

get(name)

Recupera a configuração especificada.

get(name: string): any;

Parâmetros

name

string

O nome da configuração a ser recuperado diferencia maiúsculas de minúsculas.

Retornos

any

Tipo: Cadeia | Número | Booleano | Objeto | Matriz

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Compose ou Leitura

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml

const settingName = $("#settingName").val();
const settingValue = Office.context.roamingSettings.get(settingName);
$("#settingValue").val(settingValue);
console.log(`The value of setting "${settingName}" is "${settingValue}".`);

remove(name)

Remove a configuração especificada.

remove(name: string): void;

Parâmetros

name

string

O nome da configuração a ser removida diferencia maiúsculas de minúsculas.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Compose ou Leitura

saveAsync(callback)

Salva as configurações.

Todas as definições guardadas anteriormente por um suplemento são carregadas quando este é inicializado, pelo que, durante a duração da sessão, pode utilizar o conjunto e obter métodos para trabalhar com a cópia dentro da memória do conjunto de propriedades das definições. Quando quiser manter as definições para que fiquem disponíveis da próxima vez que o suplemento for utilizado, utilize o saveAsync método .

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

Parâmetros

callback

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

Opcional. Quando o método for concluído, a função transmitida 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.1 ]

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Compose ou Leitura

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml

// Save settings in the mailbox to make it available in future sessions.
Office.context.roamingSettings.saveAsync(function(result) {
  if (result.status !== Office.AsyncResultStatus.Succeeded) {
    console.error(`Action failed with message ${result.error.message}`);
  } else {
    console.log(`Settings saved with status: ${result.status}`);
  }
});

set(name, value)

Define ou cria a configuração especificada.

O set método cria uma nova definição do nome especificado se ainda não existir ou define uma definição existente do nome especificado. O valor é armazenado no documento como a representação JSON serializada do seu tipo de dados.

Está disponível um máximo de 32 KB para as definições de cada suplemento. É apresentado um erro com o código 9057 quando esse limite de tamanho é excedido.

Quaisquer alterações efetuadas às definições com o set método não serão guardadas no servidor até que o saveAsync método seja chamado.

set(name: string, value: any): void;

Parâmetros

name

string

O nome da configuração a ser definido ou criado; diferencia maiúsculas de minúsculas.

value

any

Specifies the value to be stored.

Retornos

void

Comentários

[ Conjunto de API: Caixa de Correio 1.1 ]

Nível mínimo de permissão: restrito

Modo Outlook aplicável: Compose ou Leitura

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/10-roaming-settings/roaming-settings.yaml

const settingName = $("#settingName").val();
const settingValue = $("#settingValue").val();
Office.context.roamingSettings.set(settingName, settingValue);
console.log(`Setting "${settingName}" set to value "${settingValue}".`);