Class WebRequest

constructor

• new WebRequest(): WebRequest

  Returns WebRequest

StaticCustomRequestHeaders

StaticCustomRequestModifiers

StaticSkipRequestModificationForBabylonCDN

onprogress

• get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

  Gets or sets a function to be called when loading progress changes

  Returns ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

• set onprogress(
      value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null,
  ): void

  Parameters

  • value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null

  Returns void

readyState

• get readyState(): number

  Returns client's state

  Returns number

requestURL

• get requestURL(): string

  Returns the requested URL once open has been called

  Returns string

response

• get response(): any

  Returns client's response

  Returns any

responseText

• get responseText(): string

  Returns client's response as text

  Returns string

responseType

• get responseType(): XMLHttpRequestResponseType

  Gets or sets the expected response type

  Returns XMLHttpRequestResponseType

• set responseType(value: XMLHttpRequestResponseType): void

  Parameters

  • value: XMLHttpRequestResponseType

  Returns void

responseURL

• get responseURL(): string

  Returns client's response url

  Returns string

status

• get status(): number

  Returns client's status

  Returns number

statusText

• get statusText(): string

  Returns client's status as a text

  Returns string

timeout

• get timeout(): number

  Gets or sets the timeout value in milliseconds

  Returns number

• set timeout(value: number): void

  Parameters

  • value: number

  Returns void

StaticIsCustomRequestAvailable

• get IsCustomRequestAvailable(): boolean

  This function can be called to check if there are request modifiers for network requests

  Returns boolean

  true if there are any custom requests available

abort

• abort(): void

  Cancels any network activity

  Returns void

getResponseHeader

• getResponseHeader(name: string): Nullable<string>

  Get the string containing the text of a particular header's value.

  Parameters

  • name: string

    The name of the header

  Returns Nullable<string>

  The string containing the text of the given header name

open

• open(method: string, url: string, baseHeaders?: Record<string, string>): void

  Sets the request method, request URL

  Parameters

  • method: string

    defines the method to use (GET, POST, etc..)

  • url: string

    defines the url to connect with

  • OptionalbaseHeaders: Record<string, string>

    optional headers to include as a base before applying CustomRequestHeaders and modifiers

  Returns void

send

• send(body?: Document | XMLHttpRequestBodyInit | null): void

  Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD

  Parameters

  • Optionalbody: Document | XMLHttpRequestBodyInit | null

    defines an optional request body

  Returns void

setRequestHeader

• setRequestHeader(name: string, value: string): void

  Sets the value of a request header.

  Parameters

  • name: string

    The name of the header whose value is to be set

  • value: string

    The value to set as the body of the header

  Returns void

StaticFetchAsync

• FetchAsync(
      url: string,
      options?: {
          body?: BodyInit | null;
          headers?: Record<string, string>;
          method?: string;
      },
  ): Promise<Response>

  Performs a network request using the Fetch API when available on the platform, falling back to XMLHttpRequest. WebRequest.CustomRequestHeaders and WebRequest.CustomRequestModifiers are applied in both cases.

  For CustomRequestModifiers, a minimal proxy XHR is provided to each modifier so that calls to setRequestHeader on it are captured and forwarded to the underlying request. The URL returned by a modifier (if any) replaces the current URL before the next modifier runs.

  Parameters

  • url: string

    The URL to request.

  • options: { body?: BodyInit | null; headers?: Record<string, string>; method?: string } = {}

    Optional request options (method, headers, body).

  Returns Promise<Response>

  A Promise that resolves to a Response.