ContentElementResponse Element

System.Object
  ContentResponseType
    ContentElementResponse
    ContentErrorResponse
Client Declaration
  public class ContentElementResponse
Represents the streaming content data from a content element of a content-carrying object. The output of a GetContent operation returns a GetContentResponse element, which contains an array of concrete subtypes of the ContentResponseType element. Each ContentElementResponse element that is present in the array represents a successful response to a content data request in the ContentRequestType array contained within the GetContentRequest element of the operation's input.

Element Structure

Elements
  • ContentType[] Content: [response] Optional element specifying the streaming content data of a content element.
  • ElementSpecificationType ElementSpecification: [response] Required element specifying the content element from which the content data has been read.
  • ObjectReference SourceSpecification: [response] Required element specifying the content-carrying object to which the content element belongs.
Attributes
  • String continueFrom: [response] Optional expression representing the point reached in the specified content element returned by this response. This value can be included in a subsequent ContentRequestType request for the same content element in order to continue reading from that point.
  • String retrievalName: [response] Optional expression specifying the path and file name in which the content data has been stored. If this string contains non-Unicode characters, it will be H9-encoded (see StringEncodingType for more information).
  • UInt64 totalSize: [response] Optional expression specifying the size (in bytes) of the content data retrieved from the content element.
Attributes Specific to .NET Clients
  • Boolean totalSizeSpecified: Optional expression specifying whether totalSize has a value (true) or not (false)

Base Element Inheritance

Attributes
  • String id: [response] Optional expression specifying a unique correlation string, which is used to match a ContentRequestType request with a ContentResponseType response.

XML Schema

<xsd:complexType name="ContentElementResponse">
   <xsd:complexContent>
      <xsd:extension base="ContentResponseType">
         <xsd:sequence>
            <xsd:element name="SourceSpecification" type="ObjectReference"/>
            <xsd:element name="ElementSpecification" type="ElementSpecificationType"/>
            <xsd:element minOccurs="0" name="name="Content" type="ContentType"/>
         </xsd:sequence>
         <xsd:attribute name="continueFrom" type="xsd:string"/>
         <xsd:attribute name="retrievalName" type="xsd:string"/>
         <xsd:attribute name="totalSize" type="xsd:unsignedLong"/>
      </xsd:extension>
   </xsd:complexContent>
</xsd:complexType>