Content Studio Web Content Management System
SystemObject
ContentStudio.EventActions.AsynchronousEventHandlersAsynchronousEventHandlerBase
ContentStudio.EventActions.AsynchronousEventHandlersDocumentDeleteAsyncHandler
Assembly: AsynchronousEventHandlers (in AsynchronousEventHandlers.dll) Version: 1.0.0.0 (1.0.0.0)
Top
Top
Top
[This is preliminary documentation and is subject to change.]
When implemented in derived classes, represents an event handler that handles the OnDocumentDelete
asynchronous event in Content Studio 5.2 SP1 and later.
Inheritance Hierarchy
ContentStudio.EventActions.AsynchronousEventHandlersAsynchronousEventHandlerBase
ContentStudio.EventActions.AsynchronousEventHandlersDocumentDeleteAsyncHandler
Namespace: ContentStudio.EventActions.AsynchronousEventHandlers
Assembly: AsynchronousEventHandlers (in AsynchronousEventHandlers.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
public abstract class DocumentDeleteAsyncHandler : AsynchronousEventHandlerBase, ISingleAsynchronousHandler
The DocumentDeleteAsyncHandler type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DocumentDeleteAsyncHandler | Initializes a new instance of the DocumentDeleteAsyncHandler class |
Properties
Name | Description | |
---|---|---|
CallerEmailAddress |
Gets or sets the caller email address.
Currently (CS 5.2 SP1) this property is not implemented and always returns null (Nothing in Visual Basic).
(Inherited from AsynchronousEventHandlerBase.) | |
CallerIdentifier |
Gets the internal Content Studio identifier of the caller.
(Inherited from AsynchronousEventHandlerBase.) | |
CallerLogOnName |
Gets the login name of the calling user.
(Inherited from AsynchronousEventHandlerBase.) | |
CallerName |
Gets the name of the caller.
(Inherited from AsynchronousEventHandlerBase.) | |
CallerSessionId |
Gets the caller's session id.
(Inherited from AsynchronousEventHandlerBase.) | |
CallerSid |
Gets or sets the SecurityIdentifier of the calling user.
Currently (CS 5.2 SP1) this property is not implemented and always returns null (Nothing in Visual Basic).
(Inherited from AsynchronousEventHandlerBase.) | |
CallerUserKey |
Gets or sets the caller's user key.
Currently (CS 5.2 SP1) this property is not implemented and always returns null (Nothing in Visual Basic).
(Inherited from AsynchronousEventHandlerBase.) | |
CategoryId |
Gets the category id.
(Inherited from AsynchronousEventHandlerBase.) | |
ConnectionId |
Gets the connection id.
(Inherited from AsynchronousEventHandlerBase.) | |
Credentials |
Gets the credentials passed in to the event handler.
(Inherited from AsynchronousEventHandlerBase.) | |
DocumentId |
Gets the document id.
(Inherited from AsynchronousEventHandlerBase.) | |
DocumentName |
Gets the name of the document. This is the name including the path relative the site root
ex. System/Stylesheets/IE_Style (Inherited from AsynchronousEventHandlerBase.) | |
DocumentTitle |
Gets the document title which is the name of the document without the path
ex. IE_Style (Inherited from AsynchronousEventHandlerBase.) | |
EncodingName |
Gets the encoding name of the document. This value can be null (Nothing in Visual Basic).
(Inherited from AsynchronousEventHandlerBase.) | |
EventId |
Gets the numeric event identifier.
(Inherited from AsynchronousEventHandlerBase.) | |
EventName |
Gets the name of the event.
(Inherited from AsynchronousEventHandlerBase.) | |
EventTimestamp |
Gets A date time value that indicates when the event was triggered in Content Studio.
(Inherited from AsynchronousEventHandlerBase.) | |
ExtendedPropertyCount |
Gets the number of extended properties.
(Inherited from AsynchronousEventHandlerBase.) | |
ExtendedPropertyNames |
Gets the extended property names.
(Inherited from AsynchronousEventHandlerBase.) | |
ExternalDocumentId |
Gets the document identifier of an object that has been scheduled by an external provider.
(Inherited from AsynchronousEventHandlerBase.) | |
FileName |
Gets the name of the document's file on disc.
Ex. C:\Content Studio\CS52\Sites\Site52\System\Stylesheets\F0B85EEC-925B-4A70-8D95-D14D48C76978.aspx (Inherited from AsynchronousEventHandlerBase.) | |
Guoid |
Gets the document GUOID (Global object unique identifier) in its string format.
(Inherited from AsynchronousEventHandlerBase.) | |
MessageId |
Gets the unique message id.
(Inherited from AsynchronousEventHandlerBase.) | |
QueueId |
Gets the queue identifier. Service manager can inject this value when it handles the job
(Inherited from AsynchronousEventHandlerBase.) | |
Status |
Gets or sets the status to report back to Content Studio after a successful operation.
This message will be recorded in the Content Studio event log.
(Inherited from AsynchronousEventHandlerBase.) | |
SupportedEventIdentifier |
Gets the numeric identifier of the event allowed.
| |
SupportedEventName |
Gets the name of the event allowed.
| |
TimeOut |
Gets the time out value that was provided to the event handler.
(Inherited from AsynchronousEventHandlerBase.) |
Methods
Name | Description | |
---|---|---|
Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from AsynchronousEventHandlerBase.) | |
Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources
(Inherited from AsynchronousEventHandlerBase.) | |
DoWork |
When implemented in derived class performs the actual work in the event handler.
(Inherited from AsynchronousEventHandlerBase.) | |
Equals | (Inherited from Object.) | |
ExistsExtendedProperty |
Determines whether the specified extended property exists.
(Inherited from AsynchronousEventHandlerBase.) | |
Finalize |
Releases unmanaged resources and performs other cleanup operations before the
AsynchronousEventHandlerBase is reclaimed by garbage collection.
(Inherited from AsynchronousEventHandlerBase.) | |
Finish |
This method gets called after that the event handler work operation has been
completed.
(Inherited from AsynchronousEventHandlerBase.) | |
GetExtendedPropertyValue(Type, String) |
Gets the extended property value as a specific data type.
(Inherited from AsynchronousEventHandlerBase.) | |
GetExtendedPropertyValueT(String) |
Gets the extended property value as a specific data type.
(Inherited from AsynchronousEventHandlerBase.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Init |
When overridden in derived classes, performs custom initialization.
(Inherited from AsynchronousEventHandlerBase.) | |
MemberwiseClone | (Inherited from Object.) | |
ParseCustomData |
When overridden in derived classes,
developers can use this method to get the custom data passed in to the event handler.
(Inherited from AsynchronousEventHandlerBase.) | |
ParseInputXml |
Parses the event data xml passed in the event handler.
(Inherited from AsynchronousEventHandlerBase.) | |
PreInit |
Initializes the value of the passed event handler properties to their corresponding properties.
(Inherited from AsynchronousEventHandlerBase.) | |
ToString | (Inherited from Object.) | |
ValidateEvent |
Checks whether the current handler is valid for the OnDocumentDelete event.
(Overrides AsynchronousEventHandlerBaseValidateEvent(Int32).) |
Remarks
Note |
---|
This class requires Content Studio version 5.2 and was introduced in Content Studio version 5.2 SP1. |
The OnDocumentDelete event triggers when a document is thrown in the recycling bin and there is an definition for the event on the document's category. An asynchronous event is recorded by Content Studio and added to the internal queue and executed later by the Content Studio Service Manager. The outcome of the event handler is then recorded in the Content Studio event log.
See Also