XMLHttpRequest.setRequestHeader()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

O método setRequestHeader() de XMLHttpRequest define o valor do cabeçalho de uma requisição HTTP. Ao usar setRequestHeader(), você deve chamá-lo depois de chamar o método open(), mas antes de chamar o método send(). Se esse método é chamado muitas vezes com o mesmo cabeçalho, os valores são somados em um único cabeçalho de requisição HTTP.

A cada vez que você chama setRequestHeader() depois de ter chamado-o pelo menos uma vez, o texto especificado é somado ao final do conteúdo do cabeçalho existente.

Se nenhum cabeçalho Accept foi definido usando este método, um cabeçalho Accept com o tipo "*/*" é enviado com a requisição quando send() é chamado.

Por razões de segurança, alguns cabeçalhos só podem ser controlados pelo agente do usuário. Esses cabeçalhos incluem o cabeçalho forbidden header names e o cabeçalho forbidden response header names.

Nota: Observação: Para seu campos personalizados, você pode encontrar uma exceção "not allowed by Access-Control-Allow-Headers in preflight response" quando você envia requisições através de domínios. Neste caso, você precisa definir o cabeçalho Access-Control-Allow-Headers no seu cabeçalho de resposta no lado do servidor.

Sintaxe

XMLHttpRequest.setRequestHeader(header, value)

Parâmetros

O nome do cabeçalho cujo valor está para ser definido.

value

O valor a ser definido como o corpo do cabeçalho.

Valor de retorno

undefined.

Especificações

Specification
XMLHttpRequest Standard
# the-setrequestheader()-method

Compatibilidade com navegadores

BCD tables only load in the browser

Veja também