S4ServiceClient Methods A Sandcastle Documented Class Library

The S4ServiceClient type exposes the following members.

Methods

  Name Description
Public method annotateDocument
Annotates a single document with the specified MIME type. Returns an object which allows for convenient access to the annotations in the annotated document.
Public method annotateDocumentAsStream
Annotates a single document and returns an {@link InputStream} from which the contents of the serialized annotated document can be read
Public method annotateDocumentFromUrl
Annotates a single document publicly available under a given URL. Returns an object which allows for convenient access to the annotations in the annotated document
Public method annotateDocumentFromUrlAsStream
Annotates a single document publicly available under a given URL. Returns the annotated document serialized into the specified format
Public method annotateFileContents
Annotates the contents of a single file with the specified MIME type. Returns an object which allows for convenient access to the annotations in the annotated document.
Public method annotateFileContentsAsStream
Annotates the contents of a single file returning an {@link InputStream} from which the annotated content can be read
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public method Static member GetProperties
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Private method Static member load
Public method Static member main
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method Static member NumToEnumT
Private method Static member printUsageAndTerminate
Public method processRequest
This low level method allows the user to specify every parameter explicitly by setting the properties of the OnlineService request object. Returns an object which wraps the annotated document.
Public method processRequestForStream
This low level method allows the user to explicitly specify all the parameters sent to the service. This is done by constructing the appropriate ServiceRequest object. Returns the contents of the annotated document
Private method Static member readCredentials
Public method ToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also

Reference