Click or drag to resize

KicHandler Class

A web handler that extends the WebCaptureRequestHandler which can be used to connect to a KIC (Kofax Internet Connector) web service endpoint.
Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.WebControls.CaptureWebCaptureRequestHandler
    Atalasoft.Imaging.WebControls.CaptureKicHandler

Namespace:  Atalasoft.Imaging.WebControls.Capture
Assembly:  Atalasoft.dotImage.WebControls (in Atalasoft.dotImage.WebControls.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax
public class KicHandler : WebCaptureRequestHandler

The KicHandler type exposes the following members.

Constructors
  NameDescription
Public methodKicHandler
Initializes a new instance of the KicHandler class
Top
Properties
  NameDescription
Public propertyIsReusable
Returns whether this handler can be reused.
(Inherited from WebCaptureRequestHandler.)
Top
Methods
  NameDescription
Protected methodBatchFieldsForBatchClass
Returns the batch fields for a specified batch class.
(Overrides WebCaptureRequestHandlerBatchFieldsForBatchClass(String).)
Protected methodCurrentImportId
Returns the guid for the most recent import for the current session.
(Overrides WebCaptureRequestHandlerCurrentImportId.)
Protected methodDictListToJson
A helper method to turn List<Dictionary<string, string>> into JSON.
(Inherited from WebCaptureRequestHandler.)
Protected methodDictToJson
A helper method to turn a Dictionary<string, string> into JSON.
(Inherited from WebCaptureRequestHandler.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetContentTypeDescription
Returns the document classes, and form type names for the selected content type.
(Overrides WebCaptureRequestHandlerGetContentTypeDescription(HttpContext, String).)
Protected methodGetContentTypeList
Returns the content type names published on the Kofax Capture server that is specifed in the service end point.
(Overrides WebCaptureRequestHandlerGetContentTypeList(HttpContext).)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetNewImportId
Returns a guid in string form.
(Inherited from WebCaptureRequestHandler.)
Protected methodGetRawXml
Returns the full unparsed xml returned from KIC for the specified content type.
(Overrides WebCaptureRequestHandlerGetRawXml(String).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodHandleUpload
Decodes the base64 encoded stream from the client, and save it as a tif file.
(Inherited from WebCaptureRequestHandler.)
Protected methodImportDocument
Imports a document with the specified batch class, document class, and folder type name.
(Overrides WebCaptureRequestHandlerImportDocument(HttpContext, String, String, String, String).)
Protected methodImportDocumentWithIndexFields
Method to import a document for the specified contentType, documentClass, and indexfields for the documentClass into KC through KIC.
(Overrides WebCaptureRequestHandlerImportDocumentWithIndexFields(HttpContext, String, String, String, String, String).)
Protected methodIndexFieldsForDocumentClass
Returns a list of index fields for each document class in the content type specified.
(Overrides WebCaptureRequestHandlerIndexFieldsForDocumentClass(String, String).)
Protected methodIndexFieldsForImport
Creates a Indexfield definition
Protected methodListToJson
A helper method to turn a List<string> into JSON.
(Inherited from WebCaptureRequestHandler.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodProcessRequest
This is the entry point to the handler. Requests to this take the form of: http://yourServerName/theHandlerName.ashx?cmd=getContentTypeList
(Inherited from WebCaptureRequestHandler.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodTrackStatus
Returns the status of the import for the most recent successfully imported document. The importId would be the guid returned from a successful import.
(Overrides WebCaptureRequestHandlerTrackStatus(String).)
Top
Remarks
Caution note Caution
The KIC handler class is available with .NET Framework 3.5 and 4.5.2 only.
See Also