Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

HTTPClient

Eredita: RefCounted < Object

Client di protocollo di trasferimento ipertestuale di basso livello.

Descrizione

Hyper-text transfer protocol client (sometimes called "User Agent"). Used to make HTTP requests to download web content, upload files and other data or to communicate with various services, among other use cases.

See the HTTPRequest node for a higher-level alternative.

Note: This client only needs to connect to a host once (see connect_to_host()) to send multiple requests. Because of this, methods that take URLs usually take just the part after the host instead of the full URL, as the client is already connected to a host. See request() for a full example and to get started.

An HTTPClient should be reused between multiple requests or to connect to different hosts instead of creating one client per request. Supports Transport Layer Security (TLS), including server certificate verification. HTTP status codes in the 2xx range indicate success, 3xx redirection (i.e. "try again, but over here"), 4xx something was wrong with the request, and 5xx something went wrong on the server's side.

For more information on HTTP, see MDN's documentation on HTTP (or read RFC 2616 to get it straight from the source).

Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.

Note: It's recommended to use transport encryption (TLS) and to avoid sending sensitive information (such as login credentials) in HTTP GET URL parameters. Consider using HTTP POST requests or HTTP headers for such information instead.

Note: When performing HTTP requests from a project exported to Web, keep in mind the remote server may not allow requests from foreign origins due to CORS. If you host the server in question, you should modify its backend to allow requests from foreign origins by adding the Access-Control-Allow-Origin: * HTTP header.

Note: TLS support is currently limited to TLSv1.2 and TLSv1.3. Attempting to connect to a server that only supports older (insecure) TLS versions will return an error.

Warning: TLS certificate revocation and certificate pinning are currently not supported. Revoked certificates are accepted as long as they are otherwise valid. If this is a concern, you may want to use automatically managed certificates with a short validity period.

Tutorial

Proprietà

bool

blocking_mode_enabled

false

StreamPeer

connection

int

read_chunk_size

65536

Metodi

void

close()

Error

connect_to_host(host: String, port: int = -1, tls_options: TLSOptions = null)

int

get_response_body_length() const

int

get_response_code() const

PackedStringArray

get_response_headers()

Dictionary

get_response_headers_as_dictionary()

Status

get_status() const

bool

has_response() const

bool

is_response_chunked() const

Error

poll()

String

query_string_from_dict(fields: Dictionary)

PackedByteArray

read_response_body_chunk()

Error

request(method: Method, url: String, headers: PackedStringArray, body: String = "")

Error

request_raw(method: Method, url: String, headers: PackedStringArray, body: PackedByteArray)

void

set_http_proxy(host: String, port: int)

void

set_https_proxy(host: String, port: int)

Enumerazioni

enum Method: 🔗

Method METHOD_GET = 0

Metodo HTTP GET. Il metodo GET richiede una rappresentazione della risorsa specificata. Le richieste che utilizzano GET dovrebbero recuperare solo dati.

Method METHOD_HEAD = 1

Metodo HTTP HEAD. Il metodo HEAD richiede una risposta identica a quella di una richiesta GET, ma senza il corpo della risposta. Questo è utile per richiedere metadati come intestazioni HTTP o per verificare se una risorsa esiste.

Method METHOD_POST = 2

Metodo HTTP POST. Il metodo POST è utilizzato per inviare un'entità alla risorsa specificata, spesso causando un cambiamento di stato sul server. È spesso utilizzato per i moduli, per inviare dati o caricare file.

Method METHOD_PUT = 3

Metodo HTTP PUT. Il metodo PUT chiede di sostituire tutte le rappresentazioni attuali della risorsa di destinazione con il payload della richiesta. (Si può pensare "POST" come un metodo per "creare o aggiornare" e PUT come per "aggiornare", sebbene molti servizi non facciano la distinzione o cambino il loro significato).

Method METHOD_DELETE = 4

Metodo HTTP DELETE. Il metodo DELETE richiede di eliminare la risorsa specificata.

Method METHOD_OPTIONS = 5

Metodo HTTP OPTIONS. Il metodo OPTIONS chiede una descrizione delle opzioni di comunicazione per la risorsa di destinazione. È raramente utilizzato.

Method METHOD_TRACE = 6

