Show / Hide Table of Contents

    Class InputDocument

    Inheritance
    System.Object
    InputDocument
    Implements
    IChunkable
    Namespace: DocuWare.Platform.ServerClient
    Assembly: DocuWare.Platform.ServerClient.dll
    Syntax
    public class InputDocument : IRelationsWithProxy, IChunkable, IStringContent

    Properties

    Fields

    Fields of a document

    Declaration
    public List<DocumentIndexField> Fields { get; set; }
    Property Value
    Type Description
    List<DocumentIndexField>

    FileChunk

    Contains data for a file chunk during a big file upload. This data is created on the server of every chunk request.

    Declaration
    public UploadedFileChunk FileChunk { get; set; }
    Property Value
    Type Description
    UploadedFileChunk

    Flags

    Flags of a document

    Declaration
    public InputFlags Flags { get; set; }
    Property Value
    Type Description
    InputFlags

    Links

    Declaration
    public Link[] Links { get; set; }
    Property Value
    Type Description
    Link[]

    Sections

    Sections of the document. Contains no sections if the document is DBRecord

    Declaration
    public List<InputSection> Sections { get; set; }
    Property Value
    Type Description
    List<InputSection>

    SelfRelationLink

    Gets the Uri of the link for the relation “self”.

    Declaration
    public string SelfRelationLink { get; }
    Property Value
    Type Description
    System.String
    Remarks

    Returns the uri of the link for the relation “self” if it exists, or null if this link does not exist. The returned link can be absolute or relative. If it is a relative link you must set it in the right context yourself.

    Methods

    GetDocumentFromSelfRelation()

    Calls the HTTP Get method on the link for the relation “self”.

    Declaration
    public Document GetDocumentFromSelfRelation()
    Returns
    Type Description
    Document

    The content of the response.

    GetDocumentFromSelfRelationAsync()

    Calls the HTTP Get method on the link for the relation “self” asynchronously.

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromSelfRelationAsync()
    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<Document>>

    A task which runs the request.

    Remarks

    This method follows the link for the relation “self”.

    GetDocumentFromSelfRelationAsync(System.Threading.CancellationToken)

    Calls the HTTP Get method on the link for the relation “self” asynchronously.

    Declaration
    public System.Threading.Tasks.Task<DeserializedHttpResponse<Document>> GetDocumentFromSelfRelationAsync(System.Threading.CancellationToken cancellationToken)
    Parameters
    Type Name Description
    System.Threading.CancellationToken cancellationToken

    The cancellation token to cancel the request.

    Returns
    Type Description
    System.Threading.Tasks.Task<DeserializedHttpResponse<Document>>

    A task which runs the request.

    Remarks

    This method follows the link for the relation “self”.

    SetProxy(HttpClientProxy)

    Sets the HTTP communication proxy which is used in further HTTP communication.

    Declaration
    public void SetProxy(HttpClientProxy proxy)
    Parameters
    Type Name Description
    HttpClientProxy proxy

    The instance which is used in further HTTP communication.

    Remarks

    The HTTP proxy is used to handle the HTTP requests which are created by this instance. The proxy is used in case a request is sent to a URL which is resolved from a link.

    Implements

    IChunkable
    In This Article
    • Properties
      • Fields
      • FileChunk
      • Flags
      • Links
      • Sections
      • SelfRelationLink
    • Methods
      • GetDocumentFromSelfRelation()
      • GetDocumentFromSelfRelationAsync()
      • GetDocumentFromSelfRelationAsync(System.Threading.CancellationToken)
      • SetProxy(HttpClientProxy)
    • Implements
    About Us Contact Imprint Terms Data privacy
    © 2024 DocuWare Corporation powered by DocFX Back to top