Requires Appx version 1.17.0 or higher.
Collection
my.isCollected
Check whether the current Mini App is in the user’s favorites (collection).
Returns the collection status of the Mini App — whether the user has added it to their favorites.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Check whether the current Mini App is in the user’s favorites (collection).
| Property | Type | Required | Description |
|---|---|---|---|
| success | Function | No | Callback on success |
| fail | Function | No | Callback on failure |
| complete | Function | No | Callback that always executes |
| Property | Type | Description |
|---|---|---|
| isCollected | Boolean | true if the Mini App is in the user’s favorites, false otherwise |
| Code | Message | Resolution |
|---|---|---|
| -1 | Unknown collection status | The Mini App has not been added to favorites yet. Add it first, then retry. |
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);
}
});