NetworkRequest QML Type

Returns a code that refers to a description of the error.

Returns a human-readable description of the last device error that occurred.

Boolean value. Default value is true and allows the request follows the redirects to perform the request.

Returns any valid headers present in the request.

Boolean value. Default value is false.

The type of method can be DELETE, GET, HEAD, POST, and PUT.

If the host service is configured with HTTP Basic authentication you can leverage NetworkRequest to pass your credentials and get access to the host using the properties "user" and "password". The password property is the corresponding password for the provided user. Please remember these properties are only used in case of host with HTTP Basic Authentication.

App {
        id: app
        width: 800
        height: 600
        NetworkRequest {
                id: networkRequest
                url: "http://httpbin.org/basic-auth/user/passwd"
                followRedirects: true
                ignoreSslErrors: true
                responseType: "json"
                onReadyStateChanged: {
                        if ( readyState === NetworkRequest.DONE ) {
                                jsonText.text = JSON.stringify(response, undefined, 2);
                        }
                }
        }
        Text {
                id: jsonText
                clip: true
        }
        Component.onCompleted: {
                networkRequest.user = "user"
                networkRequest.password = "passwd"
                networkRequest.send();
        }
}

Returns the value for the progress of the network request.

This progress value is a combination of the request upload and response download as a decimal value: every value less than 0.5 is when transmitting a request, 0.5 is waiting for the server response, and all values greater than 0.5 up to 1.0 is receiving the response.

Depending on the request being made, this may not progress at a linear rate. For example when downloading a large file, progress will jump quickly from 0 to 0.5 but increase much more slowly afterwards.

Retrieves the current state of the request operation.

Returns the target realm/domain of the network request operation.

This property is currently under review. Please ignore.

The returned object based on the returnType property. By default it will return a string just like returnText, however if you set returnType, the object of your choice will be returned.

For example,

returnType:"json"

would return JSON object

{"name": "Bruce"}

This property will not be set if the responsePath property has been set.

Returns a JSON object header name/value pairs associated with the response. for example,

onReadyStateChanged: { if ( readyState === NetworkRequest.DONE ) {console.log( JSON.stringify(responseHeaders, undefined, 2) ) } }

returns,

{"Cache-Control":"max-age=0,must-revalidate", "Connection":"keep-alive", "Content-Length":"6126", "Content-Type":"text/plain;charset=utf-8", "Date":"Wed, 28 Oct 2015 22:06:00 GMT", "ETag":"5ffaa26f", "Server":"" }

The responsePath property defines a file location for use when downloading a file.

If this property is set, the file will be downloaded directly to the set location. The file will be downloaded in small chunks, minimizing the in-memory footprint. The response and responseText properties will be unset, and the responseType property will be ignored.

If this property is not set, the entire downloaded file will be returned in the device memory. This content will be made available in string form in the responseText property. The response property will contain the downloaded content in the form set by the responseType property. If this property is unset, consider setting the NetworkRequestHeaders to do HTTP range requests to ensure that the downloaded content is always in small chunks.

Retrieves the response body in a string form. This property will not be set if the responsePath property has been set.

Describes the data type of the response associated with the request. This can be set as 'text', 'json', 'base64', or 'binary'. Any other value will be interpreted as 'text'.

This property will be ignored if the responsePath property has been set.

Gets the current status of the request. Returns an enumerated value.

Returns a string describing the status of the request.

The default value of uploadPrefix is "@" to maintain compatibility with existing 'curl style' code. The uploadPrefix can be set to any string value to resolve possible ambiguities e.g. Unlikely unicode characters, guid etc

A string containing the URL to which the request is sent.

If the host service is configured with HTTP Basic authentication you can leverage NetworkRequest to pass your credentials and get access to the host using the properties "user" and "password". The user property implies the username required for the authentication. Please remember these properties are only used in case of host with HTTP Basic Authentication.

App {
        id: app
        width: 800
        height: 600
        NetworkRequest {
                id: networkRequest
                url: "http://httpbin.org/basic-auth/user/passwd"
                followRedirects: true
                ignoreSslErrors: true
                responseType: "json"
                onReadyStateChanged: {
                        if ( readyState === NetworkRequest.DONE ) {
                                jsonText.text = JSON.stringify(response, undefined, 2);
                        }
                }
        }
        Text {
                id: jsonText
                clip: true
        }
        Component.onCompleted: {
                networkRequest.user = "user"
                networkRequest.password = "passwd"
                networkRequest.send();
        }
}

Indicates all possible error conditions found during the processing of the request. This signal can be used in conjunction with the readyState and status properties to deduce an error. Responses will always report in the order of readyState, error, status.

if ( readyState === NetworkRequest.DONE ) {
        if (errorCode === 0) {
                if (status === NetworkRequest.StatusCodeOK){
                        console.log ( JSON.stringify ( response, undefined, 2 ) )
                }
        }
}

Note: The corresponding handler is onError.

Executes if the ignoreSslErrors property is set to false and then a ssl error occurs. For example,

