EpigraphButtonApi
Constructors
Constructor
new EpigraphButtonApi(
appWcRef):EpigraphButtonApi
Methods
canLaunchAR()
canLaunchAR():
boolean
Checks if the current device and browser support launching an AR session.
Returns
boolean
true if AR can be launched, otherwise false.
Implementation of
IFeatureViewInYourSpace.canLaunchAR
getMinimumRequirementsString()
getMinimumRequirementsString():
string
Gets a string describing the minimum requirements for the AR feature.
Returns
string
A string with the minimum requirements.
Implementation of
IFeatureViewInYourSpace.getMinimumRequirementsString
getViewInYourSpaceQR()
getViewInYourSpaceQR():
Promise<string>
Beta
Gets the QR code for the "View in Your Space" feature.
Returns
Promise<string>
A promise that resolves with the QR code data. Currently returns an empty string.
Implementation of
IFeatureViewInYourSpace.getViewInYourSpaceQR
getViewInYourSpaceUrl()
getViewInYourSpaceUrl():
Promise<string>
Beta
Gets the URL for the "View in Your Space" feature.
Returns
Promise<string>
A promise that resolves with the URL string. Currently returns an empty string.
Implementation of
IFeatureViewInYourSpace.getViewInYourSpaceUrl
isARSessionActive()
isARSessionActive():
boolean
Checks if an AR session is currently active.
Returns
boolean
true if an AR session is active, otherwise false.
Implementation of
IFeatureViewInYourSpace.isARSessionActive
launchAR()
launchAR():
Promise<boolean|undefined>
Launches the Augmented Reality (AR) experience.
Returns
Promise<boolean | undefined>
A promise that resolves when the AR session is launched.
Implementation of
IFeatureViewInYourSpace.launchAR
selectFinishForAsset()
selectFinishForAsset(
finishId,assetName):Promise<boolean>
Selects a finish for a specific asset in the scene.
Parameters
finishId
string
The ID of the finish to apply.
assetName
string
The name of the asset to apply the finish to.
Returns
Promise<boolean>
A promise that resolves to true if the finish was applied successfully, otherwise false.
Implementation of
IFeatureScene.selectFinishForAsset
viewInYourSpace()
viewInYourSpace():
Promise<boolean|undefined>
An alias for the launchAR method. Launches the "View in Your Space" (AR) experience.
Returns
Promise<boolean | undefined>
A promise that resolves when the AR session is launched.
Implementation of
IFeatureViewInYourSpace.viewInYourSpace
Updated about 11 hours ago