akasha.xr

Interface XRPermissionDescriptor

All Superinterfaces:

PermissionDescriptor

All Known Subinterfaces:

XRPermissionDescriptor.Builder

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public interface XRPermissionDescriptor
extends PermissionDescriptor

User permissions in the WebXR Device API are managed using the Permissions API. To that end, the XRPermissionDescriptor dictionary is used to describe the WebXR features the app needs to use, as well as those features it would like ot use if permision is granted.

See Also:

XRPermissionDescriptor - MDN, XRPermissionDescriptor - WebXR Device API

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	XRPermissionDescriptor.Builder User permissions in the WebXR Device API are managed using the Permissions API.

Method Summary

Modifier and Type	Method and Description
static XRPermissionDescriptor.Builder	create(java.lang.String name)
java.lang.String	mode() The mode property of the XRPermissionDescriptor dictionary is a string taken from the XRSessionMode enumerated type, specifying which Web XR session mode (inline, immersive-vr, or immersive-ar) the described permissions will be used for.
JsArray<jsinterop.base.Any>	optionalFeatures() The XRPermissionDescriptor dictionary's optionalFeatures property is used to specify a list of WebXR features which your app or site would like to use but can operate without if permission isn't granted to use them.
JsArray<jsinterop.base.Any>	requiredFeatures() The XRPermissionDescriptor dictionary's requiredFeatures property should be set prior to calling navigator.permissions.query() to a list of WebXR features which must be supported for the app to work.
void	setMode(java.lang.String mode) The mode property of the XRPermissionDescriptor dictionary is a string taken from the XRSessionMode enumerated type, specifying which Web XR session mode (inline, immersive-vr, or immersive-ar) the described permissions will be used for.
default void	setOptionalFeatures(jsinterop.base.Any... optionalFeatures) The XRPermissionDescriptor dictionary's optionalFeatures property is used to specify a list of WebXR features which your app or site would like to use but can operate without if permission isn't granted to use them.
void	setOptionalFeatures(JsArray<jsinterop.base.Any> optionalFeatures) The XRPermissionDescriptor dictionary's optionalFeatures property is used to specify a list of WebXR features which your app or site would like to use but can operate without if permission isn't granted to use them.
default void	setRequiredFeatures(jsinterop.base.Any... requiredFeatures) The XRPermissionDescriptor dictionary's requiredFeatures property should be set prior to calling navigator.permissions.query() to a list of WebXR features which must be supported for the app to work.
void	setRequiredFeatures(JsArray<jsinterop.base.Any> requiredFeatures) The XRPermissionDescriptor dictionary's requiredFeatures property should be set prior to calling navigator.permissions.query() to a list of WebXR features which must be supported for the app to work.

Methods inherited from interface akasha.PermissionDescriptor

name, setName

Method Detail

create

@JsOverlay
 @Nonnull
static XRPermissionDescriptor.Builder create(@PermissionName @Nonnull
                                                                  java.lang.String name)

Specified by:

create in interface PermissionDescriptor

mode

@JsProperty(name="mode")
 @XRSessionMode
java.lang.String mode()

The mode property of the XRPermissionDescriptor dictionary is a string taken from the XRSessionMode enumerated type, specifying which Web XR session mode (inline, immersive-vr, or immersive-ar) the described permissions will be used for.

See Also:

XRPermissionDescriptor.mode - MDN, XRPermissionDescriptor.mode - WebXR Device API

setMode

@JsProperty
void setMode(@XRSessionMode @Nonnull
                         java.lang.String mode)

The mode property of the XRPermissionDescriptor dictionary is a string taken from the XRSessionMode enumerated type, specifying which Web XR session mode (inline, immersive-vr, or immersive-ar) the described permissions will be used for.

See Also:

XRPermissionDescriptor.mode - MDN, XRPermissionDescriptor.mode - WebXR Device API

optionalFeatures

@JsProperty(name="optionalFeatures")
JsArray<jsinterop.base.Any> optionalFeatures()

The XRPermissionDescriptor dictionary's optionalFeatures property is used to specify a list of WebXR features which your app or site would like to use but can operate without if permission isn't granted to use them.

See Also:

XRPermissionDescriptor.optionalFeatures - MDN, XRPermissionDescriptor.optionalFeatures - WebXR Device API

setOptionalFeatures

@JsProperty
void setOptionalFeatures(@Nonnull
                                     JsArray<jsinterop.base.Any> optionalFeatures)

The XRPermissionDescriptor dictionary's optionalFeatures property is used to specify a list of WebXR features which your app or site would like to use but can operate without if permission isn't granted to use them.

See Also:

XRPermissionDescriptor.optionalFeatures - MDN, XRPermissionDescriptor.optionalFeatures - WebXR Device API

setOptionalFeatures

@JsOverlay
default void setOptionalFeatures(@Nonnull
                                            jsinterop.base.Any... optionalFeatures)

The XRPermissionDescriptor dictionary's optionalFeatures property is used to specify a list of WebXR features which your app or site would like to use but can operate without if permission isn't granted to use them.

See Also:

XRPermissionDescriptor.optionalFeatures - MDN, XRPermissionDescriptor.optionalFeatures - WebXR Device API

requiredFeatures

@JsProperty(name="requiredFeatures")
JsArray<jsinterop.base.Any> requiredFeatures()

The XRPermissionDescriptor dictionary's requiredFeatures property should be set prior to calling navigator.permissions.query() to a list of WebXR features which must be supported for the app to work.

See Also:

XRPermissionDescriptor.requiredFeatures - MDN, XRPermissionDescriptor.requiredFeatures - WebXR Device API

setRequiredFeatures

@JsProperty
void setRequiredFeatures(@Nonnull
                                     JsArray<jsinterop.base.Any> requiredFeatures)

The XRPermissionDescriptor dictionary's requiredFeatures property should be set prior to calling navigator.permissions.query() to a list of WebXR features which must be supported for the app to work.

See Also:

XRPermissionDescriptor.requiredFeatures - MDN, XRPermissionDescriptor.requiredFeatures - WebXR Device API

setRequiredFeatures

@JsOverlay
default void setRequiredFeatures(@Nonnull
                                            jsinterop.base.Any... requiredFeatures)

The XRPermissionDescriptor dictionary's requiredFeatures property should be set prior to calling navigator.permissions.query() to a list of WebXR features which must be supported for the app to work.

See Also:

XRPermissionDescriptor.requiredFeatures - MDN, XRPermissionDescriptor.requiredFeatures - WebXR Device API