类 HttpRequest

En

The HttpRequest class encapsulates the HTML XMLHttpRequest object to provide full access to the HTTP protocol, including the ability to make POST and HEAD requests as well as regular GET requests. HttpRequest only provides asynchronous responses from web servers and can return content in either text or binary form.

  • Note: It is recommended to use a new HttpRequest object for each request, as each call to the send method of this object will clear previously set data and reset the HTTP request status. This can cause previously unreturned responses to be reset, resulting in the loss of response results from previous requests.
  • EventType Event.PROGRESS: Dispatch when the request progress changes.
  • EventType Event.COMPLETE: Dispatch after the request ends.
  • EventType Event.ERROR: Dispatch when the request fails.

Zh

HttpRequest 类通过封装 HTML XMLHttpRequest 对象提供了对 HTTP 协议的完全访问，包括发送 POST 和 HEAD 请求以及普通的 GET 请求的能力。HttpRequest 只以异步形式返回 Web 服务器的响应，并且能够以文本或二进制形式返回内容。

  • 注意：建议每次请求都使用新的 HttpRequest 对象，因为每次调用该对象的 send 方法时，都会清空之前设置的数据，并重置 HTTP 请求的状态，这会导致之前还未返回响应的请求被重置，从而得不到之前请求的响应结果。
  • EventType Event.PROGRESS: 请求进度改变时调度。
  • EventType Event.COMPLETE: 请求结束后调度。
  • EventType Event.ERROR: 请求出错时调度。

层级 (查看层级一览)

构造函数

constructor

访问器

data http url

方法

event hasListener off offAll offAllCaller on once reset send

构造函数

constructor

访问器

data

http

  • get http(): any

    返回 any

    En

    The reference to the native XMLHttpRequest object encapsulated by this object.

    Zh

    本对象所封装的原生 XMLHttpRequest 引用。

url

方法

event

  • event(type: string, data?: any): boolean

    参数

    • type: string

      The type of event.

    • 可选data: any

      (Optional) Data to pass to the callback. If multiple parameters p1, p2, p3, ... need to be passed, use an array structure such as [p1, p2, p3, ...]. If a single parameter p needs to be passed and p is an array, use a structure such as [p]. For other single parameters p, you can directly pass parameter p. If data is Event.EMPTY, it means passing an Event object to the callback function. Note that it is not passing Event.TEMP, but an independent Event object.

    返回 boolean

    True if there are listeners for this event type, false otherwise.

    En

    Dispatch an event.

    Zh

    派发事件。

hasListener

  • hasListener(type: string): boolean

    参数

    • type: string

      The type of event.

    返回 boolean

    True if a listener of the specified type is registered, false otherwise.

    En

    Check if the EventDispatcher object has any listeners registered for a specific type of event.

    Zh

    检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。

off

offAll

offAllCaller

on

  • on(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

  • on(type: string, caller: any, listener: Function, args?: any[]): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知。

once

  • once(type: string, listener: Function): EventDispatcher

    参数

    • type: string

      The type of event.

    • listener: Function

      The listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

  • once(
        type: string,
        caller: any,
        listener: Function,
        args?: any[],
    ): EventDispatcher

    参数

    • type: string

      The type of event.

    • caller: any

      The execution scope of the event listener function.

    • listener: Function

      The listener function.

    • 可选args: any[]

      (Optional) The callback parameters of the event listener function.

    返回 EventDispatcher

    This EventDispatcher object.

    En

    Register an event listener object with the EventDispatcher object so that the listener receives event notifications. This event listener responds once and is automatically removed after the first call.

    Zh

    使用 EventDispatcher 对象注册指定类型的事件侦听器对象，以使侦听器能够接收事件通知，此侦听事件响应一次后自动移除。

reset

  • reset(): void

    返回 void

    En

    Reset the HttpRequest object, clearing all event listeners and data.

    Zh

    重置 HttpRequest 对象，清除所有事件监听器和数据。

send

  • send(
        url: string,
        data?: any,
        method?: "head" | "get" | "post",
        responseType?: "text" | "json" | "xml" | "arraybuffer",
        headers?: string[],
    ): void

    参数

    • url: string

      The URL to request. Most browsers implement a same-origin security policy and require that the URL has the same hostname and port as the script.

    • data: any = null

      (default = null) The data to be sent.

    • method: "head" | "get" | "post" = "get"

      (default = "get") The HTTP method used for the request. Values include "get", "post", "head".

    • responseType: "text" | "json" | "xml" | "arraybuffer" = "text"

      (default = "text") The response type from the web server, can be set to "text", "json", "xml", "arraybuffer".

    • 可选headers: string[]

      (default = null) The header information for the HTTP request. Parameters are in the form of a key-value array: key is the name of the header, should not include whitespace, colon, or newline; value is the value of the header, should not include newline. For example ["Content-Type", "application/json"].

    返回 void

    En

    Send an HTTP request.

    Zh

    发送 HTTP 请求。

显示设置

成员可见性

目录

构造函数
访问器
方法