UserPersonalizationService Service
Use the UserPersonalizationService service to manage favorites and favorite categories.
| Method Names | Description |
|---|---|
|
Adds a catalog object as a favorite in favorite list. |
|
|
Adds a category object in favorite manager. |
|
|
Deletes an existing favorite item from favorite manager. |
|
|
Deletes an existing favorite category from favorite manager. |
|
|
Returns all existing favorite items and category. |
|
|
Removes all existing favorite items and category and regenerates all favorite manager items using the supplied list of favorite items. |
|
|
Returns all most recent used items. |
addFavorite() Method
Use the addFavorite() method to add a catalog object as favorite in the favorite list.
Signature
void addFavorite(String catalogObjectPath, String categoryPath, String sessionID);
| Arguments | Description |
|---|---|
|
String catalogObjectPath |
Specifies the catalog object path to add as a favorite. |
|
String categoryPath |
Specifies the category location (in favorite manager) to create the favorite item. If blank, the favorite item is added as a root element in favorite manager. |
|
String sessionID |
Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
addFavoriteCategory() Method
Use the addFavoriteCategory() method to add a category object in favorite manager.
Signature
void addFavoriteCategory(String categoryName, String categoryPath, String sessionID);
| Arguments | Description |
|---|---|
|
String categoryName |
Specifies the catalog object path to add as a favorite. |
|
String categoryPath |
Specifies the category location (in favorite manager) to create new category. If empty, new category will be added on root of favorite manager. |
|
String sessionID |
Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
deleteFavorite() Method
Use the deleteFavorite() method to delete an existing favorite item from favorite manager.
Signature
void deleteFavorite(String catalogObjectPath, String categoryPath, String sessionID);
| Arguments | Description |
|---|---|
|
String catalogObjectPath |
Specifies the catalog object path for which to delete the favorite item. |
|
String categoryPath |
Specifies the category location (in favorite manager) from where favorite item needs to be deleted. If empty, catalog object will be removed from all categories, that is, it will be marked as non favorite object. |
|
String sessionID |
Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
deleteFavoriteCategory() Method
Use the deleteFavoriteCategory() method to delete an existing favorite category from favorite manager.
Signature
void deleteFavoriteCategory(String categoryPath, String sessionID);
| Arguments | Description |
|---|---|
|
String categoryPath |
Specifies the complete category path (in favorite manager) that needs to be deleted. This path starts from /root. |
|
String sessionID |
Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
getFavorites() Method
Use the getFavorites() method to return all existing favorite items and category.
Signature
List[] getFavorites(String categoryPath, boolean recursive, boolean categoryOnly, String sessionID);
| Arguments | Description |
|---|---|
|
String categoryPath |
Specifies the category location (in favorite manager) to create favorite item. If blank, favorite item is added as root element in favorite manager. |
|
Boolean recursive |
Specifies whether the child-level categories were included in the result. |
|
Boolean categoryOnly |
Specifies if only categories were included in the result and excluding all favorite items. |
|
String sessionID |
Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
updateFavorites() Method
Use the updateFavorites() method to remove all existing favorite items and category, and regenerate all favorite manager items using supplied list of favorite items.
Signature
void updateFavorites(List [] favoriteItems, String sessionID);
| Arguments | Description |
|---|---|
|
List [] favoriteItems |
Specifies a list of FavoriteItem structure, for more information, see ForgetAccount Structure. In this FavoriteItem structure, there is no need to fill ItemInfo structure (see ItemInfo Structure), only name, path and type parameters are mandatory. The catalogPath argument is required to add a catalog object in favorite manager. Additionally for optional subItems, you can include a nested FavoriteItem list. |
|
String sessionID |
Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |
getMostRecents() Method
Use the getMostRecents() method to return all most recent used items.
Signature
List[] getMostRecents(UnsignedShort listType, String sessionID);
| Arguments | Description |
|---|---|
|
UnsignedShort listType |
listType value is as following flags: 1 = Recently Updated 2 = Recently Viewed 3 = Frequently Viewed 4 = Recent 5 = Suggestions |
|
String sessionID |
Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null. |