DocumentManager.RemoveFromFavourites Method (ConnectionId, SessionId, DocumentId)

DocumentManagerRemoveFromFavourites Method (ConnectionId, SessionId, DocumentId)

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Removes a document from the list of favorite documents.

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

public void RemoveFromFavourites(
	ConnectionId connectionId,
	SessionId sessionId,
	DocumentId documentId
)

Public Sub RemoveFromFavourites ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	documentId As DocumentId
)

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site
sessionId: Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
documentId: Type: ContentStudio.DocumentDocumentId
The document to remove

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

Any authenticated user can add documents to her own favorites.