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

NotificationManagerDelete Method (ConnectionId, SessionId, Int32, String)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Deletes a notification.

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

Syntax

public void Delete(
	ConnectionId connectionId,
	SessionId sessionId,
	int notificationId,
	string applicationId
)

Public Sub Delete ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	notificationId As Integer,
	applicationId 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).
notificationId: Type: SystemInt32
An identifier to the notification item to delete.
applicationId: Type: SystemString
A string that can be converted to a GUID (global unique identifier). This parameter must be used by custom applications that need to protect its tasks from being tampered with. If the caller that created the task did not include a value for this parameter it is ignored. This parameter should be null or empty if no AppID exits for the item in question.

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
CSPermissionDeniedException	The caller has no permission to perform the requested action
CSInvalidSessionException	The session is invalid
CSInvalidParameterException	A parameter has an invalid value
CSDocumentNotFoundException	The notification could not be found
SqlException	An error occurred when executing the command against the Content Studio database
FormatException	The format of the passed in AppID is not valid
OverflowException	The format of the passed in AppID is not valid

Content Studio permissions

The caller must have delete permission on the notification item in order for the call to succeed. Normally only the receiver, sender and administrators have this permission. If the item is of type NotificationType.Task it can only be deleted when it has been completed or status is NotificationStatus.TaskAbandonedByReceiver or higher otherwise a ContentStudio.CSPermissionDeniedException will be thrown.

Remarks

When deleted the message is marked as deleted rather that physically deleted. However, calling this procedure on an item marked as deleted will remove it permanently from the database.

Reference

NotificationManager Class

Delete Overload

ContentStudio.Notifications Namespace