Class Fs

API Namespace Fs is used for BIM.works FileSystem related API calls.

A note about "paths" in BIM.works: Paths are relative to your credentials. For example an API Token that has been created on "/My Organization/Sub Folder" will resolve "/" to "/My Organization/Sub Folder"

Constructors

constructor

Methods

createNode createNodeIfNotExists deleteNode deleteNodeError deleteNodeIfExists deleteNodeVersion getNodeByPath getNodeByUuid getNodeByVersionUuid getNodeVersion getNodeVersions getRootNode getRootNodeUuid listNodeErrors listNodeVersions listNodes listNodesByPath listNodesRecursive nodeExists undeleteNode

Constructors

constructor

  • new Fs(): Fs

  • Returns Fs

Methods

createNode

  • createNode(parentNodeUuid, name, isFolder, inputFileType): Promise<string>

  • Create a new Node

    Parameters

    • parentNodeUuid: string

      The Nid of the parent Node under which to create the new Node

    • name: string

      The name of the new Node

    • isFolder: boolean

      Whether this new Node should be a folder or not

    • inputFileType: InputFileType

      The type of files that will be stored in this Node, for a folder node use FOLDER

    Returns Promise<string>

    The Nid of the newly created Node

createNodeIfNotExists

  • createNodeIfNotExists(parentNodeUuid, name, isFolder, inputFileType): Promise<string>

  • Create a new Node, but only if it did not already exist

    Parameters

    • parentNodeUuid: string

      The Nid of the parent Node under which to create the new Node

    • name: string

      The name of the new Node

    • isFolder: boolean

      Whether this new Node should be a folder or not

    • inputFileType: InputFileType

      The type of files that will be stored in this Node, for a folder node use FOLDER

    Returns Promise<string>

    The Nid of the newly created Node, of if the Node already existed the Nid of the existing Node

deleteNode

  • deleteNode(nodeUuid): Promise<unknown>

  • Delete a Node by it's Nid. Will throw an exception if the Node does not exist or was already deleted.

    Parameters

    • nodeUuid: string

    Returns Promise<unknown>

deleteNodeError

  • deleteNodeError(nodeUuid, errorUuid): Promise<unknown>

  • Delete a NodeError by it's id

    Parameters

    • nodeUuid: string
    • errorUuid: string

    Returns Promise<unknown>

deleteNodeIfExists

  • deleteNodeIfExists(nodeUuid): Promise<void>

  • Will delete the designated Node if is has not already been deleted. Will not throw an exception when there is no such Node.

    Parameters

    • nodeUuid: string

    Returns Promise<void>

deleteNodeVersion

  • deleteNodeVersion(nodeUuid, versionUuid): Promise<unknown>

  • Delete a Version. In a future version, the requirement to specify the nodeUuid in this method will be dropped

    Parameters

    • nodeUuid: string
    • versionUuid: string

    Returns Promise<unknown>

getNodeByPath

getNodeByUuid

getNodeByVersionUuid

  • getNodeByVersionUuid(versionUuid): Promise<Node>

  • Get a Node by a given Vid. This can be useful if you want to quickly go from a known Vid o Node without first resolving the Version object.

    Parameters

    • versionUuid: string

    Returns Promise<Node>

getNodeVersion

getNodeVersions

getRootNode

getRootNodeUuid

  • getRootNodeUuid(): Promise<string>

  • Get the Nid of the root Node of the current authorization context

    Returns Promise<string>

listNodeErrors

  • listNodeErrors(nodeUuid): Promise<unknown>

  • List all the known Error on the given Node

    Parameters

    • nodeUuid: string

    Returns Promise<unknown>

listNodeVersions

  • listNodeVersions(nodeUuid): Promise<unknown>

  • List all the known Version on the given Node

    Parameters

    • nodeUuid: string

    Returns Promise<unknown>

listNodes

  • listNodes(uuid): Promise<{
        nodes: Node[];
    }>

  • List all the direct child Nodes of the given Nid.

    Parameters

    • uuid: string

    Returns Promise<{
        nodes: Node[];
    }>

listNodesByPath

  • listNodesByPath(path): Promise<{
        nodes: Node[];
    }>

  • List all the child nodes of the Node on the given path

    Parameters

    • path: string

    Returns Promise<{
        nodes: Node[];
    }>

listNodesRecursive

  • listNodesRecursive(nodeUuid): Promise<{
        nodes: Node[];
    }>

  • Recursively list all the child Nodes of the given Nid. The Promise will resolve to a flat array of all the nodes.

    Parameters

    • nodeUuid: string

    Returns Promise<{
        nodes: Node[];
    }>

nodeExists

  • nodeExists(path): Promise<unknown>

  • Parameters

    • path: string

    Returns Promise<unknown>

    Whether a Node already exists on the given path

undeleteNode

  • undeleteNode(nodeUuid): Promise<void>

  • Undelete a given Node.

    Parameters

    • nodeUuid: string

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorcreateNodecreateNodeIfNotExistsdeleteNodedeleteNodeErrordeleteNodeIfExistsdeleteNodeVersiongetNodeByPathgetNodeByUuidgetNodeByVersionUuidgetNodeVersiongetNodeVersionsgetRootNodegetRootNodeUuidlistNodeErrorslistNodeVersionslistNodeslistNodesByPathlistNodesRecursivenodeExistsundeleteNode