Type alias AddPdfComponentParams

AddPdfComponentParams: {
    cid: string;
    name: string;
    pathToFile: string;
    starred: boolean;
    subtype: ResearchObjectComponentDocumentSubtype;
}

Parameters for adding a PDF component to manifest. This is done after uploading the file, and allows adding richer metadata to the document.

Type declaration

  • cid: string

    CID of the file

  • name: string

    Human-readable name of the document

  • pathToFile: string

    Absolute path to the file in the drive

  • starred: boolean

    Wether to show the document as a central component of the object

  • subtype: ResearchObjectComponentDocumentSubtype

    Indicates the type of document

Settings

Member Visibility

Theme

Generated using TypeDoc