Maps API for JavaScript Developer's Guide

H.util.Request

Class Summary

This is a generic class representing a handle for any kind of asynchronous request.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

getState () : {H.util.Request.State}

This method retrieves the state of the request.

getTotal () : {number}

This method retrieves the number of processing steps to complete this request.

getProcessed () : {number}

This method retrieves the number of completed request processing steps.

getFailed () : {number}

This method retrieves the number of failed processing steps.

Class Description

This is a generic class representing a handle for any kind of asynchronous request.

Constructor Details

H.util.Request(opt_onprogress, opt_total)

Parameters:
 
opt_onprogress:
{function(H.util.Request)=} [optional]
 
A callback to invoke every time the progress state of the request changes
opt_total:
{number=} [optional]
 
The total number of processing steps to complete the request, the default is 1

Method Details

getState () : {H.util.Request.State}

This method retrieves the state of the request.

Returns:
 
{H.util.Request.State}
A value indicating the state of the request

getTotal () : {number}

This method retrieves the number of processing steps to complete this request.

Returns:
 
{number}
A value indicating the number of processing steps.

getProcessed () : {number}

This method retrieves the number of completed request processing steps.

Returns:
 
{number}
A value indicating how many processing steps have been completed

getFailed () : {number}

This method retrieves the number of failed processing steps.

Returns:
 
{number}
A value indicating the number of failed processing steps