InstallEventHandlerBase Class

Relativity Event Handlers
Base class for install event handler instances.
Inheritance Hierarchy

System.Object
  System.MarshalByRefObject
    kCura.EventHandler.InstallEventHandlerBase
      kCura.EventHandler.PostInstallEventHandler
      kCura.EventHandler.PreInstallEventHandler
      kCura.EventHandler.PreUninstallEventHandler

Namespace:  kCura.EventHandler
Assembly:  kCura.EventHandler (in kCura.EventHandler.dll) Version: 17.0.1.1 588f15fd7550dbf54835f3417a0142d4ea37dbb5
Syntax

[SerializableAttribute]
public abstract class InstallEventHandlerBase : MarshalByRefObject, 
	IExecutable, IInstallEventHandlerProperties, IDisposable

[SerializableAttribute]
public abstract class InstallEventHandlerBase : MarshalByRefObject, 
	IExecutable, IInstallEventHandlerProperties, IDisposable

The InstallEventHandlerBase type exposes the following members.

Properties

  NameDescription
Public propertyApplicationArtifactId
ArtifactId of the Application in the workspace.
Public propertyCurrentVersion
Current Version of the application in the workspace.
Public propertyDirty
Boolean to indicate if the application had been unlocked for any reason since the last install.
Public propertyHelper
Gets and/or sets the Helper property of the event hendler which returns IEHHelper object from Relativity.API.
Public propertyVersionInstalling
Version of the application being installed.
Top
Methods

  NameDescription
Public methodCreateObjRef
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
(Inherited from MarshalByRefObject.)
Public methodDispose
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodExecute
Execute function that is called when the application is installed.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLifetimeService
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
(Inherited from MarshalByRefObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitializeLifetimeService
Returns an object used to control the lifetime policy for this instance
(Overrides MarshalByRefObject.InitializeLifetimeService().)
Public methodSetInstallProperties
Sets needed parameters for install event handlers.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks

See Also

Reference