Skip to main content

Type Alias: GetARShortCodeData()

GetARShortCodeData = (arShortCode, withSubscription?) => Promise<Nullable<ARShortcodeData>>

Function

Retrieves detailed information about an AR model from its shortcode.

This action looks up an existing AR model using its unique identifier and returns comprehensive information about the model, including file paths, product details, and conversion status. For models still being processed, it can provide a subscription to notify when processing completes.

Business value:

  • Supports seamless AR experiences by accessing previously created AR models
  • Enables informative loading states when AR models are still processing
  • Provides product details for consistent AR experience labeling
  • Allows tracking of AR model status for analytics and troubleshooting

Parameters​

arShortCode​

string

Unique identifier for the AR model

withSubscription?​

boolean

Whether to include a completion notification for processing models

Returns​

Promise<Nullable<ARShortcodeData>>

Promise resolving to AR model data, or null if not found

Example​

// Load AR viewer with proper model information
const arShortcode = getParameterFromUrl('code');
if (arShortcode) {
  window.mimeeqApp.actions.getARShortCodeData(arShortcode, true)
    .then(arData => {
      if (arData) {
        if (arData.glbPath && arData.usdzPath) {
          // Models are ready, load AR viewer
          initializeARViewer(arData);
        } else if (arData.completeSubscription) {
          // Models are processing, wait for completion
          showLoadingIndicator();
          arData.completeSubscription.then(result => {
            hideLoadingIndicator();
            initializeARViewer({...arData, ...result});
          });
        }
      } else {
        showErrorMessage("AR model not found");
      }
    });
}