:right-sidebar: True

XRPermissionRequest
===================================================================

.. currentmodule:: gi.repository.WebKit


.. versionadded:: 2.52




.. class:: XRPermissionRequest(**properties: ~typing.Any)
   :no-contents-entry:


Superclasses: :class:`~gi.repository.GObject.Object`



Implemented Interfaces: :class:`~gi.repository.WebKit.PermissionRequest`



A permission request for accessing virtual reality (VR) and
augmented reality (AR) devices, including sensors and head-mounted
displays.

WebKitXRPermissionRequest represents a request for permission to
decide whether WebKit can initialize an XR session through the
WebXR API.

When a WebKitXRPermissionRequest is not handled by the user,
it is denied by default.




Methods
-------

.. rst-class:: interim-class

.. class:: XRPermissionRequest
   :no-index:


   .. method:: get_consent_optional_features() -> ~gi.repository.WebKit.XRSessionFeatures

      Gets the optional features that need user consent.

      These features can be granted by calling
      :func:`~gi.repository.WebKit.XRPermissionRequest.set_granted_optional_features`
      before allowing the request with :func:`~gi.repository.WebKit.PermissionRequest.allow`.



      .. versionadded:: 2.52








   .. method:: get_consent_required_features() -> ~gi.repository.WebKit.XRSessionFeatures

      Gets the required features that need user consent.

      These features are automatically granted if the request is allowed with
      :func:`~gi.repository.WebKit.PermissionRequest.allow`.



      .. versionadded:: 2.52








   .. method:: get_granted_features() -> ~gi.repository.WebKit.XRSessionFeatures

      Gets the features requested by the origin for the XR device, which
      are either granted by default or have been explicitly granted by
      the user.



      .. versionadded:: 2.52








   .. method:: get_optional_features_requested() -> ~gi.repository.WebKit.XRSessionFeatures

      Gets the full set of optional features requested by the web application.

      This includes both already granted features and those requiring consent.



      .. versionadded:: 2.52








   .. method:: get_required_features_requested() -> ~gi.repository.WebKit.XRSessionFeatures

      Gets the full set of required features requested by the web application.

      This includes both already granted features and those requiring consent.



      .. versionadded:: 2.52








   .. method:: get_security_origin() -> ~gi.repository.WebKit.SecurityOrigin

      Gets the security origin that initiated the permission request.



      .. versionadded:: 2.52








   .. method:: get_session_mode() -> ~gi.repository.WebKit.XRSessionMode

      Gets the session mode for which permission is being requested.



      .. versionadded:: 2.52








   .. method:: set_granted_optional_features(granted: ~gi.repository.WebKit.XRSessionFeatures) -> None

      Sets which optional features should be granted if the permission request is allowed.

      This function should be called with a subset of the features from
      :func:`~gi.repository.WebKit.XRPermissionRequest.get_consent_optional_features` before calling
      :func:`~gi.repository.WebKit.PermissionRequest.allow`. If the request is denied, no features are
      granted, regardless of what is set here.



      .. versionadded:: 2.52





      :param granted: granted features