summaryrefslogtreecommitdiffstats
path: root/src/webengine/api/qquickwebenginecertificateerror.cpp
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@theqtcompany.com>2016-02-18 15:17:49 +0100
committerJani Heikkinen <jani.heikkinen@theqtcompany.com>2016-02-24 11:07:35 +0000
commit58e791df3d48c8d0c21219f88b05c63b0d398b28 (patch)
treedc98b4576356d6e0e94e892a09ed1a7c6cd4ae15 /src/webengine/api/qquickwebenginecertificateerror.cpp
parent918ca3ccd62f6d9270fb0019e89b69e4bd259d60 (diff)
Doc: Move info about WebEngineCertificate methods
...from WebEngine type to WebEngineCertificate type introduction. Change-Id: I8e8d7aae3f3cad6647a2a0537d2866c7827aba96 Reviewed-by: Joerg Bornemann <joerg.bornemann@theqtcompany.com>
Diffstat (limited to 'src/webengine/api/qquickwebenginecertificateerror.cpp')
-rw-r--r--src/webengine/api/qquickwebenginecertificateerror.cpp15
1 files changed, 13 insertions, 2 deletions
diff --git a/src/webengine/api/qquickwebenginecertificateerror.cpp b/src/webengine/api/qquickwebenginecertificateerror.cpp
index ea9b2bc11..7b06696d2 100644
--- a/src/webengine/api/qquickwebenginecertificateerror.cpp
+++ b/src/webengine/api/qquickwebenginecertificateerror.cpp
@@ -66,8 +66,19 @@ public:
\brief A utility type for ignoring certificate errors or rejecting erroneous certificates.
- This QML type contains information about a certificate error that occurred and provides a way
- to ignore the error or reject the certificate.
+ This QML type contains information about a certificate error that occurred. The \l error
+ property holds the reason that the error occurred and the \l description property holds a
+ short localized description of the error. The \l url property holds the URL that triggered
+ the error.
+
+ The certificate can be rejected by calling \l rejectCertificate, which will stop loading the
+ web engine request. By default, an invalid certificate will be automatically rejected.
+
+ The certificate error can be ignored by calling \l ignoreCertificateError, which will
+ resume loading the request.
+
+ It is possible to defer the decision of rejecting a certificate by calling \l defer,
+ which is useful when waiting for user input.
\sa WebEngineView::certificateError
*/