DocumentApproveAsyncHandler Class Content Studio 5.7 SDK
Content Studio Web Content Management System

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

When implemented in derived classes, represents an event handler that handles the OnDocumentApprove asynchronous event in Content Studio 5.2 SP1 and later.
Inheritance Hierarchy

SystemObject
  ContentStudio.EventActions.AsynchronousEventHandlersAsynchronousEventHandlerBase
    ContentStudio.EventActions.AsynchronousEventHandlersDocumentApproveAsyncHandler

Namespace: ContentStudio.EventActions.AsynchronousEventHandlers
Assembly: AsynchronousEventHandlers (in AsynchronousEventHandlers.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax

public abstract class DocumentApproveAsyncHandler : AsynchronousEventHandlerBase, 
	ISingleAsynchronousHandler

The DocumentApproveAsyncHandler type exposes the following members.

Constructors

  NameDescription
Protected methodDocumentApproveAsyncHandler
Initializes a new instance of the DocumentApproveAsyncHandler class
Top
Properties

  NameDescription
Protected propertyCallerEmailAddress
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.)
Protected propertyCallerIdentifier
Gets the internal Content Studio identifier of the caller.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyCallerLogOnName
Gets the login name of the calling user.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyCallerName
Gets the name of the caller.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyCallerSessionId
Gets the caller's session id.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyCallerSid
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.)
Protected propertyCallerUserKey
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.)
Protected propertyCategoryId
Gets the category id.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyConnectionId
Gets the connection id.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyCredentials
Gets the credentials passed in to the event handler.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyDocumentId
Gets the document id.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyDocumentName
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.)
Protected propertyDocumentTitle
Gets the document title which is the name of the document without the path ex. IE_Style
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyEncodingName
Gets the encoding name of the document. This value can be null (Nothing in Visual Basic).
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyEventId
Gets the numeric event identifier.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyEventName
Gets the name of the event.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyEventTimestamp
Gets A date time value that indicates when the event was triggered in Content Studio.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyExtendedPropertyCount
Gets the number of extended properties.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyExtendedPropertyNames
Gets the extended property names.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyExternalDocumentId
Gets the document identifier of an object that has been scheduled by an external provider.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyFileName
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.)
Protected propertyGuoid
Gets the document GUOID (Global object unique identifier) in its string format.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyMessageId
Gets the unique message id.
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyQueueId
Gets the queue identifier. Service manager can inject this value when it handles the job
(Inherited from AsynchronousEventHandlerBase.)
Protected propertyStatus
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.)
Public propertySupportedEventIdentifier
Gets the numeric identifier of the event allowed.
Public propertySupportedEventName
Gets the name of the event allowed.
Protected propertyTimeOut
Gets the time out value that was provided to the event handler.
(Inherited from AsynchronousEventHandlerBase.)
Public propertyVersionNumber
Gets the version number of the content that is approved.
Top
Methods

  NameDescription
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from AsynchronousEventHandlerBase.)
Protected methodDispose(Boolean)
Releases unmanaged and - optionally - managed resources
(Inherited from AsynchronousEventHandlerBase.)
Protected methodDoWork
When implemented in derived class performs the actual work in the event handler.
(Inherited from AsynchronousEventHandlerBase.)
Public methodEquals (Inherited from Object.)
Protected methodExistsExtendedProperty
Determines whether the specified extended property exists.
(Inherited from AsynchronousEventHandlerBase.)
Protected methodFinalize
Releases unmanaged resources and performs other cleanup operations before the AsynchronousEventHandlerBase is reclaimed by garbage collection.
(Inherited from AsynchronousEventHandlerBase.)
Protected methodFinish
This method gets called after that the event handler work operation has been completed.
(Inherited from AsynchronousEventHandlerBase.)
Protected methodGetExtendedPropertyValue(Type, String)
Gets the extended property value as a specific data type.
(Inherited from AsynchronousEventHandlerBase.)
Protected methodGetExtendedPropertyValueT(String)
Gets the extended property value as a specific data type.
(Inherited from AsynchronousEventHandlerBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodInit
When overridden in derived classes, performs custom initialization.
(Inherited from AsynchronousEventHandlerBase.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodParseCustomData
When overridden in derived classes, developers can use this method to get the custom data passed in to the event handler.
(Inherited from AsynchronousEventHandlerBase.)
Protected methodParseInputXml (Overrides AsynchronousEventHandlerBaseParseInputXml(String).)
Protected methodCode examplePreInit
Initializes the value of the passed event handler properties to their corresponding properties.
(Inherited from AsynchronousEventHandlerBase.)
Public methodToString (Inherited from Object.)
Protected methodValidateEvent
Checks whether the current handler is valid for the OnDocumentApprove event.
(Overrides AsynchronousEventHandlerBaseValidateEvent(Int32).)
Top
Remarks

Note Note
This class requires Content Studio version 5.2 and was introduced in Content Studio version 5.2 SP1.

The OnDocumentApprove event triggers when a document is approved 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 eventhandler is then recorded in the Content Studio event log.

See Also

Reference

Other Resources