diff options
Diffstat (limited to 'src/webenginequick/doc/src/webengine_certificate_error.qdoc')
| -rw-r--r-- | src/webenginequick/doc/src/webengine_certificate_error.qdoc | 43 |
1 files changed, 9 insertions, 34 deletions
diff --git a/src/webenginequick/doc/src/webengine_certificate_error.qdoc b/src/webenginequick/doc/src/webengine_certificate_error.qdoc index 8c032dc8b..93bad9fb1 100644 --- a/src/webenginequick/doc/src/webengine_certificate_error.qdoc +++ b/src/webenginequick/doc/src/webengine_certificate_error.qdoc @@ -1,29 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2020 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the documentation of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:FDL$ -** Commercial License Usage -** Licensees holding valid commercial Qt licenses may use this file in -** accordance with the commercial license agreement provided with the -** Software or, alternatively, in accordance with the terms contained in -** a written agreement between you and The Qt Company. For licensing terms -** and conditions see https://www.qt.io/terms-conditions. For further -** information use the contact form at https://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: https://www.gnu.org/licenses/fdl-1.3.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ +// Copyright (C) 2020 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only /*! \qmltype WebEngineCertificateError @@ -33,18 +9,18 @@ \brief A utility type for ignoring certificate errors or rejecting erroneous certificates. - This QML type contains information about a certificate error that occurred. The \l error + This QML type contains information about a certificate error that occurred. The \l type 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 + 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 + The certificate error can be ignored by calling \l acceptCertificate(), which will resume loading the request. - It is possible to defer the decision of rejecting a certificate by calling \l defer, + 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 @@ -54,11 +30,10 @@ This function should be called when there is a need to postpone the decision whether to ignore a certificate error, for example, while waiting for user input. When called, the function pauses the - URL request until WebEngineCertificateError::ignoreCertificateError() or - WebEngineCertificateError::rejectCertificate() is called. + URL request until acceptCertificate() or rejectCertificate() is called. */ /*! - \qmlmethod void WebEngineCertificateError::ignoreCertificateError() + \qmlmethod void WebEngineCertificateError::acceptCertificate() The certificate error is ignored, and the web engine view continues to load the requested URL. */ @@ -74,7 +49,7 @@ The URL that triggered the error. */ /*! - \qmlproperty enumeration WebEngineCertificateError::error + \qmlproperty enumeration WebEngineCertificateError::type \readonly The type of the error. |