akasha.xr

Interface XRPermissionDescriptor.Builder

All Superinterfaces:

PermissionDescriptor, XRPermissionDescriptor

Enclosing interface:

XRPermissionDescriptor

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

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/interfaces inherited from interface akasha.xr.XRPermissionDescriptor

XRPermissionDescriptor.Builder

Method Summary

Modifier and Type	Method and Description
default XRPermissionDescriptor.Builder	mode(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 XRPermissionDescriptor.Builder	name(java.lang.String name)
default XRPermissionDescriptor.Builder	optionalFeatures(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 XRPermissionDescriptor.Builder	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.
default XRPermissionDescriptor.Builder	requiredFeatures(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.
default XRPermissionDescriptor.Builder	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.

Methods inherited from interface akasha.xr.XRPermissionDescriptor

create, mode, optionalFeatures, requiredFeatures, setMode, setOptionalFeatures, setOptionalFeatures, setRequiredFeatures, setRequiredFeatures

Methods inherited from interface akasha.PermissionDescriptor

name, setName

Method Detail

mode

@JsOverlay
 @Nonnull
default XRPermissionDescriptor.Builder mode(@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

@JsOverlay
 @Nonnull
default XRPermissionDescriptor.Builder optionalFeatures(@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

optionalFeatures

@JsOverlay
 @Nonnull
default XRPermissionDescriptor.Builder optionalFeatures(@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

@JsOverlay
 @Nonnull
default XRPermissionDescriptor.Builder requiredFeatures(@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

requiredFeatures

@JsOverlay
 @Nonnull
default XRPermissionDescriptor.Builder requiredFeatures(@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

name

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