new FavoriteService()
Methods
addObjects(objectIdsopt) → {Promise}
Add selected objectIds into favorite
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
objectIds |
Array.<string> |
<optional> |
Objects Id which to be added into favorite |
Returns:
Promise that if is resolved successfully will contain the requested data
- Type
- Promise
clear() → {Promise}
Clears the favorite content.
Returns:
Promise that if is resolved successfully removes the favorite content.
- Type
- Promise
getTableData(tableConfig) → {Promise}
Return favorite data.
Parameters:
| Name | Type | Description |
|---|---|---|
tableConfig |
string | Example 'tvc:tableconfig:helium:favoriteobject/Favorite.xml' |
Returns:
Promise that if is resolved successfully will contain the requested data
- Type
- Promise
isLimitAvailable() → {Promise}
Checks if limit is available to add favorite objects.
Returns:
Promise that if is resolved successfully gives a boolean of limit availability
- Type
- Promise
removeObjects(objectIdsopt) → {Promise}
Remove objectId from favorite.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
objectIds |
Array.<string> |
<optional> |
Objects Ids which are to be removed from favorite |
Returns:
Promise that if is resolved successfully will object from favorite list
- Type
- Promise