nginstack

Class: Environment

@nginstack/web-framework/lib/environment/Environment~ Environment

new Environment()

Objeto que representa o ambiente do Web Framework. Possui métodos e propriedades globais que independem do contexto de execução dos processos.

Não construa este objeto diretamente. Para fazer uso do mesmo, acesse a propriedade environment disponível nas instâncias dos processos.

See:
  • Process#environment

Members

exiting :boolean

Indica que o sistema está sendo finalizado.

Type:
  • boolean

restrictSystemAccess

Limita a utilização do sistema pelo usuário, impedindo que ele possa acessar outros processos além daqueles definidos na opção options.allowedProcesses.

sessionToken :string

Token de autorização da sessão corrente do Web Framework.

Type:
  • string

Methods

<static> getInstance()

Obtém a instância global e compartilhada do Environment.

Returns:
Type
Environment

alert(message)

Exibe uma mensagem de alerta para o usuário.

Parameters:
Name Type Description
message string

Mensagem de alerta.
Example
const env = Environment.getInstance();
env.alert('Faltam 5 dias para o envio das obrigações fiscais deste mês.');

confirm(message [, noAsDefault])

Exibe uma janela solicitando confirmação do usuário.

Parameters:
Name Type Argument Description
message string

Mensagem com a pergunta a ser exibida para o usuário.
noAsDefault boolean <optional>

Define se a resposta padrão é "não".
See:
Returns:

Resposta do usuário.

Type
boolean
Example
var resposta = this.confirm("Mensagem", true)

exit( [uri])

Sai do sistema e redireciona para uma URI.

Parameters:
Name Type Argument Description
uri string <optional>

URI para onde o usuário será redirecionado. Caso não seja informada, será redirecionado para a página de login do Web Framework.
Example
this.activity("Google", function () {
    this.environment.exit("http://www.google.com.br");
});

lockScreen()

Bloqueia a tela do usuário, exigindo que o usuário informe novamente a sua senha para retornar o uso do sistema.

O bloqueio da tela não é possível se o usuário foi autenticado por meio um provedor de identidade que não suporta a coleta de credenciais, como o Google. Nesse caso, este método não faz nada e retorna falso.

Returns:

True se o bloqueio da tela foi realizado.

Type
boolean

prompt(label, answers, options)

Exibe um diálogo de pergunta com opções de resposta para o usuário.

Se houver uma opção com o rótulo "Cancelar" e se não for informado um valor específico para o cancelamento do diálogo (através da opção cancelReturnValue), o sistema adotará essa opção como valor de retorno no cancelamento do diálogo e não a apresentará na lista de opções.

Parameters:
Name Type Description
label string

Mensagem com a pergunta a ser exibida para o usuário.
answers Array.<Array>

Array com pares (rótulo, valor de retorno) de respostas a serem exibidas para o usuário. Ex: [['Resposta 1', valorRetorno1], ['Resposta 2', valorRetorno2]].
options module:@nginstack/web-framework/lib/process/Process~PromptOptions

Configurações adicionais do diálogo.
See:
Returns:

Valor da opção selecionada pelo usuário ou do item indicado por options.escapeIndex caso o usuário pressione a tecla ESC.

Type
*
Example
const result = process.prompt('Selecione o tamanho do papel', [
  ['A4', 1],
  ['Carta', 2],
  ['Ofício', 3],
], { defaultIndex: 0, cancelReturnValue: null });