S4ServiceClient.annotateDocumentFromUrlAsStream Method

S4ServiceClientannotateDocumentFromUrlAsStream Method

A Sandcastle Documented Class Library

Annotates a single document publicly available under a given URL. Returns the annotated document serialized into the specified format

Namespace: Ontotext.S4.service
Assembly: S4ClientLibrary (in S4ClientLibrary.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax

C++

Copy

public Stream annotateDocumentFromUrlAsStream(
	Uri documentUrl,
	SupportedMimeType documentMimeType,
	ResponseFormat serializationFormat
)

Public Function annotateDocumentFromUrlAsStream ( 
	documentUrl As Uri,
	documentMimeType As SupportedMimeType,
	serializationFormat As ResponseFormat
) As Stream

public:
Stream^ annotateDocumentFromUrlAsStream(
	Uri^ documentUrl, 
	SupportedMimeType documentMimeType, 
	ResponseFormat serializationFormat
)

member annotateDocumentFromUrlAsStream : 
        documentUrl : Uri * 
        documentMimeType : SupportedMimeType * 
        serializationFormat : ResponseFormat -> Stream

Parameters

documentUrl: Type: SystemUri
the publicly accessible URL from where the document will be downloaded
documentMimeType: Type: Ontotext.S4.serviceSupportedMimeType
the MIME type of the document which will be annotated
serializationFormat: Type: Ontotext.S4.serviceResponseFormat
the serialization format of the output

Return Value

Type: Stream
an {@link InputStream} from where the serialized output can be read

Reference

S4ServiceClient Class

Ontotext.S4.service Namespace