nginstack

Class: Response

@nginstack/engine/lib/http/Response~ Response

new Response()

Classe utilizada para acessar as informações contidas em uma resposta HTTP.

Esta classe é instanciada automaticamente pelo sistema quando um ambiente JavaScript. Neste caso, é criada a variável global response.

Sessões que não tem relação com um atendimento HTTP, como ambientes do Scheduler, não possuem esta variável global.

Classe também publicada por meio da variável global Response.

Members

cacheControl :string

Indica como deve ser realizado o controle do cache da resposta enviada pelo servidor. Valores possíveis: "public", "private", "no-store" e "no-cache".

Type:
  • string

contentDescription :string

Descrição do conteúdo desta resposta.

Type:
  • string

contentDisposition :string

Sugestão de tratamento que deverá ser realizado pelo cliente com o conteúdo desta resposta. Valores possíveis: "inline" e "attachment". Mais detalhes em http://www.iana.org/assignments/cont-disp/cont-disp.xhtml.

Type:
  • string
Example
response.contentDisposition = 'attachment; filename=data.txt';

contentEncoding :string

Codificação que deve ser realizada na resposta. Valores possíveis: '' (sem compressão) e 'gzip'. O valor informado somente será aceito se o navegador identificar que suporta o formato na propriedade "Accept-Encoding" do cabeçalho da requisição.
Para configurar a compressão para todos os arquivos de um diretório, prefira o uso da propriedade SessionConfiguration#httpCompressionEnabled no x-class do diretório.

Type:
  • string

contentType :string

Tipo do conteúdo desta resposta. Deverá ser informado um Media Type, preferencialmente um registrado pela IANA. Mais detalhes em http://www.iana.org/assignments/media-types/media-types.xhtml.

Type:
  • string

expires :Date

Data e hora da expiração desta resposta. O cliente poderá fazer cache desta resposta até a data e hora informada.

Type:
  • Date

statusCode :number

Status da resposta. Informe 2xx para indicar sucesso, 3xx para redirecionamento, 4xx para erros do cliente e 5xx para erros do servidor. Mais detalhes em http://en.wikipedia.org/wiki/List_of_HTTP_status_codes.

Type:
  • number

transferEncoding :string

Método de codificação da transferência de dados. Uma codificação de transferência é utilizada apenas no transporte dos dados e não altera o tipo de codificação utilizado na resposta, indicado por #contentEncoding. Valores possíveis: "none" e "chunked". Caso o protocolo em atendimento seja HTTP 1.1, o padrão será "chunked".

Type:
  • string

Methods

getAllHeaders()

Retorna um objeto com todas as propriedades atribuídas a um determinado response.

Returns:

Objeto com as propriedades e valores do response.

Type
any

redirect(uri [, opt_permanently])

Redireciona o requisitante para a URI informada.

Parameters:
Name Type Argument Description
uri string

Endereço destino do redirecionamento.
opt_permanently boolean <optional>

Determina se o redirecionamento é permanente e o cliente sempre pode ir diretamente para o destino. Caso não seja informado, será considerado false.

send()

Antecipa o envio da resposta para o cliente, antes de terminar a execução do script responsável pelo tratamento.

setCookie(name, value [, options])

Adiciona um cookie na resposta a ser enviada.

Parameters:
Name Type Argument Description
name string

Nome do cookie.
value string

Valor do cookie.
options Object <optional>

Opções do cookie.

Properties
Name Type Description
domain string

Domínio para o qual o cliente poderá enviar o cookie.
path string

Caminho da URL para a qual o cliente poderá enviar o cookie.
expires Date

Data e hora na qual o cookie perderá a validade.
secure boolean

Indica se o cookie somente poderá ser enviado em conexões HTTPS.
httpOnly boolean

Indica que o cookie deve ser utilizado exclusivamente no protocolo HTTP(S) e não estará acessível no ambiente JavaScript do cliente.
sameSite string

Determina se o envio do cookie em solicitações de site cruzados é permitido. Valores possíveis: 'Strict', 'Lax' e 'None'.

setHeader(name, value)

Atribui um valor a uma propriedade no header do response.

Parameters:
Name Type Description
name

Nome da propriedade que será inserida ou modificada.
value

Valor que será atribuído a propriedade indicada.

stop()

Interrompe o atendimento desta requisição, enviando a resposta até então elaborada.

stopAndRedirect(uri [, opt_permanently])

Interrompe o atendimento da requisição e redireciona o requisitante para a URI informada.

Parameters:
Name Type Argument Description
uri string

Endereço destino do redirecionamento.
opt_permanently boolean <optional>

Determina se o redirecionamento é permanente e o cliente sempre pode ir diretamente para o destino. Caso não seja informado, será considerado false.

write(content)

Adiciona o conteúdo informado na resposta a ser enviada para o cliente.

Parameters:
Name Type Description
content string | Uint8Array | ArrayBuffer

Conteúdo que será adicionado no final da resposta.

writeln(content)

Adiciona o conteúdo informado acrescido de um salto de linha Windows (códigos 13 e 10) na resposta a ser enviada para o cliente.

Parameters:
Name Type Description
content string | Uint8Array | ArrayBuffer

Conteúdo que será adicionado no final da resposta, acrescido de um salto de linha.
See: