HTTPRequest

A node with the ability to send HTTP requests.

Uses HTTPClient internally. Can be used to make HTTP requests, i.e. download or upload files or web content via HTTP.

@GodotBaseClass

struct HTTPRequest {

enum string _GODOT_internal_name;

union __anonymous;

alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses);

bool opEquals(HTTPRequest other);

HTTPRequest opAssign(T n);

bool opEquals(typeof(null) n);

mixin baseCasts ;

static HTTPRequest _new();

enum Constants;

GodotError request(StringArg0 url, PoolStringArray custom_headers, bool ssl_validate_domain, long method, StringArg4 request_data);

void cancelRequest();

HTTPClient.Status getHttpClientStatus();

void setUseThreads(bool enable);

bool isUsingThreads();

void setBodySizeLimit(long bytes);

long getBodySizeLimit();

void setMaxRedirects(long amount);

long getMaxRedirects();

void setDownloadFile(StringArg0 path);

String getDownloadFile();

long getDownloadedBytes();

long getBodySize();

void _redirectRequest(StringArg0 arg0);

void _requestDone(long arg0, long arg1, PoolStringArray arg2, PoolByteArray arg3);

String downloadFile [@property getter];

String downloadFile [@property setter];

bool useThreads [@property getter];

bool useThreads [@property setter];

long bodySizeLimit [@property getter];

long bodySizeLimit [@property setter];

long maxRedirects [@property getter];

long maxRedirects [@property setter];

}

Members

Aliases

BaseClasses alias BaseClasses = AliasSeq!(typeof(_GODOT_base), typeof(_GODOT_base).BaseClasses): Undocumented in source.

Enums

Constants enum Constants
Result enum Result

Functions

_redirectRequest void _redirectRequest(StringArg0 arg0)
_requestDone void _requestDone(long arg0, long arg1, PoolStringArray arg2, PoolByteArray arg3)
cancelRequest void cancelRequest(): Cancels the current request.
getBodySize long getBodySize(): Returns the response body length.
getBodySizeLimit long getBodySizeLimit()
getDownloadFile String getDownloadFile()
getDownloadedBytes long getDownloadedBytes(): Returns the amount of bytes this HTTPRequest downloaded.
getHttpClientStatus HTTPClient.Status getHttpClientStatus(): Returns the current status of the underlying HTTPClient. See STATUS_* enum on HTTPClient.
getMaxRedirects long getMaxRedirects()
isUsingThreads bool isUsingThreads()
opAssign HTTPRequest opAssign(T n): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(HTTPRequest other): Undocumented in source. Be warned that the author may not have intended to support it.
opEquals bool opEquals(typeof(null) n): Undocumented in source. Be warned that the author may not have intended to support it.
request GodotError request(StringArg0 url, PoolStringArray custom_headers, bool ssl_validate_domain, long method, StringArg4 request_data): Creates request on the underlying HTTPClient. If there is no configuration errors, it tries to connect using HTTPClient.connectToHost and passes parameters onto HTTPClient.request. Returns OK if request is successfully created. (Does not imply that the server has responded), ERR_UNCONFIGURED if not in the tree, ERR_BUSY if still processing previous request, ERR_INVALID_PARAMETER if given string is not a valid URL format, or ERR_CANT_CONNECT if not using thread and the HTTPClient cannot connect to host.
setBodySizeLimit void setBodySizeLimit(long bytes)
setDownloadFile void setDownloadFile(StringArg0 path)
setMaxRedirects void setMaxRedirects(long amount)
setUseThreads void setUseThreads(bool enable)

Mixins

__anonymous mixin baseCasts: Undocumented in source.

Properties

bodySizeLimit long bodySizeLimit [@property setter]: Maximum allowed size for response bodies.
bodySizeLimit long bodySizeLimit [@property getter]: Maximum allowed size for response bodies.
downloadFile String downloadFile [@property getter]
String downloadFile [@property setter]: The file to download into. Will output any received file into it.
maxRedirects long maxRedirects [@property getter]
long maxRedirects [@property setter]: Maximum number of allowed redirects.
useThreads bool useThreads [@property getter]
bool useThreads [@property setter]: If true multithreading is used to improve performance.

Static functions

_new HTTPRequest _new(): Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

_classBindingInitialized bool _classBindingInitialized;: Undocumented in source.

Structs

_classBinding struct _classBinding: Undocumented in source.

Unions

__anonymous union __anonymous: Undocumented in source.

Variables

_GODOT_internal_name enum string _GODOT_internal_name;: Undocumented in source.

Mixed In Members

From `mixin baseCasts`

as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as To as(): Undocumented in source. Be warned that the author may not have intended to support it.
as ToRef as(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast template opCast(To): Undocumented in source.
opCast template opCast(To): Undocumented in source.
opCast template opCast(ToRef): Undocumented in source.
opCast void* opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast godot_object opCast(): Undocumented in source. Be warned that the author may not have intended to support it.
opCast bool opCast(): Undocumented in source. Be warned that the author may not have intended to support it.

Meta

Source

See Implementation

godot httprequest structs

HTTPRequest