QQuickWebEngineProfile Class

Member Function Documentation

QQuickWebEngineProfile::QQuickWebEngineProfile(QObject *parent = nullptr)

Constructs a new off-the-record profile with the parent parent.

An off-the-record profile leaves no record on the local machine, and has no persistent data or cache. Thus, the HTTP cache can only be in memory and the cookies can only be non-persistent. Trying to change these settings will have no effect.

[invokable] void QQuickWebEngineProfile::clearHttpCache()

Removes the profile's cache entries.

See also WebEngineProfile::clearHttpCache() and clearHttpCacheCompleted().

[signal, since 6.7] void QQuickWebEngineProfile::clearHttpCacheCompleted()

This signal is emitted when the clearHttpCache() operation is completed.

This function was introduced in Qt 6.7.

See also clearHttpCache().

QWebEngineClientCertificateStore *QQuickWebEngineProfile::clientCertificateStore()

Returns the profile's client certificate store.

[since 6.8] QWebEngineClientHints *QQuickWebEngineProfile::clientHints() const

Return the Client Hints settings associated with this browsing context.

This function was introduced in Qt 6.8.

See also QWebEngineClientHints.

QWebEngineCookieStore *QQuickWebEngineProfile::cookieStore() const

Returns the cookie store for this profile.

[static] QQuickWebEngineProfile *QQuickWebEngineProfile::defaultProfile()

Returns the default profile.

The default profile is off-the-record.

See also storageName().

[signal] void QQuickWebEngineProfile::downloadFinished(QQuickWebEngineDownloadRequest *download)

This signal is emitted whenever downloading stops, because it finished successfully, was cancelled, or was interrupted (for example, because connectivity was lost). The download argument holds the state of the finished download instance.

[signal] void QQuickWebEngineProfile::downloadRequested(QQuickWebEngineDownloadRequest *download)

This signal is emitted whenever a download has been triggered. The download argument holds the state of the download. The download has to be explicitly accepted with QWebEngineDownloadRequest::accept() or it will be cancelled by default. The download item is parented by the profile. If it is not accepted, it will be deleted immediately after the signal emission. This signal cannot be used with a queued connection.

void QQuickWebEngineProfile::installUrlSchemeHandler(const QByteArray &scheme, QWebEngineUrlSchemeHandler *handler)

Registers a handler handler for custom URL scheme scheme in the profile.

It is necessary to first register the scheme with QWebEngineUrlScheme::registerScheme at application startup.

[invokable, since 6.8] QList<QWebEnginePermission> QQuickWebEngineProfile::listAllPermissions() const

Returns a QList of QWebEnginePermission objects, each one representing a single permission currently present in the permissions store. The returned list contains all previously granted/denied permissions for this profile, provided they are of a persistent type.

This function was introduced in Qt 6.8.

See also queryPermission(), listPermissionsForOrigin(), listPermissionsForPermissionType(), and QWebEnginePermission::isPersistent().

[invokable, since 6.8] QList<QWebEnginePermission> QQuickWebEngineProfile::listPermissionsForOrigin(const QUrl &securityOrigin) const

Returns a QList of QWebEnginePermission objects, each one representing a single permission currently present in the permissions store. The returned list contains all previously granted/denied permissions associated with a specific securityOrigin for this profile, provided they are of a persistent type.

This function was introduced in Qt 6.8.

See also queryPermission(), listAllPermissions(), listPermissionsForPermissionType(), and QWebEnginePermission::isPersistent().

[invokable, since 6.8] QList<QWebEnginePermission> QQuickWebEngineProfile::listPermissionsForPermissionType(QWebEnginePermission::PermissionType permissionType) const

Returns a QList of QWebEnginePermission objects, each one representing a single permission currently present in the permissions store. The returned list contains all previously granted/denied permissions of the provided permissionType. If the permissionType is non-persistent, the list will be empty.

This function was introduced in Qt 6.8.

See also queryPermission(), listAllPermissions(), listPermissionsForOrigin(), QWebEnginePermission::PermissionType, and QWebEnginePermission::isPersistent().

[signal] void QQuickWebEngineProfile::presentNotification(QWebEngineNotification *notification)

This signal is emitted whenever there is a newly created user notification. The notification argument holds the QWebEngineNotification instance to query data and interact with.

See also WebEngineProfile::presentNotification.

[invokable, since 6.8] QWebEnginePermission QQuickWebEngineProfile::queryPermission(const QUrl &securityOrigin, QWebEnginePermission::PermissionType permissionType) const

Returns a QWebEnginePermission object corresponding to a single permission for the provided securityOrigin and permissionType. The object may be used to query for the current state of the permission, or to change it. It is not required for a permission to already exist; the returned object may also be used to pre-grant a permission if a website is known to use it.

This function was introduced in Qt 6.8.

See also listAllPermissions(), listPermissionsForOrigin(), listPermissionsForPermissionType(), and QWebEnginePermission::PermissionType.

void QQuickWebEngineProfile::removeAllUrlSchemeHandlers()

Removes all custom URL scheme handlers installed in the profile.

void QQuickWebEngineProfile::removeUrlScheme(const QByteArray &scheme)

Removes the custom URL scheme scheme from the profile.

See also removeUrlSchemeHandler().

void QQuickWebEngineProfile::removeUrlSchemeHandler(QWebEngineUrlSchemeHandler *handler)

Removes the custom URL scheme handler handler from the profile.

See also removeUrlScheme().

void QQuickWebEngineProfile::setUrlRequestInterceptor(QWebEngineUrlRequestInterceptor *interceptor)

Registers a request interceptor singleton interceptor to intercept URL requests.

The profile does not take ownership of the pointer.

See also QWebEngineUrlRequestInfo and QWebEngineUrlRequestInterceptor.

QStringList QQuickWebEngineProfile::spellCheckLanguages() const

Returns the list of languages used by the spell checker.

See also setSpellCheckLanguages().

const QWebEngineUrlSchemeHandler *QQuickWebEngineProfile::urlSchemeHandler(const QByteArray &scheme) const

Returns the custom URL scheme handler register for the URL scheme scheme.