Type Alias: GetFavouriteCollections()

GetFavouriteCollections = () => Promise<FavouriteCollection[] | []>

Function

Retrieves all available favorite collections for the current user.

This method fetches the complete list of collections that the current user has access to, including both their private collections and any public collections shared within the organization. Collections serve as folders for organizing saved product configurations and modular scenes.

The returned collections can be used to populate collection selectors, organize favorite management interfaces, or filter favorites by collection.

Returns

Promise<FavouriteCollection[] | []>

A promise that resolves to an array of available collections, or an empty array if no collections exist or an error occurs

Example

// Fetch and display all available collections in a dropdown
const collections = await window.mimeeqApp.actions.getFavouriteCollections();

const collectionSelect = document.getElementById('collection-select');
collectionSelect.innerHTML = '';

// Add a default option
const defaultOption = document.createElement('option');
defaultOption.value = '';
defaultOption.textContent = 'Select a collection...';
collectionSelect.appendChild(defaultOption);

// Add each collection as an option
collections.forEach(collection => {
  const option = document.createElement('option');
  option.value = collection.favouriteCollectionId;
  option.textContent = collection.favouriteCollectionName +
    (collection.collectionType === 'public' ? ' (Public)' : '');
  collectionSelect.appendChild(option);
});