Enables scripted content fragments to use Favorites
Methods
Delete
Deletes a favorite
Usage
#set($additionalInfoResponse = $core_v2_favorite.Delete($uri, $favoriteType))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| uri | string | URL of favorited item to delete | Required | | |
| favoriteType | string | Type of favorite | Required | | |
Return Type
AdditionalInfo
List
Lists favorited items for a user
Usage
#set($pagedListResponse = $core_v2_favorite.List($userId, "%{Application = $applicationArg, FavoriteTypes = $favoriteTypesArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| userId | int | Id of user | Required | | |
| Application | string | Used to filter to specific applications | Optional | Unknown | Calendar, Forum, MediaGallery, Unknown, Weblog, Wiki |
| FavoriteTypes | string | Comma delimited string that contains the favorite types to filter by | Optional | | Forum, Group, MediaGallery, Weblog, Wiki |
| PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
| SortBy | string | Sort By | Optional | Title | Application, Title |
Return Type
PagedList<Favorite>