): void;
/**
* Registers an observer for progress of receiving HTTP Response data events.
* @param { string } type Indicates Event name.
* @param { Callback<{ receiveSize: number, totalSize: number }> } callback - the callback of on.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
on(type: 'dataReceiveProgress', callback: Callback<{ receiveSize: number, totalSize: number }>): void;
/**
* Unregisters an observer for progress of receiving HTTP Response data events.
* @param { string } type Indicates Event name.
* @param { Callback<{ receiveSize: number, totalSize: number }> } callback - the callback of off.
* @syscap SystemCapability.Communication.NetStack
* @since 10
*/
off(type: 'dataReceiveProgress', callback?: Callback<{ receiveSize: number, totalSize: number }>): void;
}
/**
* Defines an HTTP request method.
* @enum {string}
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 6
*/
export enum RequestMethod {
/**
* OPTIONS method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
OPTIONS = "OPTIONS",
/**
* GET method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
GET = "GET",
/**
* HEAD method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
HEAD = "HEAD",
/**
* POST method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
POST = "POST",
/**
* PUT method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
PUT = "PUT",
/**
* DELETE method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
DELETE = "DELETE",
/**
* TRACE method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
TRACE = "TRACE",
/**
* CONNECT method.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
CONNECT = "CONNECT"
}
/**
* Enumerates the response codes for an HTTP request.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 6
*/
export enum ResponseCode {
/**
* The request was successful. Typically used for GET and POST requests.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
OK = 200,
/**
* Successfully requested and created a new resource.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
CREATED,
/**
* The request has been accepted but has not been processed completely.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
ACCEPTED,
/**
* Unauthorized information. The request was successful.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
NOT_AUTHORITATIVE,
/**
* No content. The server successfully processed, but did not return content.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
NO_CONTENT,
/**
* Reset the content.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
RESET,
/**
* Partial content. The server successfully processed some GET requests.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
PARTIAL,
/**
* Multiple options.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
MULT_CHOICE = 300,
/**
* Permanently move. The requested resource has been permanently moved to a new URI,
* and the returned information will include the new URI. The browser will automatically redirect to the new URI.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
MOVED_PERM,
/**
* Temporary movement.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
MOVED_TEMP,
/**
* View other addresses.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
SEE_OTHER,
/**
* Not modified.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
NOT_MODIFIED,
/**
* Using proxies.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
USE_PROXY,
/**
* The server cannot understand the syntax error error requested by the client.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
BAD_REQUEST = 400,
/**
* Request for user authentication.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
UNAUTHORIZED,
/**
* Reserved for future use.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
PAYMENT_REQUIRED,
/**
* The server understands the request from the requesting client, but refuses to execute it.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
FORBIDDEN,
/**
* The server was unable to find resources (web pages) based on the client's request.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
NOT_FOUND,
/**
* The method in the client request is prohibited.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
BAD_METHOD,
/**
* The server is unable to complete the request based on the content characteristics requested by the client.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
NOT_ACCEPTABLE,
/**
* Request authentication of the proxy's identity.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
PROXY_AUTH,
/**
* The request took too long and timed out.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
CLIENT_TIMEOUT,
/**
* The server may have returned this code when completing the client's PUT request,
* as there was a conflict when the server was processing the request.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
CONFLICT,
/**
* The resource requested by the client no longer exists.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
GONE,
/**
* The server is unable to process request information sent by the client without Content Length.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
LENGTH_REQUIRED,
/**
* The prerequisite for requesting information from the client is incorrect.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
PRECON_FAILED,
/**
* The request was rejected because the requested entity was too large for the server to process.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
ENTITY_TOO_LARGE,
/**
* The requested URI is too long (usually a URL) and the server cannot process it.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
REQ_TOO_LONG,
/**
* The server is unable to process the requested format.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
UNSUPPORTED_TYPE,
/**
* Internal server error, unable to complete the request.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
INTERNAL_ERROR = 500,
/**
* The server does not support the requested functionality and cannot complete the request.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
NOT_IMPLEMENTED,
/**
* The server acting as a gateway or proxy received an invalid request from the remote server.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
BAD_GATEWAY,
/**
* Due to overload or system maintenance, the server is temporarily unable to process client requests.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
UNAVAILABLE,
/**
* The server acting as a gateway or proxy did not obtain requests from the remote server in a timely manner.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
GATEWAY_TIMEOUT,
/**
* The version of the HTTP protocol requested by the server.
* @syscap SystemCapability.Communication.NetStack
* @since 6
*/
VERSION
}
/**
* Supported protocols.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 9
*/
export enum HttpProtocol {
/**
* Protocol http1.1
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
HTTP1_1,
/**
* Protocol http2
* @syscap SystemCapability.Communication.NetStack
* @since 9
*/
HTTP2,
}
/**
* Indicates the type of the returned data.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 9
*/
export enum HttpDataType {
/**
* The returned type is string.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 6
*/
STRING,
/**
* The returned type is Object.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 6
*/
OBJECT = 1,
/**
* The returned type is ArrayBuffer.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 6
*/
ARRAY_BUFFER = 2,
}
/**
* Defines the response to an HTTP request.
* @interface HttpResponse
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 6
*/
export interface HttpResponse {
/**
* result can be a string (API 6) or an ArrayBuffer(API 8). Object is deprecated from API 8.
* If {@link HttpRequestOptions#expectDataType} is set, the system preferentially returns this parameter.
* @type {string | Object | ArrayBuffer}
* @crossplatform
* @since 6
*/
result: string | Object | ArrayBuffer;
/**
* If the resultType is string, you can get result directly.
* If the resultType is Object, you can get result such as this: result['key'].
* If the resultType is ArrayBuffer, you can use ArrayBuffer to create the binary objects.
* @type {HttpDataType}
* @crossplatform
* @since 9
*/
resultType: HttpDataType;
/**
* Server status code.
* @type {ResponseCode | number}
* @crossplatform
* @since 6
*/
responseCode: ResponseCode | number;
/**
* All headers in the response from the server.
* @type {Object}
* @crossplatform
* @since 6
*/
header: Object;
/**
* Cookies returned by the server.
* @type {string}
* @crossplatform
* @since 8
*/
cookies: string;
}
/**
* Creates a default {@code HttpResponseCache} object to store the responses of HTTP access requests.
* @param { number } cacheSize the size of cache(max value is 10MB), default is 10*1024*1024(10MB).
* @returns { HttpResponseCache } the HttpResponseCache of the createHttpResponseCache.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 9
*/
function createHttpResponseCache(cacheSize?: number): HttpResponseCache;
/**
* Defines an object that stores the response to an HTTP request.
* @interface HttpResponseCache
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 9
*/
export interface HttpResponseCache {
/**
* Writes data in the cache to the file system so that all the cached data can be accessed in the next HTTP request.
* @param { AsyncCallback } callback Returns the callback of flush.
* @systemapi Hide this for inner system use.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 9
*/
flush(callback: AsyncCallback): void;
/**
* Writes data in the cache to the file system so that all the cached data can be accessed in the next HTTP request.
* @returns { Promise } The promise returned by the flush.
* @systemapi Hide this for inner system use.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 9
*/
flush(): Promise;
/**
* Disables a cache and deletes the data in it.
* @param { AsyncCallback } callback Returns the callback of delete.
* @systemapi Hide this for inner system use.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 9
*/
delete(callback: AsyncCallback): void;
/**
* Disables a cache and deletes the data in it.
* @returns { Promise } The promise returned by the delete.
* @systemapi Hide this for inner system use.
* @syscap SystemCapability.Communication.NetStack
* @crossplatform
* @since 9
*/
delete(): Promise;
}
}
export default http;