Type Alias: GetFavouriteItems()

GetFavouriteItems = () => Promise<FavouriteCollectionItems>

Function

Retrieves all saved favorite items for the current user.

This method fetches the complete list of saved product configurations and modular scenes that the current user has access to. The returned data includes both private favorites (created by the user) and public favorites (shared across the organization), each organized within their respective collections.

This comprehensive favorites data can be used to build favorites browsers, selection interfaces, or to implement "recently used" features.

Returns

Promise<FavouriteCollectionItems>

A promise that resolves to an object containing both public and user-specific favorite collections

Example

// Fetch and display all favorites organized by collection type
const favorites = await window.mimeeqApp.actions.getFavouriteItems();

// Display public favorites
const publicContainer = document.getElementById('public-favorites');
publicContainer.innerHTML = '<h3>Public Favorites</h3>';

if (favorites.publicFavouriteCollections.length === 0) {
  publicContainer.innerHTML += '<p>No public favorites available</p>';
} else {
  favorites.publicFavouriteCollections.forEach(fav => {
    const favElement = createFavoriteElement(fav);
    publicContainer.appendChild(favElement);
  });
}

// Display user's private favorites
const userContainer = document.getElementById('my-favorites');
userContainer.innerHTML = '<h3>My Favorites</h3>';

if (favorites.userFavouriteCollections.length === 0) {
  userContainer.innerHTML += '<p>You haven\'t saved any favorites yet</p>';
} else {
  favorites.userFavouriteCollections.forEach(fav => {
    const favElement = createFavoriteElement(fav);
    userContainer.appendChild(favElement);
  });
}