Class Document

File class

Abstract

Hierarchy

Constructors

constructor

Properties

comment documentGu file

Methods

get processAnonymousRequest

Constructors

constructor

Properties

Readonly comment

comment: string

Readonly documentGu

documentGu: string

Readonly file

file: {
    date: Date;
    name: string;
    type: string;
}

Type declaration

  • date: Date
  • name: string
  • type: string

Methods

get

  • Retrieve the file from synergy servers. After retrieving the xmlObject, this method calls parseXMLObject which must be defined to parse the xmlObject into a readable, typesafe object.

    Returns

    Returns a base64 object

    Description

    const base64 = await document.get(); // { attribute: { nested: {...} }, base64: "base64 code" }

    Returns Promise<DocumentFile[]>

Static processAnonymousRequest

  • Type Parameters

    • T extends undefined | object

    Parameters

    • url: string
    • options: Partial<RequestOptions> = {}
    • preparse: ((xml: string) => string) = ...
        • (xml: string): string

        • Parameters

          • xml: string

          Returns string

    Returns Promise<T>

Settings

Member Visibility

Theme

Generated using TypeDoc