Metodo HTTP TRACE. Il metodo TRACE effettua un test di ciclo dei messaggi seguendo il percorso della risorsa di destinazione. Restituisce l'intera richiesta HTTP ricevuta nel corpo della risposta. È raramente utilizzato.

Method METHOD_CONNECT = 7

Metodo HTTP CONNECT. Il metodo CONNECT stabilisce un tunnel verso il server identificato dalla risorsa di destinazione. È raramente utilizzato.

Method METHOD_PATCH = 8

Metodo HTTP PATCH. Il metodo PATCH è utilizzato per applicare modifiche parziali a una risorsa.

Method METHOD_MAX = 9

Rappresenta la dimensione dell'enumerazione Method.

enum Status: 🔗

Status STATUS_DISCONNECTED = 0

Stato: Disconnesso dal server.

Status STATUS_RESOLVING = 1

Stato: Attualmente risolvendo il nome host per l'URL specificato in un IP.

Status STATUS_CANT_RESOLVE = 2

Stato: Errore di DNS: Impossibile risolvere il nome host per l'URL specificato.

Status STATUS_CONNECTING = 3

Stato: Connessione al server in corso.

Status STATUS_CANT_CONNECT = 4

Stato: Impossibile connettersi al server.

Status STATUS_CONNECTED = 5

Stato: Connessione stabilita.

Status STATUS_REQUESTING = 6

Stato: Richiesta in fase di invio.

Status STATUS_BODY = 7

Stato: Corpo HTTP ricevuto.

Status STATUS_CONNECTION_ERROR = 8

Stato: Errore nella connessione HTTP.

Status STATUS_TLS_HANDSHAKE_ERROR = 9

Stato: Errore nell'handshake TLS.

enum ResponseCode: 🔗

ResponseCode RESPONSE_CONTINUE = 100

Codice di stato HTTP 100 Continua. Risposta provvisoria che indica che finora tutto è OK e che il client deve continuare con la richiesta (o ignorare questo stato se è già terminato).

ResponseCode RESPONSE_SWITCHING_PROTOCOLS = 101

Codice di stato HTTP 101 Switching Protocol. Inviato in risposta a un'intestazione di richiesta Upgrade dal client. Indica il protocollo a cui il server sta passando.

ResponseCode RESPONSE_PROCESSING = 102

Codice di stato HTTP 102 Processing (WebDAV). Indica che il server ha ricevuto e sta elaborando la richiesta, ma nessuna risposta è ancora disponibile.

ResponseCode RESPONSE_OK = 200

Codice di stato HTTP 200 OK. La richiesta è andata a buon fine. Risposta predefinita per le richieste riuscite. Il significato varia a seconda della richiesta:

  • METHOD_GET: La risorsa è stata recuperata ed è trasmessa nel corpo del messaggio.

  • METHOD_HEAD: Le intestazioni dell'ente si trovano nel corpo del messaggio.

  • METHOD_POST: La risorsa che descrive il risultato dell'azione è trasmessa nel corpo del messaggio.

  • METHOD_TRACE: Il corpo del messaggio contiene il messaggio di richiesta come ricevuto dal server.

ResponseCode RESPONSE_CREATED = 201

Codice di stato HTTP 201 Created. La richiesta è andata a buon fine e come risultato è stata creata una nuova risorsa. Questa è in genere la risposta inviata dopo una richiesta PUT.

ResponseCode RESPONSE_ACCEPTED = 202

Codice di stato HTTP 202 Accepted. La richiesta è stata ricevuta ma non è ancora stata elaborata. Non viene inviata alcuna risposta, nemmeno in modo asincrono, che indichi il risultato dell'elaborazione di questa richiesta. È destinato ai casi in cui un altro processo o server gestisce la richiesta o per l'elaborazione batch.

ResponseCode RESPONSE_NON_AUTHORITATIVE_INFORMATION = 203

Codice di stato HTTP 203 Non-Authoritative Information. Questo codice di risposta significa che l'insieme di meta-informazioni restituito non è la copia esatta dell'insieme presenti sul server di origine, ma composto da una copia locale o di terze parti. Tranne che in questo caso, è preferibile la risposta 200 OK al posto di questa risposta.

ResponseCode RESPONSE_NO_CONTENT = 204

Codice di stato HTTP 204 No Content. Non c'è alcun contenuto da inviare per questa richiesta, ma le intestazioni potrebbero essere utili. L'agente utente potrebbe aggiornare le sue intestazioni memorizzate nella cache per questa risorsa con quelle nuove.

