Data Request

NOTE
The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import http from '@ohos.net.http';

Example

import http from '@ohos.net.http';

// Each HttpRequest corresponds to an HttpRequestTask object and cannot be reused.
let httpRequest = http.createHttp();
// Subscribe to the HTTP response header, which is returned earlier than HttpRequest. You can subscribe to HTTP Response Header events based on service requirements.
// on('headerReceive', AsyncCallback) will be replaced by on('headersReceive', Callback) in API version 8. 8+
httpRequest.on('headersReceive', (header) => {
    console.info('header: ' + JSON.stringify(header));
});
httpRequest.request(
    // Set the URL of the HTTP request. You need to define the URL. Set the parameters of the request in extraData.
    "EXAMPLE_URL",
    {
        method: http.RequestMethod.POST, // Optional. The default value is http.RequestMethod.GET.
        // You can add the header field based on service requirements.
        header: {
            'Content-Type': 'application/json'
        },
        // This field is used to transfer data when the POST request is used.
        extraData: {
            "data": "data to send",
        },
        connectTimeout: 60000, // Optional. The default value is 60000, in ms.
        readTimeout: 60000, // Optional. The default value is 60000, in ms.
    }, (err, data) => {
        if (!err) {
            // data.result contains the HTTP response. Parse the response based on service requirements.
            console.info('Result:' + data.result);
            console.info('code:' + data.responseCode);
            // data.header contains the HTTP response header. Parse the content based on service requirements.
            console.info('header:' + JSON.stringify(data.header));
            console.info('cookies:' + data.cookies); // 8+
        } else {
            console.info('error:' + JSON.stringify(err));
            // Call the destroy() method to release resources after the call is complete.
            httpRequest.destroy();
        }
    }
);

http.createHttp

createHttp(): HttpRequest

Creates an HTTP request. You can use this API to initiate or destroy an HTTP request, or enable or disable listening for HTTP Response Header events. An HttpRequest object corresponds to an HTTP request. To initiate multiple HTTP requests, you must create an HttpRequest object for each HTTP request.

System capability: SystemCapability.Communication.NetStack

Return value

Example

import http from '@ohos.net.http';
let httpRequest = http.createHttp();

HttpRequest

Defines an HttpRequest object. Before invoking HttpRequest APIs, you must call createHttp() to create an HttpRequestTask object.

request

request(url: string, callback: AsyncCallback<HttpResponse>):void

Initiates an HTTP request to a given URL. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetStack

Parameters

Example

httpRequest.request("EXAMPLE_URL", (err, data) => {
    if (!err) {
        console.info('Result:' + data.result);
        console.info('code:' + data.responseCode);
        console.info('header:' + JSON.stringify(data.header));
        console.info('cookies:' + data.cookies); // 8+
    } else {
        console.info('error:' + JSON.stringify(err));
    }
});

request

request(url: string, options: HttpRequestOptions, callback: AsyncCallback<HttpResponse>):void

Initiates an HTTP request containing specified options to a given URL. This API uses an asynchronous callback to return the result.

Required permission: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetStack

Parameters

Example

httpRequest.request("EXAMPLE_URL",
{
    method: http.RequestMethod.GET,
    header: {
        'Content-Type': 'application/json'
    },
    readTimeout: 60000,
    connectTimeout: 60000
}, (err, data) => {
    if (!err) {
        console.info('Result:' + data.result);
        console.info('code:' + data.responseCode);
        console.info('header:' + JSON.stringify(data.header));
        console.info('cookies:' + data.cookies); // 8+
        console.info('header.Content-Type:' + data.header['Content-Type']);
        console.info('header.Status-Line:' + data.header['Status-Line']);
    } else {
        console.info('error:' + JSON.stringify(err));
    }
});

request

request(url: string, options? : HttpRequestOptions): Promise<HttpResponse>

Initiates an HTTP request to a given URL. This API uses a promise to return the result.

Required permission: ohos.permission.INTERNET

System capability: SystemCapability.Communication.NetStack

Parameters

Return value

Example

let promise = httpRequest.request("EXAMPLE_URL", {
    method: http.RequestMethod.GET,
    connectTimeout: 60000,
    readTimeout: 60000,
    header: {
        'Content-Type': 'application/json'
    }
});
promise.then((data) => {
    console.info('Result:' + data.result);
    console.info('code:' + data.responseCode);
    console.info('header:' + JSON.stringify(data.header));
    console.info('cookies:' + data.cookies); // 8+
    console.info('header.Content-Type:' + data.header['Content-Type']);
    console.info('header.Status-Line:' + data.header['Status-Line']);
}).catch((err) => {
    console.info('error:' + JSON.stringify(err));
});

destroy

destroy(): void

Destroys an HTTP request.

System capability: SystemCapability.Communication.NetStack

Example

httpRequest.destroy();

on('headerReceive')

on(type: 'headerReceive', callback: AsyncCallback<Object>): void

Registers an observer for HTTP Response Header events.

NOTE

This API has been deprecated. You are advised to use on('headersReceive')⁸⁺ instead.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

httpRequest.on('headerReceive', (err, data) => {
    if (!err) {
        console.info('header: ' + JSON.stringify(data));
    } else {
        console.info('error:' + JSON.stringify(err));
    }
});

off('headerReceive')

off(type: 'headerReceive', callback?: AsyncCallback<Object>): void

Unregisters the observer for HTTP Response Header events.

NOTE

1. This API has been deprecated. You are advised to use off('headersReceive')⁸⁺ instead.

2. You can pass the callback of the on function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

httpRequest.off('headerReceive');

on('headersReceive')⁸⁺

on(type: 'headersReceive', callback: Callback<Object>): void

Registers an observer for HTTP Response Header events.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

httpRequest.on('headersReceive', (header) => {
    console.info('header: ' + JSON.stringify(header));
});

off('headersReceive')⁸⁺

off(type: 'headersReceive', callback?: Callback<Object>): void

Unregisters the observer for HTTP Response Header events.

NOTE

You can pass the callback of the on function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

httpRequest.off('headersReceive');

once('headersReceive')⁸⁺

once(type: 'headersReceive', callback: Callback<Object>): void

Registers a one-time observer for HTTP Response Header events. Once triggered, the observer will be removed. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.Communication.NetStack

Parameters

Example

httpRequest.once('headersReceive', (header) => {
    console.info('header: ' + JSON.stringify(header));
});

HttpRequestOptions

Specifies the type and value range of the optional parameters in the HTTP request.

System capability: SystemCapability.Communication.NetStack

RequestMethod

Defines an HTTP request method.

System capability: SystemCapability.Communication.NetStack

ResponseCode

Enumerates the response codes for an HTTP request.

System capability: SystemCapability.Communication.NetStack

HttpResponse

Defines the response to an HTTP request.

System capability: SystemCapability.Communication.NetStack