DocumentManager.Delete Method (ConnectionId, SessionId, String, Int32, String)

DocumentManagerDelete Method (ConnectionId, SessionId, String, Int32, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Deletes a document permanently or places it in the Recycling bin. If a document is in the Recycling bin this method deletes the document permanently. This methods supports anonymous callers.

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

Syntax

Copy

public void Delete(
	ConnectionId connectionId,
	SessionId sessionId,
	string xmlParameterData,
	out int status,
	out string statusText
)

Public Sub Delete ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	xmlParameterData As String,
	<OutAttribute> ByRef status As Integer,
	<OutAttribute> ByRef statusText As String
)

Parameters

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).
xmlParameterData: Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema
status: Type: SystemInt32
An integer indicating result of the call. Zero is success.
statusText: Type: SystemString
The textual representation of the call result.

Content Studio permissions

DELETE permission on the document is required when throwing the document into the recycle bin. If the document is published APPROVE permission is required as well (this is always true for uploaded files). To delete the document permanently ADMIN permission is required unless the caller has the Security.GlobalRights.DestroyDocuments or Security.GlobalRights.GlobalGroupAdmin right. Additionally workflow rules can apply and override the regular permissions and rights

Remarks

This is the backwards compatible implementation of this method. This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the status and statusText output parameters.

Reference

DocumentManager Class

Delete Overload

ContentStudio.Document Namespace