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"

Hierarchy

  • Fs

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

  • Returns Fs

Methods

createNode

  • Create a new Node

    Returns

    The Nid of the newly created 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

    Returns Promise<string>

createNodeIfNotExists

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

    Returns

    The Nid of the newly created Node, of if the Node already existed the Nid of the existing 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

    Returns Promise<string>

deleteNode

  • 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

  • Delete a NodeError by it's id

    Parameters

    • nodeUuid: string
    • errorUuid: string

    Returns Promise<unknown>

deleteNodeIfExists

  • 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

  • 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

  • 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

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

    Returns Promise<string>

listNodeErrors

  • List all the known Error on the given Node

    Parameters

    • nodeUuid: string

    Returns Promise<unknown>

listNodeVersions

  • List all the known Version on the given Node

    Parameters

    • nodeUuid: string

    Returns Promise<unknown>

listNodes

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

    Parameters

    • uuid: string

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

listNodesByPath

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

    Parameters

    • path: string

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

listNodesRecursive

  • 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

  • Returns

    Whether a Node already exists on the given path

    Parameters

    • path: string

    Returns Promise<unknown>

undeleteNode

  • Undelete a given Node.

    Parameters

    • nodeUuid: string

    Returns Promise<void>

Settings

Member Visibility

Theme

Generated using TypeDoc