ResponseCode RESPONSE_RESET_CONTENT = 205

Codice di stato HTTP 205 Reset Content. Il server ha soddisfatto la richiesta e desidera che il client reimposti la "vista del documento", che ha provocato l'invio della richiesta, al suo stato originale come ricevuto dal server di origine.

ResponseCode RESPONSE_PARTIAL_CONTENT = 206

Codice di stato HTTP 206 Partial Content. Questo codice di risposta è utilizzato a causa di un'intestazione di intervallo inviata dal client per separare il download in più flussi.

ResponseCode RESPONSE_MULTI_STATUS = 207

Codice di stato HTTP 207 Multi-Status (WebDAV). Una risposta Multi-Status trasmette informazioni su più risorse in situazioni in cui più codici di stato potrebbero essere appropriati.

ResponseCode RESPONSE_ALREADY_REPORTED = 208

Codice di stato HTTP 208 Already Reported (WebDAV). Utilizzato all'interno di un elemento di risposta DAV: propstat per evitare di enumerare ripetutamente i membri interni di più associazioni alla stessa collezione.

ResponseCode RESPONSE_IM_USED = 226

Codice di stato HTTP 226 IM used (WebDAV). Il server ha soddisfatto una richiesta GET per la risorsa e la risposta è una rappresentazione del risultato di una o più manipolazioni di istanza applicate all'istanza attuale.

ResponseCode RESPONSE_MULTIPLE_CHOICES = 300

Codice di stato HTTP 300 Multiple Choice. La richiesta contiene più di una risposta possibile e non esiste un modo standardizzato per sceglierne una. L'agente utente o l'utente devono sceglierne una.

ResponseCode RESPONSE_MOVED_PERMANENTLY = 301

Codice di stato HTTP 301 Moved Permanently. Reindirizzamento. Questo codice di risposta indica che l'URI della risorsa richiesta è stato modificato. Il nuovo URI è solitamente incluso nella risposta.

ResponseCode RESPONSE_FOUND = 302

Codice di stato HTTP 302 Found. Reindirizzamento temporaneo. Questo codice di risposta significa che l'URI della risorsa richiesta è stato modificato temporaneamente. Nuove modifiche all'URI potrebbero essere apportate in futuro. Pertanto, questo stesso URI dovrebbe essere utilizzato dal client nelle richieste future.

ResponseCode RESPONSE_SEE_OTHER = 303

Codice di stato HTTP 303 See Other. Il server sta reindirizzando l'agente utente a una risorsa diversa, come indicato da un URI nel campo dell'intestazione Location, che ha lo scopo di fornire una risposta indiretta alla richiesta originale.

ResponseCode RESPONSE_NOT_MODIFIED = 304

Codice di stato HTTP 304 Not Modified. È stata ricevuta una richiesta GET o HEAD condizionale che avrebbe prodotto una risposta 200 OK se la condizione non fosse stata valutata come false.

ResponseCode RESPONSE_USE_PROXY = 305

Deprecato: Many clients ignore this response code for security reasons. It is also deprecated by the HTTP standard.

Codice di stato HTTP 305 Use Proxy.

ResponseCode RESPONSE_SWITCH_PROXY = 306

Deprecato: Many clients ignore this response code for security reasons. It is also deprecated by the HTTP standard.

Codice di stato HTTP 306 Switch Proxy.

ResponseCode RESPONSE_TEMPORARY_REDIRECT = 307

Codice di stato HTTP 307 Temporary Redirect. La risorsa di destinazione risiede temporaneamente sotto un URI diverso e l'agente utente NON DEVE modificare il metodo di richiesta se esegue un reindirizzamento automatico a tale URI.

ResponseCode RESPONSE_PERMANENT_REDIRECT = 308

Codice di stato HTTP 308 Permanent Redirect. Alla risorsa di destinazione è stato assegnato un nuovo URI permanente e tutti i riferimenti futuri a questa risorsa devono utilizzare uno degli URI allegati.

ResponseCode RESPONSE_BAD_REQUEST = 400

Codice di stato HTTP 400 Bad Request. La richiesta non è valida. Il server non può o non vuole elaborare la richiesta a causa di qualcosa che è percepito come un errore del client (ad esempio, sintassi della richiesta non corretta, framing del messaggio di richiesta non valido, contenuto della richiesta non valido o indirizzamento della richiesta ingannevole).