NetworkRequest {
        onSslErrors: console.log ("Danger! Danger!")
}

Note: The corresponding handler is onSslErrors.

Executes if the ignoreSslErrors property is set to true and then a ssl error occurs. For example,

NetworkRequest {
        onSslErrorsIgnored: console.log ("moving on...")
}

Note: The corresponding handler is onSslErrorsIgnored.

Note: The corresponding handler is onTimeout.

Aborts the operation immediately and close down any network connections still open. Uploads still in progress are also aborted.

Provides a method to cancel a networkRequest operation cleanly.

item {
    NetworkRequest {
        id: networkRequest
        url: "http://appstudio.arcgis.com/images/index/introview.jpg"
        responsePath: "c:/temp/appstudio.jpg"

        property url imagePath: AppFramework.resolvedPathUrl(responsePath)

        onReadyStateChanged: {
            if ( readyState === NetworkRequest.DONE ) {
                image.source = imagePath
            }
        }

        onProgressChanged: progressbar.color = "#"+((1<<24)*Math.random()|0).toString(16)
    }

    Rectangle {
        visible: networkRequest.readyState !== NetworkRequest.DONE
        anchors {
            top: parent.top
            left:parent.left
        }

        width: parent.width
        height: 10
        color: "lightGrey"

        Rectangle {
            id: progressbar
            height: parent.height
            width: parent.width * networkRequest.progress
        }
        Row {
            anchors {
                horizontalCenter: parent.horizontalCenter
                top: progressbar.bottom; topMargin: 5
            }
            spacing: 20
            Text {
                text: Math.floor(networkRequest.progress * 100) + "%"
            }
            Text {
                text : qsTr("Cancel download")
                MouseArea{anchors.fill: parent; onClicked: networkRequest.abort()}
            }
        }
    }
}

Returns the attribute associated with the given attribute code.

The attribute parameter

The attribute code to return.

The attribute parameter

The checkResponse parameter

See also setAttribute().

Provides options on request-response between a client and server.

This method exists to be similar to the XMLHttpRequest::open() web API method. This is so that when people port their web applications to QML they can switch over to using the NetworkRequest object with minimal changes to their code. This method, presently, offers the ability to set method, url and optionally async properties in an imperative manner. Currently native QML applications merely set method, url and async properties declaratively, so from a QML standpoint, NetworkRequest::open() is not required.

For example,

networkRequest.open("GET", url); networkRequest.send();

The method parameter

HTTP request is "GET" or "POST". Default value is "GET".

The url parameter

For example,

http://sampleserver6.arcgisonline.com/arcgis/rest/services/Wildfire/FeatureServer/0/query?where=1%3D1&objectIds=&time=&geometry=&geometryType=esriGeometryEnvelope&inSR=&spatialRel=esriSpatialRelIntersects&relationParam=&outFields=&returnGeometry=true&maxAllowableOffset=&geometryPrecision=&outSR=&gdbVersion=&returnDistinctValues=false&returnIdsOnly=false&returnCountOnly=false&orderByFields=&groupByFieldsForStatistics=&outStatistics=&returnZ=false&returnM=false&multipatchOption=&f=html

Provides options on request-response between a client and server, and supply an option to change the sync type.

NetworkRequest::open() method exists so that it is similar with the XMLHttpRequest::open(). This is so that when people port their web applications to QML they can switch over to using the NetworkRequest object with minimal code changes to their code. The NetworkRequest::open() method, presently, offers the ability to set method, url and async properties in an imperative manner. Currently, native QML applications merely set method, url and async properties declaratively, so, from a QML standpoint, NetworkRequest::open() is not required.

For example,

networkRequest.open("GET", url, false);

The method parameter

HTTP request is "GET" or "POST". Default value is "GET".

The url parameter

For example,

http://sampleserver6.arcgisonline.com/arcgis/rest/services/Wildfire/FeatureServer/0/query?where=1%3D1&objectIds=&time=&geometry=&geometryType=esriGeometryEnvelope&inSR=&spatialRel=esriSpatialRelIntersects&relationParam=&outFields=&returnGeometry=true&maxAllowableOffset=&geometryPrecision=&outSR=&gdbVersion=&returnDistinctValues=false&returnIdsOnly=false&returnCountOnly=false&orderByFields=&groupByFieldsForStatistics=&outStatistics=&returnZ=false&returnM=false&multipatchOption=&f=html

The async parameter

Boolean value, defaults to true which provides an asynchronous call.

This actions the request to the specified url.

For example,

Component.onCompleted: { networkRequest.send() }

Optionally supply a JSON object of properties to assist the request.

For example,

Component.onCompleted: { networkRequest.send({"f":"json"}) }

The body parameter

For example,

{"f":"json"}

Sets the attribute associated with the attribute code to the designated value. If the attribute is already set, the previous value is discarded.

The attribute parameter

The attribute to set to a value.

The value parameter

The value to set the attribute to.

See also attribute().