Class AppApi

constructor

• new AppApi(): AppApi

• Returns AppApi

isMobile

isTouchDevice

areDimensionsVisible

• areDimensionsVisible(): boolean

• Whether the dimensions are currently rendering within the scene.

  Returns boolean

  Dimensions visibility state.

areHotspotsVisible

• areHotspotsVisible(): boolean

• Whether the hotspots are currently visible within the scene.

  Returns boolean

  Hotspots visibility state.

generateShareableLink

• generateShareableLink(arCompatible): Promise<string>

• Parameters

  • arCompatible: boolean

  Returns Promise<string>

getActiveNodeId

• getActiveNodeId(): string

• Gets the node id for the product that is currently active in the active product class.

  Returns string

  The node id. This is primarily used to target and switch variant.

getActiveProductClass

• getActiveProductClass(): ProductClass

• TODO: Why do we have the current product class stored in customiser and the productClasses object? See if we can unify them. Currently, returns the same as api.getCurrentProductClass()

  Returns ProductClass

  Active product class within the scene.

getActiveProductClassIndex

• getActiveProductClassIndex(): null | number

• Returns null | number

getAllCameraViewIds

• getAllCameraViewIds(): string[]

• Gets a list of all camera View Names available.

  Returns string[]

getAllCameraViews

• getAllCameraViews(): ICameraViewCollection

• Gets all camera views provided within the experience data.

  Returns ICameraViewCollection

  A colelction of all available camera view configs.

getAllDisabledProductsForCurrentState

• getAllDisabledProductsForCurrentState(): IDisabledProductsMap

• Gets information regarding the products that need to be disabled based on the current scene selection.

  Returns IDisabledProductsMap

getAllHotspotsData

• getAllHotspotsData(): HotspotsConfigMap

• Returns HotspotsConfigMap

getAppEvents

• getAppEvents(): AppEvents

• Gets a reference to the AppEvent object for this session. This could then be used to fire and subscribe to the app wide events.

  Returns AppEvents

  The centralised hub for all app wide events.

getCart

• getCart(): ICart

• Gets the current state of session cart.

  Returns ICart

getCurrentCameraTransforms

• getCurrentCameraTransforms(): CAMERA_TRANSFORMS_FOR_INPUT

• Gets the current camera transforms in a generalised object. This object is compatible with almost all camera related inputs to this experience via API.

  Returns CAMERA_TRANSFORMS_FOR_INPUT

getCurrentDimensionsState

• getCurrentDimensionsState(): IDimensionsState

• Returns IDimensionsState

getCurrentProductClass

• getCurrentProductClass(): ProductClass

• Gets the current productClass within the scene.

  Returns ProductClass

  The active product class.

getCurrentProductPricings

• getCurrentProductPricings(): IOutputSkusMapConfig

• Gets current pricing for products within the session. This could later used to set a new pricing at runtime, if need be.

  Returns IOutputSkusMapConfig

  The current pricing of products, sorted by products and their available variants.

getCurrentSceneState

• getCurrentSceneState(): ICurrentSceneState

• Scene's current state that could be saved within a database and be used to replicate a session again. Primarily used for Save/Share functionality within the configurator.

  Returns ICurrentSceneState

getCurrentSceneStructure

• getCurrentSceneStructure(): undefined | SceneStructureDetails

• Gets the current state of scene in a JSON format.

  Returns undefined | SceneStructureDetails

  Undefined when the process fails to get the scene structure for some reason.

getDefaultSceneState

• getDefaultSceneState(): undefined | ICurrentSceneState

• Returns undefined | ICurrentSceneState

getExperienceId

• getExperienceId(): string

• Gets the experience id that was used to launch this session.

  Returns string

  The experience-id for the current session.

getExperienceSettings

• getExperienceSettings(): IConfigExpSettings

• Returns IConfigExpSettings

getProductById

• getProductById(productId): undefined | Product

• Parameters

  • productId: string

  Returns undefined | Product

getProductClassesConfig

• getProductClassesConfig(): ProductClassCollection

