Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rebellapp.com/llms.txt

Use this file to discover all available pages before exploring further.

Returns the collection status of the Mini App — whether the user has added it to their favorites.
Requires Appx version 1.17.0 or higher.

Parameters

PropertyTypeRequiredDescription
successFunctionNoCallback on success
failFunctionNoCallback on failure
completeFunctionNoCallback that always executes

Success Callback Parameters

PropertyTypeDescription
isCollectedBooleantrue if the Mini App is in the user’s favorites, false otherwise

Error Codes

CodeMessageResolution
-1Unknown collection statusThe Mini App has not been added to favorites yet. Add it first, then retry.

Code Example

my.isCollected({
  success: (res) => {
    if (res.isCollected) {
      console.log('Mini App is in favorites');
    } else {
      console.log('Mini App is not in favorites');
    }
  },
  fail: (err) => {
    console.error('Failed to check collection status:', err);
  }
});