Click or drag to resize
CfxUrlRequestClient Class

[This is preliminary documentation and is subject to change.]

Structure that should be implemented by the CfxUrlRequest client. The functions of this structure will be called on the same thread that created the request unless otherwise documented.
Inheritance Hierarchy
SystemObject
  ChromiumCfxObject
    ChromiumCfxBase
      ChromiumCfxClientBase
        ChromiumCfxUrlRequestClient

Namespace: Chromium
Assembly: ChromiumFX (in ChromiumFX.dll)
Syntax
public class CfxUrlRequestClient : CfxClientBase

The CfxUrlRequestClient type exposes the following members.

Constructors
  NameDescription
Public methodCfxUrlRequestClient
Initializes a new instance of the CfxUrlRequestClient class
Top
Properties
  NameDescription
Public propertyCallbacksDisabled
When true, all CEF callback events are disabled for this handler. Incoming callbacks will return default values to CEF.
(Inherited from CfxClientBase.)
Public propertyNativePtr
Provides access to the underlying native cef struct. This is a refcounted client struct derived from cef_base_t. Add a ref in order to keep it alive when this managed object go out of scope.
(Inherited from CfxClientBase.)
Top
Events
  NameDescription
Public eventGetAuthCredentials
Called on the IO thread when the browser needs credentials from the user. |IsProxy| indicates whether the host is a proxy server. |Host| contains the hostname and |Port| contains the port number. Return true (1) to continue the request and call CfxAuthCallback.Continue() when the authentication information is available. Return false (0) to cancel the request. This function will only be called for requests initiated from the browser process.
Public eventOnDownloadData
Called when some part of the response is read. |Data| contains the current bytes received since the last call. This function will not be called if the UR_FLAG_NO_DOWNLOAD_DATA flag is set on the request.
Public eventOnDownloadProgress
Notifies the client of download progress. |Current| denotes the number of bytes received up to the call and |Total| is the expected total size of the response (or -1 if not determined).
Public eventOnRequestComplete
Notifies the client that the request has completed. Use the CfxUrlRequest.GetRequestStatus function to determine if the request was successful or not.
Public eventOnUploadProgress
Notifies the client of upload progress. |Current| denotes the number of bytes sent so far and |Total| is the total size of uploading data (or -1 if chunked upload is enabled). This function will only be called if the UR_FLAG_REPORT_UPLOAD_PROGRESS flag is set on the request.
Top
Remarks
See also the original CEF documentation in cef/include/capi/cef_urlrequest_capi.h.
See Also