ResponseCode RESPONSE_UNAUTHORIZED = 401

Codice di stato HTTP 401 Unauthorized. Credenziali richieste. La richiesta non è stata applicata perché non dispone di credenziali di autenticazione valide per la risorsa di destinazione.

ResponseCode RESPONSE_PAYMENT_REQUIRED = 402

Codice di stato HTTP 402 Payment Required. Questo codice di risposta è riservato per un uso futuro. Lo scopo iniziale della creazione di questo codice era di utilizzarlo per i sistemi di pagamento digitale, tuttavia questo non è attualmente utilizzato.

ResponseCode RESPONSE_FORBIDDEN = 403

Codice di stato HTTP 403 Forbidden. Il client non ha diritti di accesso al contenuto, ovvero non è autorizzato, quindi il server rifiuta di fornire una risposta appropriata. A differenza di 401, l'identità del client è nota al server.

ResponseCode RESPONSE_NOT_FOUND = 404

Codice di stato HTTP 404 Not Found. Il server non riesce a trovare la risorsa richiesta. L'URL non è riconosciuto, oppure l'endpoint è valido ma la risorsa stessa non esiste. Può anche essere inviato al posto di 403 per nascondere l'esistenza di una risorsa se il client non è autorizzato.

ResponseCode RESPONSE_METHOD_NOT_ALLOWED = 405

Codice di stato HTTP 405 Method Not Allowed. Il metodo HTTP della richiesta è noto al server ma è stato disabilitato e non può essere utilizzato. Ad esempio, un'API potrebbe proibire di DELETE-ing di una risorsa. I due metodi obbligatori, GET e HEAD, non devono mai essere disabilitati e non devono restituire questo codice di errore.

ResponseCode RESPONSE_NOT_ACCEPTABLE = 406

Codice di stato HTTP 406 Not Acceptable. La risorsa di destinazione non ha una rappresentazione attuale che sarebbe accettabile per l'agente utente, in base ai campi di intestazione della negoziazione proattiva ricevuti nella richiesta. Utilizzato durante la negoziazione del contenuto.

ResponseCode RESPONSE_PROXY_AUTHENTICATION_REQUIRED = 407

Codice di stato HTTP 407 Proxy Authentication Required. Simile a 401 Non autorizzato, ma indica che il client deve autenticarsi per poter utilizzare un proxy.

ResponseCode RESPONSE_REQUEST_TIMEOUT = 408

Codice di stato HTTP 408 Request Timeout. Il server non ha ricevuto un messaggio di richiesta completo entro il tempo previsto per l'attesa.

ResponseCode RESPONSE_CONFLICT = 409

Codice di stato HTTP 409 Conflict. Non è stato possibile completare la richiesta a causa di un conflitto con lo stato attuale della risorsa di destinazione. Questo codice viene utilizzato in situazioni in cui l'utente potrebbe riuscire a risolvere il conflitto e inviare nuovamente la richiesta.

ResponseCode RESPONSE_GONE = 410

Codice di stato HTTP 410 Gone. La risorsa di destinazione non è più disponibile sul server di origine e questa condizione è probabilmente permanente.

ResponseCode RESPONSE_LENGTH_REQUIRED = 411

Codice di stato HTTP 411 Length Required. Il server rifiuta di accettare la richiesta senza un'intestazione Content-Length definita.

ResponseCode RESPONSE_PRECONDITION_FAILED = 412

Codice di stato HTTP 412 Precondition Failed. Una o più condizioni specificate nei campi di intestazione della richiesta sono state valutate come false quando testate sul server.

ResponseCode RESPONSE_REQUEST_ENTITY_TOO_LARGE = 413

Codice di stato HTTP 413 Entity Too Large. Il server si rifiuta di elaborare una richiesta perché il payload della richiesta è più grande di quanto il server sia disposto o capace di elaborare.

ResponseCode RESPONSE_REQUEST_URI_TOO_LONG = 414

Codice di stato HTTP 414 Request-URI Too Long. Il server rifiuta di soddisfare la richiesta perché l'obiettivo della richiesta è più lungo di quanto il server sia disposto a interpretare.

ResponseCode RESPONSE_UNSUPPORTED_MEDIA_TYPE = 415