• Get the parsed product classes config for this session.

  Returns ProductClassCollection

  Object containing information related to the product classes that are a part of this experience.

getProductsInfoForActiveClass

• getProductsInfoForActiveClass(): ProductsMap

• Returns ProductsMap

getResolvedUrlForAsset

• getResolvedUrlForAsset(relativeUrl): string

• Parameters

  • relativeUrl: string

  Returns string

getSceneAsGlbUrl

• getSceneAsGlbUrl(): Promise<string>

• Returns Promise<string>

getSceneAsUsdzUrl

• getSceneAsUsdzUrl(): Promise<string>

• Returns Promise<string>

getSceneScaleUnits

• getSceneScaleUnits(): Unit

• Gets the scene scale units being used by this session. The library used internally is https://github.com/convert-units/convert-units#readme.

  Returns Unit

  One of the valid scale units.

getSceneScreenshots

• getSceneScreenshots(): Promise<undefined | IScreenshotsCollection>

• Returns Promise<undefined | IScreenshotsCollection>

getSceneStateSaveEndpoint

• getSceneStateSaveEndpoint(entryId): string

• Parameters

  • entryId: string

  Returns string

getScreenshotAsUrl

• getScreenshotAsUrl(): string

• Returns string

getVariantsForActiveProduct

• getVariantsForActiveProduct(): VariantCollection

• Returns VariantCollection

hideDimensions

• hideDimensions(): void

• Hide the dimensions within the scene.

  Returns void

hideHiccupScreen

• hideHiccupScreen(): void

• Convenience wrapper to hide the hiccup screen

  Returns void

hideHotspots

• hideHotspots(): void

• Hide the hotspots within the scene.

  Returns void

hideSplashScreen

• hideSplashScreen(): void

• Hide the Splash Screen. This is the same overlayed screen that can be seen on startup.

  Returns void

loadSceneStateAsCurrent

• loadSceneStateAsCurrent(sceneState): Promise<void>

• Loads a scene state object as current within the scene. Part of save/share feature within the configurator.

  Parameters

  • sceneState: ICurrentSceneState

    Usually the scene state stored using AppApi.getCurrentSceneState.

  Returns Promise<void>

makeNextProductClassActive

• makeNextProductClassActive(skipCamera?): void

• Makes the next product class active within the scene.

  Parameters

  • skipCamera: boolean = false

    WHether to skip the camera updates when the class is updated.

  Returns void

makePreviousProductClassActive

• makePreviousProductClassActive(skipCamera?): void

• Makes the previous product class active within the scene.

  Parameters

  • skipCamera: boolean = false

    WHether to skip the camera updates when the class is updated.

  Returns void

makeProductClassIdActive

• makeProductClassIdActive(productClassId, skipCamera?): void

• Sets the given product class id as active within the scene. This product class can be fetched via 'EPIGRAPH_CONFIGURATOR.api.getProductClassesConfig().productClasses'

  Parameters

  • productClassId: string

    A valid product class id that you wish to make active.

  • skipCamera: boolean = false

    WHether to skip the camera updates when the class is updated.

  Returns void

makeProductClassIndexActive

• makeProductClassIndexActive(productClassIndex, skipCamera?): void

• Sets the given product class index as active within the scene. This index order is predefined and could be fetched via 'EPIGRAPH_CONFIGURATOR.api.getProductClassesConfig().productClasses'

  Parameters

  • productClassIndex: number

    A valid product class index that you wish to make active.

  • skipCamera: boolean = false

    WHether to skip the camera updates when the class is updated.

  Returns void

makeProductIdActiveInCurrentClass

• makeProductIdActiveInCurrentClass(productId, skipCamera?, blockScene?): void

• Make a given product ID active in the current product class.

  Parameters

  • productId: string

    A valid product ID to be made current.

  • skipCamera: boolean = false

  • blockScene: boolean = false

    Whether the scene execution should be blocked while the product loads.

  Returns void

moveCameraToCameraViewById

• moveCameraToCameraViewById(cameraViewId, freezeCamera?): void

