core_v2_bookmark Script API

Ben Tiedt — Wed, 20 Nov 2019 14:52:51 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:52:51

Enables scripted content fragments to use bookmarks

CanBookmark
CanUnBookmark
Create
Delete
Get
List
SupportsBookmarks

Methods

CanBookmark

CanBookmark Overload 1

Identifies if the accessing user can bookmark the specified content

Velocity

#set($booleanResponse = $core_v2_bookmark.CanBookmark($contentId, $contentTypeId))

JavaScript

var 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

CanBookmark Overload 2

Identifies if the accessing user can bookmark the specified external content

Velocity

#set($booleanResponse = $core_v2_bookmark.CanBookmark($contentUrl, $oauthClientId))

JavaScript

var 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

Returns

Boolean

CanUnBookmark

CanUnBookmark Overload 1

Identifies if the accessing user can unbookmark the specified content

Velocity

#set($booleanResponse = $core_v2_bookmark.CanUnBookmark($contentId, $contentTypeId))

JavaScript

var 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

CanUnBookmark Overload 2

Identifies if the accessing user can unbookmark the specified external content

Velocity

#set($booleanResponse = $core_v2_bookmark.CanUnBookmark($contentUrl, $oauthClientId))

JavaScript

var 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

Returns

Boolean

Create

Create Overload 1

Bookmarks a piece of content for the accessing user

Velocity

#set($bookmarkResponse = $core_v2_bookmark.Create($contentId, $contentTypeId))

JavaScript

var 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

Create Overload 2

Bookmarks a piece of content for the accessing user

Velocity

#set($bookmarkResponse = $core_v2_bookmark.Create($contentId, $contentTypeId, "%{ TypeId = $typeIdArg }"))

JavaScript

var bookmarkResponse = core_v2_bookmark.Create(contentId, contentTypeId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content Type Id	Required
TypeId	`Guid`	Categorization type	Optional

Returns

[[Bookmark Script API Type|Bookmark]]

Delete

Delete Overload 1

Removes a bookmark for a piece of content for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_bookmark.Delete($contentId))

JavaScript

var additionalInfoResponse = core_v2_bookmark.Delete(contentId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Delete Overload 2

Removes a bookmark for a piece of content for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_bookmark.Delete($contentId, "%{ TypeId = $typeIdArg }"))

JavaScript

var 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

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]

Get

Get Overload 1

Gets an existing bookmark for a piece of content for the accessing user

Velocity

#set($bookmarkResponse = $core_v2_bookmark.Get($contentId))

JavaScript

var bookmarkResponse = core_v2_bookmark.Get(contentId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Get Overload 2

Gets an existing bookmark for a piece of content for the accessing user

Velocity

#set($bookmarkResponse = $core_v2_bookmark.Get($contentId, "%{ TypeId = $typeIdArg }"))

JavaScript

var 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

Get Overload 3

Gets an existing bookmark for a piece of content for the accessing user

Velocity

#set($bookmarkResponse = $core_v2_bookmark.Get($contentUrl, $oauthClientId))

JavaScript

var 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

Get Overload 4

Gets an existing bookmark for a piece of content for the accessing user

Velocity

#set($bookmarkResponse = $core_v2_bookmark.Get($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))

JavaScript

var bookmarkResponse = core_v2_bookmark.Get(contentUrl, oauthClientId, { TypeId: typeIdArg });

Parameters

Name	Type	Description	Required
contentUrl	`String`	Content Url	Required
oauthClientId	`Guid`	Oauth Client Id	Required
TypeId	`Guid`	Categorization type	Optional

Returns

[[Bookmark Script API Type|Bookmark]]

List

Lists bookmarks

Velocity

#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 }"))

JavaScript

var 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	`Boolean`	Include sub containers. ContainerId must be set if this is set.	Optional
PageIndex	`Int32`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Int32`	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	`Int32`	User identifier	Optional

Returns

[[PagedList Script API Type|PagedList]] of [[Bookmark Script API Type|Bookmark]]

SupportsBookmarks

Identifies whether the specified content type supports bookmarks

Velocity

#set($booleanResponse = $core_v2_bookmark.SupportsBookmarks($contentTypeId))

JavaScript

var booleanResponse = core_v2_bookmark.SupportsBookmarks(contentTypeId);

Parameters

Name	Type	Description	Required	Default	Options
contentTypeId	`Guid`	Content Type Id	Required

Returns

Boolean