Bookmarks In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:12 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:04:12

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IBookmarks>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void BookmarkAfterCreateEventHandler([[BookmarkAfterCreateEventArgs In-Process API Event Argument|BookmarkAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void BookmarkAfterDeleteEventHandler([[BookmarkAfterDeleteEventArgs In-Process API Event Argument|BookmarkAfterDeleteEventArgs]] e);

Events.BeforeCreate

Handler

void BookmarkBeforeCreateEventHandler([[BookmarkBeforeCreateEventArgs In-Process API Event Argument|BookmarkBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void BookmarkBeforeDeleteEventHandler([[BookmarkBeforeDeleteEventArgs In-Process API Event Argument|BookmarkBeforeDeleteEventArgs]] e);

Properties

Name	Type	Description	Default	Options
DataTypeId	`Guid`	Bookmarks data type identifier

Methods

bool CanBookmark(Guid contentId, Guid contentType);

Identifies if the accessing user can bookmark the specified content

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	ContentId	Required
contentType	`Guid`	Content type Id	Required

Return Type

bool

bool CanBookmark(string contentUrl, Guid oauthClientId);

Identifies if the accessing user can bookmark the specified external content

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`string`	Content url	Required
oauthClientId	`Guid`	OAuthClientId	Required

Return Type

bool

bool CanUnBookmark(Guid contentId, Guid contentType);

Identifies if the accessing user can unbookmark the specified content

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	ContentId	Required
contentType	`Guid`	Content type Id	Required

Return Type

bool

bool CanUnBookmark(string contentUrl, Guid oauthClientId);

Identifies if the accessing user can unbookmark the specified external content

Parameters

Name	Type	Description	Required	Default	Options
contentUrl	`string`	Content url	Required
oauthClientId	`Guid`	OAuthClientId	Required

Return Type

bool

Bookmark Create(Guid contentId, Guid contentTypeId, BookmarkCreateOptions options = null);

Creates a bookmark

Parameters

Name	Type	Description	Required
contentId	`Guid`	Content Id	Required
contentTypeId	`Guid`	Content type Id	Required
options	`[[BookmarkCreateOptions In-Process API Supplementary Type\|BookmarkCreateOptions]]`	Options include: TypeId	Optional

Return Type

[[Bookmark In-Process API Supplementary Type|Bookmark]]

Bookmark Create(string contentUrl, Guid oauthClientId, BookmarkCreateOptions options = null);

Creates a bookmark

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content url	Required
oauthClientId	`Guid`	OAuthClientId	Required
options	`[[BookmarkCreateOptions In-Process API Supplementary Type\|BookmarkCreateOptions]]`	Options include: TypeId	Optional

Return Type

[[Bookmark In-Process API Supplementary Type|Bookmark]]

AdditionalInfo Delete(Guid contentId, BookmarkDeleteOptions options = null);

Deletes a bookmark

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
options	`[[BookmarkDeleteOptions In-Process API Supplementary Type\|BookmarkDeleteOptions]]`	Options include: TypeId	Optional

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

AdditionalInfo Delete(string contentUrl, Guid oauthClientId, BookmarkDeleteOptions options = null);

Deletes a bookmark

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content url	Required
oauthClientId	`Guid`	OAuthClientId	Required
options	`[[BookmarkDeleteOptions In-Process API Supplementary Type\|BookmarkDeleteOptions]]`	Options include: TypeId	Optional

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

Bookmark Get(Guid contentId, BookmarkGetOptions options = null);

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

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required
options	`[[BookmarkGetOptions In-Process API Supplementary Type\|BookmarkGetOptions]]`	Options include: TypeId	Optional

Return Type

[[Bookmark In-Process API Supplementary Type|Bookmark]]

Bookmark Get(string contentUrl, Guid oauthClientId, BookmarkGetOptions options = null);

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

Parameters

Name	Type	Description	Required
contentUrl	`string`	Content url	Required
oauthClientId	`Guid`	OAuthClientId	Required
options	`[[BookmarkGetOptions In-Process API Supplementary Type\|BookmarkGetOptions]]`	Options include: TypeId	Optional

Return Type

[[Bookmark In-Process API Supplementary Type|Bookmark]]

PagedList<Bookmark> List(BookmarkListOptions options = null);

Lists bookmarks

Parameters

Name	Type	Description	Required	Default	Options
options	`[[BookmarkListOptions In-Process API Supplementary Type\|BookmarkListOptions]]`	Options include: ContainerId, ApplicationId, ContentTypeIds, UserId, TypeId, SortBy, SortOrder, PageSize, PageIndex	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[Bookmark In-Process API Supplementary Type|Bookmark]]>

bool SupportsBookmarks(Guid contentType);

Identifies whether the specified content type supports bookmarks

Parameters

Name	Type	Description	Required	Default	Options
contentType	`Guid`	Content type Id	Required

Return Type

bool