• Moves the main camera to one of the camera views defined within the experience data.

  Parameters

  • cameraViewId: string

    A valid camera view ID. Use api.getAllCameraViewIds() to a get of valid ids.

  • freezeCamera: boolean = false

  Returns void

moveCameraToLocation

• moveCameraToLocation(newCameraTransforms, newCameraTargetTransforms, freezeCamera?): void

• Moves the scene's main camera to a given camera location config.

  Parameters

  • newCameraTransforms: ObjectTransformsConfig | ObjectTransforms

    Either an instance of ObjectTransforms object or the config for it.

  • newCameraTargetTransforms: ObjectTransformsConfig | ObjectTransforms

    Either an instance of ObjectTransforms object or the config for it.

  • freezeCamera: boolean = false

    Should the camera be frozen from making any further input movements after the transition is complete.

  Returns void

printSceneHierarchy

• printSceneHierarchy(detailMode?): void

• A convenience method that allows the user to print scene hierarchy to console at any point.

  Parameters

  • detailMode: boolean = false

    Verbose hierarchy of the scene.

  Returns void

refreshSceneHeirarchy

• refreshSceneHeirarchy(): void

• Returns void

removeItemByNodeId

• removeItemByNodeId(nodeId): Promise<void>

• Removed a given node from the scene.

  Parameters

  • nodeId: string

    Id for the node that is to be removed from the scene.

  Returns Promise<void>

replaceItemByProductId

• replaceItemByProductId(productId, nodeIdToReplace): Promise<ReturnProductNode>

• Parameters

  • productId: string

  • nodeIdToReplace: string

  Returns Promise<ReturnProductNode>

resetCameraToDefault

• resetCameraToDefault(): void

• Returns void

resetSceneToDefault

• resetSceneToDefault(): Promise<void>

• Returns Promise<void>

setCurrentProductPricings

• setCurrentProductPricings(newSessionPricing): ReturnNoPayload

• Updates current pricing for products within the session. This expects a map with product id as the primary key. For reference and convenience, use the "getCurrentProductPricings" method from this api.

  Parameters

  • newSessionPricing: IOutputSkusMapConfig

  Returns ReturnNoPayload

  Whether the process failed, or was successful.

showDimensions

• showDimensions(): void

• Show the dimensions within the scene.

  Returns void

showHiccupScreen

• showHiccupScreen(): void

• Convenience wrapper to show the hiccup screen

  Returns void

showHotspots

• showHotspots(): void

• Show the hotspots within the scene.

  Returns void

showSplashScreen

• showSplashScreen(): void

• Show the Splash Screen. This is the same overlayed screen that can be seen on startup.

  Returns void

spawnItemByProductId

• spawnItemByProductId(productId): Promise<ReturnProductNode>

• DEPRECATED: This method has been renamed to spawnNodeByProductId for naming consistency.

  Parameters

  • productId: string

  Returns Promise<ReturnProductNode>

spawnNodeByProductId

• spawnNodeByProductId(productId): Promise<ReturnProductNode>

• Spawns a 3D product in scene for a given product ID.

  Parameters

  • productId: string

    Unique identifier of the product that needs to be spawned within the scene.

  Returns Promise<ReturnProductNode>

switchVariantForNodeId

• switchVariantForNodeId(nodeId, variantId): Promise<ReturnNoPayload>

• Switches the variant for a given nodeId within the scene. Please note that a node is an instance of a product within the scene and a product can be referenced by multiple nodes. It's usually possible to get the node id while spawning the item.

  Parameters

  • nodeId: string

    A valid node id within the scene.

  • variantId: string

    A valid variant ID for the provided node.

  Returns Promise<ReturnNoPayload>

  Reports success or failure. But doesn't return much details yet. Might add more info in the future.

switchVariantForProductClass

• switchVariantForProductClass(productClassId, variantId): Promise<ReturnNoPayload>

• Parameters

  • productClassId: string

  • variantId: string

  Returns Promise<ReturnNoPayload>

viewInYourSpace

• viewInYourSpace(): Promise<void>

• Attempts to evaluate and launches the appropriate view in your space session, based on the device type.

  Returns Promise<void>