Enables scripted content fragments to use bookmarks
Methods
CanBookmark
Identifies if the accessing user can bookmark the specified content
Usage
#set($booleanResponse = $core_v2_bookmark.CanBookmark($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
CanBookmark
Identifies if the accessing user can bookmark the specified external content
Usage
#set($booleanResponse = $core_v2_bookmark.CanBookmark($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
bool
CanUnBookmark
Identifies if the accessing user can unbookmark the specified content
Usage
#set($booleanResponse = $core_v2_bookmark.CanUnBookmark($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool
CanUnBookmark
Identifies if the accessing user can unbookmark the specified external content
Usage
#set($booleanResponse = $core_v2_bookmark.CanUnBookmark($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
bool
Create
Bookmarks a piece of content for the accessing user
Usage
#set($bookmarkResponse = $core_v2_bookmark.Create($contentId, $contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required |
Return Type
Create
Bookmarks a piece of content for the accessing user
Usage
#set($bookmarkResponse = $core_v2_bookmark.Create($contentId, $contentTypeId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
contentTypeId | Guid | Content Type Id | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Delete
Removes a bookmark for a piece of content for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_bookmark.Delete($contentId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required |
Return Type
Delete
Removes a bookmark for a piece of content for the accessing user
Usage
#set($additionalInfoResponse = $core_v2_bookmark.Delete($contentId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Get
Gets an existing bookmark for a piece of content for the accessing user
Usage
#set($bookmarkResponse = $core_v2_bookmark.Get($contentId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required |
Return Type
Get
Gets an existing bookmark for a piece of content for the accessing user
Usage
#set($bookmarkResponse = $core_v2_bookmark.Get($contentId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentId | Guid | Content Id | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
Get
Gets an existing bookmark for a piece of content for the accessing user
Usage
#set($bookmarkResponse = $core_v2_bookmark.Get($contentUrl, $oauthClientId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required |
Return Type
Get
Gets an existing bookmark for a piece of content for the accessing user
Usage
#set($bookmarkResponse = $core_v2_bookmark.Get($contentUrl, $oauthClientId, "%{TypeId = $typeIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentUrl | string | Content Url | Required | ||
oauthClientId | Guid | Oauth Client Id | Required | ||
TypeId | Guid | Categorization type | Optional |
Return Type
List
Lists bookmarks
Usage
#set($pagedListResponse = $core_v2_bookmark.List("%{ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentId = $contentIdArg, ContentTypeIds = $contentTypeIdsArg, IncludeSubContainers = $includeSubContainersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TypeId = $typeIdArg, UserId = $userIdArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ApplicationId | Guid | Content application identifier | Optional | ||
ContainerId | Guid | Content container identifier | Optional | ||
ContentId | Guid | Content identifier | Optional | ||
ContentTypeIds | string | Comma-seperated list of content type identifiers | Optional | ||
IncludeSubContainers | bool | Include sub containers. ContainerId must be set if this is set. | Optional | ||
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 mechanism | Optional | Date | Application, Date, Title |
SortOrder | string | Sort order | Optional | Ascending | Ascending, Descending |
TypeId | Guid | Categorization type | Optional | ||
UserId | int | User identifier | Optional |
Return Type
SupportsBookmarks
Identifies whether the specified content type supports bookmarks
Usage
#set($booleanResponse = $core_v2_bookmark.SupportsBookmarks($contentTypeId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
contentTypeId | Guid | Content Type Id | Required |
Return Type
bool