Favorites Methods
Use
getFavoritesProviders(callback, arguments)
Returns an array of FavoritesProvider objects available for the current user
|
Parameter |
Description |
|---|---|
|
callback |
A callback function to which to pass the array |
|
arguments |
A JavaScript object passed to the callback function |
Return Value
An array of FavoritesProvider objects
navigateToFavorite (favorite)
Triggers navigation to the specified favorite
|
Parameter |
Description |
|---|---|
|
favorite |
A Favorite object |
addFavorite (nodeURL, title, callback, arguments)
Adds the specified navigation node to the list of favorites for the current user
|
Parameter |
Description |
|---|---|
|
nodeURL |
The navigation node URL |
|
title |
The title of the favorite |
|
callback |
A notification function to call when the favorite is added |
|
arguments |
A JavaScript object passed to the callback |
deleteFavorite (ID, callback, arguments)
Deletes the specified favorite for the current user
|
Parameter |
Description |
|---|---|
|
ID |
The ID of the favorite to delete |
|
callback |
A notification function to call when the favorite is deleted |
|
arguments |
A JavaScript object passed to the callback |
renameFavorite (ID, newTitle)
Renames the specified favorite for the current user
|
Parameter |
Description |
|---|---|
|
ID |
The ID of the favorite |
|
newTitle |
The new title |
moveFavorite (sourceID, targetID, position)
Moves the specified favorite to the specified position within the containing folder. To move favorites between folders, use moveFavoriteToFolder ().
|
Parameter |
Description |
|---|---|
|
sourceID |
The ID of the source favorite |
|
targetID |
Currently not in use |
|
position |
The new position of the favorite:
|
moveFavoriteToFolder (favoriteID, folderID)
Moves the specified favorite to the specified folder
|
Parameter |
Description |
|---|---|
|
favoriteID |
The ID of the favorite |
|
folderID |
The ID of the target folder |