Codice di stato HTTP 415 Unsupported Media Type. Il server di origine rifiuta di soddisfare la richiesta perché il payload è in un formato non supportato da questo metodo sulla risorsa di destinazione.

ResponseCode RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE = 416

Codice di stato HTTP 416 Requested Range Not Satisfiable. Nessuno degli intervalli nel campo Range dell'intestazione si sovrappone all'estensione attuale della risorsa selezionata, oppure l'insieme di intervalli richiesti è stato rifiutato a causa di intervalli non validi o di una richiesta eccessiva di intervalli piccoli o sovrapposti.

ResponseCode RESPONSE_EXPECTATION_FAILED = 417

Codice di stato HTTP 417 Expectation Failed. Non è stato possibile soddisfare le aspettative fornite nel campo di intestazione Expect da almeno uno dei server in entrata.

ResponseCode RESPONSE_IM_A_TEAPOT = 418

Codice di stato HTTP 418 I'm A Teapot. Ogni tentativo di preparare il caffè con una teiera dovrebbero restituire il codice di errore "418 I'm a teapot". Il corpo dell'entità risultante POTREBBE essere corto e robusto.

ResponseCode RESPONSE_MISDIRECTED_REQUEST = 421

Codice di stato HTTP 421 Misdirected Request. La richiesta è stata indirizzata a un server che non è in grado di produrre una risposta. Questo può essere inviato da un server che non è configurato per produrre risposte per la combinazione di schema e autorità che sono inclusi nell'URI della richiesta.

ResponseCode RESPONSE_UNPROCESSABLE_ENTITY = 422

Codice di stato HTTP 422 Unprocessable Entity (WebDAV). Il server comprende il tipo di contenuto dell'entità della richiesta (quindi un codice di stato 415 Unsupported Media Type è inadeguato), e la sintassi dell'entità della richiesta è corretta (quindi un codice di stato 400 Bad Request è inadeguato) ma non ha potuto elaborare le istruzioni contenute.

ResponseCode RESPONSE_LOCKED = 423

Codice di stato HTTP 423 Locked (WebDAV). La risorsa di origine o di destinazione di un metodo è bloccata.

ResponseCode RESPONSE_FAILED_DEPENDENCY = 424

Codice di stato HTTP 424 Failed Dependency (WebDAV). Non è stato possibile eseguire il metodo sulla risorsa perché l'azione richiesta dipendeva su un'altra azione e tale azione non è andata a buon fine.

ResponseCode RESPONSE_UPGRADE_REQUIRED = 426

Codice di stato HTTP 426 Upgrade Required. Il server si rifiuta di eseguire la richiesta utilizzando il protocollo attuale ma potrebbe essere disposto a farlo dopo che il cliente si aggiorna a un protocollo diverso.

ResponseCode RESPONSE_PRECONDITION_REQUIRED = 428

Codice di stato HTTP 426 Precondition Required. Il server di origine richiede che la richiesta sia condizionale.

ResponseCode RESPONSE_TOO_MANY_REQUESTS = 429

Codice di stato HTTP 429 Too Many Requests. L'utente ha inviato troppe richieste in un determinato periodo di tempo (vedi "rate limiting"). Arretra e aumenta il tempo tra una richiesta e l'altra o riprova più tardi.

ResponseCode RESPONSE_REQUEST_HEADER_FIELDS_TOO_LARGE = 431

Codice di stato HTTP 431 Request Header Fields Too Large. Il server non è disposto a elaborare la richiesta perché i suoi campi di intestazione sono troppo grandi. La richiesta POTREBBE essere reinviata dopo aver ridotto le dimensioni dei campi di intestazione della richiesta.

Codice di stato HTTP 451 Response Unavailable for Legal Reasons. Il server sta negando l'accesso alla risorsa a seguito di una richiesta legale.

ResponseCode RESPONSE_INTERNAL_SERVER_ERROR = 500

Codice di stato HTTP 500 Internal Server Error. Il server ha riscontrato una condizione imprevista che gli ha impedito di soddisfare la richiesta.

ResponseCode RESPONSE_NOT_IMPLEMENTED = 501

Codice di stato HTTP 501 Not Implemented. Il server non supporta le funzionalità necessarie per completare la richiesta.

ResponseCode RESPONSE_BAD_GATEWAY = 502

