UploadApiClient

API for uploading content.

Index

Methods

• canAppendFileVersion
• canCreateFileIn
• canCreateFileInFolder
• createFileSession

Methods

canAppendFileVersion

• canAppendFileVersion(__namedParameters: DeepImmutableObject<BimChangeIfc> | DeepImmutableObject<BimChangeBlob> | DeepImmutableObject<BimChangeDwg>): boolean

• Checks if it is possible to append a version to a existing change.

  ---

  Parameters

  • __namedParameters: DeepImmutableObject<BimChangeIfc> | DeepImmutableObject<BimChangeBlob> | DeepImmutableObject<BimChangeDwg>

  Returns boolean

  true if it is possible to upload content and thereby appending a new version (previous version must exist.)

canCreateFileIn

• canCreateFileIn(permission: DeepImmutableObject<BimFolder> | DeepImmutableObject<BimChangeLayer>): boolean

• Check if it is possible to create a new change (file) in a folder or a file.

  ---

  Parameters

  • permission: DeepImmutableObject<BimFolder> | DeepImmutableObject<BimChangeLayer>

    Folder permissions

  Returns boolean

  true if it is possible to upload content into the folder and create a new file (no previous version may exist.)

canCreateFileInFolder

• canCreateFileInFolder(permission: DeepImmutableObject<BimFolder>): boolean

• Check if it is possible to create a new change (file) in a folder.

  @deprecated

  Use canCreateFileIn instead.

  ---

  Parameters

  • permission: DeepImmutableObject<BimFolder>

    Folder permissions

  Returns boolean

  true if it is possible to upload content into the folder and create a new file (no previous version may exist.)

createFileSession

• createFileSession<Change>(operation: UploadApiClientContentOperation<Change>, o?: DeepImmutableObject<UploadApiClientContentOptions>): Promise<UploadApiClientFailure | UploadApiTask<Change>>

• Creates an upload session (represented by an UploadApiTask)

  ---

  Type parameters

  • Change: BimChangeUploadable

  Parameters

  • operation: UploadApiClientContentOperation<Change>

    Defines whehter the upload should create a new change in a folder (previous change may not exist) or if we want to append a version to a existing change

  • optionalo: DeepImmutableObject<UploadApiClientContentOptions>

    Options.

  Returns Promise<UploadApiClientFailure | UploadApiTask<Change>>

  A promise of either UploadTask, representing the content that is to be uploaded, or UploadApiClientFailure representing a error that occured.