Codice di stato HTTP 502 Bad Gateway. Il server, mentre fungeva da gateway o proxy, ha ricevuto una risposta non valida da un server in entrata a cui aveva avuto accesso mentre tentava di soddisfare la richiesta. Solitamente restituito da bilanciatori di carico o proxy.

ResponseCode RESPONSE_SERVICE_UNAVAILABLE = 503

Codice di stato HTTP 503 Service Unavailable. Il server non è attualmente in grado di gestire la richiesta a causa di un sovraccarico temporaneo o di una manutenzione pianificata, che probabilmente sarà risolta con un certo ritardo. Riprova più tardi.

ResponseCode RESPONSE_GATEWAY_TIMEOUT = 504

Codice di stato HTTP 504 Gateway Timeout. Il server, mentre fungeva da gateway o proxy, non ha ricevuto una risposta in tempo da un server upstream a cui doveva accedere per completare la richiesta. Solitamente restituito da bilanciatori di carico o proxy.

ResponseCode RESPONSE_HTTP_VERSION_NOT_SUPPORTED = 505

Codice di stato HTTP 505 HTTP Version Not Supported. Il server non supporta o si rifiuta di supportare la versione principale di HTTP utilizzata nel messaggio di richiesta.

ResponseCode RESPONSE_VARIANT_ALSO_NEGOTIATES = 506

Codice di stato HTTP 506 Variant Also Negotiates. Il server ha un errore di configurazione interno: la risorsa variante scelta è essa stessa configurata per impegnarsi nella negoziazione del contenuto trasparente, e pertanto non è un punto finale corretto nel processo di negoziazione.

ResponseCode RESPONSE_INSUFFICIENT_STORAGE = 507

Codice di stato HTTP 507 Insufficient Storage. Il metodo non può essere eseguito sulla risorsa perché il server non è in grado di memorizzare la rappresentazione necessaria per completare con successo la richiesta.

ResponseCode RESPONSE_LOOP_DETECTED = 508

Codice di stato HTTP 508 Loop Detected. Il server ha terminato un'operazione perché ha riscontrato un ciclo infinito durante l'elaborazione di una richiesta con "Depth: infinity". Questo stato indica che l'intera operazione non è riuscita.

ResponseCode RESPONSE_NOT_EXTENDED = 510

Codice di stato HTTP 510 Not Extended. La policy per l'accesso alla risorsa non è stata soddisfatta nella richiesta. Il server dovrebbe restituire tutte le informazioni necessarie affinché il client invii una richiesta estesa.

ResponseCode RESPONSE_NETWORK_AUTH_REQUIRED = 511

Codice di stato HTTP 511 Network Authentication Required. Il client deve autenticarsi per ottenere l'accesso alla rete.

Descrizioni delle proprietà

bool blocking_mode_enabled = false 🔗

  • void set_blocking_mode(value: bool)

  • bool is_blocking_mode_enabled()

Se true, l'esecuzione sarà bloccata finché tutti i dati non saranno letti dalla risposta.

StreamPeer connection 🔗

La connessione da utilizzare per questo client.

int read_chunk_size = 65536 🔗

  • void set_read_chunk_size(value: int)

  • int get_read_chunk_size()

La dimensione del buffer utilizzato e il numero massimo di byte da leggere per ciascuna iterazione. Vedi read_response_body_chunk().

Descrizioni dei metodi

void close() 🔗

Chiude la connessione attuale, consentendone il riutilizzo per questo HTTPClient.

Error connect_to_host(host: String, port: int = -1, tls_options: TLSOptions = null) 🔗

Si collega a un host. Ciò deve essere fatto prima che vengano inviate richieste.

Se non viene specificata alcuna porta (port) (o si utilizza -1), è automaticamente impostata su 80 per HTTP e 443 per HTTPS. È possibile passare il parametro facoltativo tls_options per personalizzare le autorità di certificazione attendibili o la verifica del nome comune quando si utilizza HTTPS. Consulta TLSOptions.client() e TLSOptions.client_unsafe().

int get_response_body_length() const 🔗

Restituisce la lunghezza del corpo della risposta.

Nota: Alcuni server Web potrebbero non inviare una lunghezza del corpo. In questo caso, il valore restituito sarà -1. Anche se si utilizza la codifica di trasferimento in blocchi, la lunghezza del corpo sarà -1.

Nota: Questa funzione restituisce sempre -1 sulla piattaforma Web a causa delle limitazioni dei browser.

int get_response_code() const 🔗

Restituisce il codice di stato della risposta HTTP.

PackedStringArray get_response_headers() 🔗

Restituisce le intestazioni della risposta.

Dictionary get_response_headers_as_dictionary() 🔗

Restituisce tutte le intestazioni della risposta come Dictionary. Ogni voce è composta dal nome dell'intestazione e da una String contenente i valori separati da "; ". Le maiuscole e le minuscole sono mantenute uguali a quelle delle intestazioni ricevute.

{
    "content-length": 12,
    "Content-Type": "application/json; charset=UTF-8",
}

Status get_status() const 🔗

Restituisce una costante di Status. È necessario chiamare poll() per aggiornare lo stato.

bool has_response() const 🔗

Se true, questo HTTPClient ha una risposta disponibile.

bool is_response_chunked() const 🔗

Se true, questo HTTPClient riceve una risposta in diverse parti.

Error poll() 🔗

Questa chiamata deve essere eseguita per elaborare qualsiasi richiesta. Verifica i risultati con get_status().

String query_string_from_dict(fields: Dictionary) 🔗

Genera una stringa di richiesta in stile GET/POST application/x-www-form-urlencoded da un dizionario fornito, ad esempio:

var fields = { "username": "user", "password": "pass" }
var query_string = http_client.query_string_from_dict(fields)
# Restituisce "username=user&password=pass"

Inoltre, se una chiave ha un valore null, solo la chiave stessa viene aggiunta, senza segno di uguale e valore. Se il valore è un array, per ogni valore in esso contenuto viene aggiunta una coppia con la stessa chiave.

var fields = { "single": 123, "not_valued": null, "multiple": [22, 33, 44] }
var query_string = http_client.query_string_from_dict(fields)
# Restituisce "single=123&not_valued&multiple=22&multiple=33&multiple=44"

PackedByteArray read_response_body_chunk() 🔗

Legge una parte della risposta.

Error request(method: Method, url: String, headers: PackedStringArray, body: String = "") 🔗

Invia una richiesta all'host connesso.

Il parametro URL è solitamente solo la parte dopo l'host, quindi per https://somehost.com/index.php, è /index.php. Quando si inviano richieste a un server proxy HTTP, dovrebbe essere un URL assoluto. Per le richieste METHOD_OPTIONS, è consentito anche *. Per le richieste METHOD_CONNECT, dovrebbe essere il componente autorità (host:port).

Le intestazioni sono intestazioni di richiesta HTTP.

Per creare una richiesta POST con stringhe di richiesta da inviare al server, usa:

var fields = { "username" : "user", "password" : "pass" }
var query_string = http_client.query_string_from_dict(fields)
var headers = ["Content-Type: application/x-www-form-urlencoded", "Content-Length: " + str(query_string.length())]
var result = http_client.request(http_client.METHOD_POST, "/index.php", headers, query_string)

Nota: Il parametro body viene ignorato se method è METHOD_GET. Questo perché i metodi GET non possono contenere dati di richiesta. Come alternativa, è possibile passare i dati di richiesta come stringa di richiesta nell'URL. Vedi String.uri_encode() per un esempio.

Error request_raw(method: Method, url: String, headers: PackedStringArray, body: PackedByteArray) 🔗

Invia una richiesta grezza all'host connesso con il metodo method.

Il parametro URL è solitamente solo la parte dopo l'host, quindi per https://somehost.com/index.php, è /index.php. Quando si inviano richieste a un server proxy HTTP, dovrebbe essere un URL assoluto. Per le richieste METHOD_OPTIONS, è consentito anche *. Per le richieste METHOD_CONNECT, dovrebbe essere il componente autoritativo (host:port).

Le intestazioni sono intestazioni di richiesta HTTP.

Invia i dati del corpo grezzi, come array di byte e non li codifica in alcun modo.

void set_http_proxy(host: String, port: int) 🔗

Imposta il server proxy per le richieste HTTP.

Il server proxy non è impostato se host è vuoto o port è -1.

void set_https_proxy(host: String, port: int) 🔗

Imposta il server proxy per le richieste HTTPS.

Il server proxy non è impostato se host è vuoto o port è -1.