PredefinedBimChangeMetadataQuery

Predefined queries to use with getChanges.

Index

Constructors

• constructor

Methods

• all
• blob
• dwg
• folder
• ifc
• layer
• layerAttachments
• pdf

Constructors

constructor

• new PredefinedBimChangeMetadataQuery(): PredefinedBimChangeMetadataQuery

• Returns PredefinedBimChangeMetadataQuery

Methods

publicstaticall

• all(): BimChangeMetadataQuery<BimChange>

• Gets all successfully processed folders.

  @example

  api.getChanges(projectA, PredefinedBimChangeMetadataQuery.folder())

  Query for use with getChanges.

  ---

  Returns BimChangeMetadataQuery<BimChange>

publicstaticblob

• blob<T>(extension: string, status?: BimChangeStatus): BimChangeMetadataQuery<T>

• Gets all blobs/files with a specific file extension and status

  @example

  api.getChanges(projectA, PredefinedBimChangeMetadataQuery.blob("docx"))

  @status

  Status of files to get.

  ---

  Type parameters

  • T: BimChange = BimChangeBlob

  Parameters

  • extension: string

    File extension

  • status: BimChangeStatus = BimChangeStatus.Processed

  Returns BimChangeMetadataQuery<T>

  Query for use with getChanges.

publicstaticdwg

• dwg(status?: BimChangeStatus): BimChangeMetadataQuery<BimChangeDwg>

• Gets all successfully processed DWG changes.

  @example

  api.getChanges(projectA, PredefinedBimChangeMetadataQuery.dwg())

  ---

  Parameters

  • status: BimChangeStatus = BimChangeStatus.Processed

    Status of DWG files to get. Query for use with getChanges.

  Returns BimChangeMetadataQuery<BimChangeDwg>

publicstaticfolder

• folder(): BimChangeMetadataQuery<BimFolder>

• Gets all successfully processed folders.

  @example

  api.getChanges(projectA, PredefinedBimChangeMetadataQuery.folder())

  Query for use with getChanges.

  ---

  Returns BimChangeMetadataQuery<BimFolder>

publicstaticifc

• ifc(status?: BimChangeStatus): BimChangeMetadataQuery<BimChangeIfc>

• Gets all successfully processed IFC changes.

  @example

  api.getChanges(projectA, PredefinedBimChangeMetadataQuery.ifc())

  ---

  Parameters

  • status: BimChangeStatus = BimChangeStatus.Processed

    Status of IFC files to get. Query for use with getChanges.

  Returns BimChangeMetadataQuery<BimChangeIfc>

publicstaticlayer

• layer(format: string): BimChangeMetadataQuery<BimChangeLayer>

• Gets all layers of a specific format

  @example

  api.getChanges(projectA, PredefinedBimChangeMetadataQuery.layer("sensors"))

  ---

  Parameters

  • format: string

    Type of layer to get. For example “sensors”

  Returns BimChangeMetadataQuery<BimChangeLayer>

  Query for use with getChanges.

publicstaticlayerAttachments

• layerAttachments<T>(format: string): BimChangeMetadataQuery<T>

• Retrieves the BimChangeMetadataQuery for layer attachments.

  @example

  // Get all layer attachments for sensor layers in projectA
  api.getChanges(projectA, PredefinedBimChangeMetadataQuery.layerAttachments({ format:"sensors" }));
  // Get all layer attachments for sensor layers in folderA
  api.getChanges(folderA, PredefinedBimChangeMetadataQuery.layerAttachments({ format:"sensors" }));

  ---

  Type parameters

  • T: BimChangeUploadable = BimChangeUploadable

  Parameters

  • format: string

  Returns BimChangeMetadataQuery<T>

  The BimChangeMetadataQuery object.

publicstaticpdf

• pdf(status?: BimChangeStatus): BimChangeMetadataQuery<BimChangeBlob>

• Gets all successfully processed PDF changes.

  @example

  api.getChanges(projectA, PredefinedBimChangeMetadataQuery.pdf())

  ---

  Parameters

  • status: BimChangeStatus = BimChangeStatus.Processed

    Status of PDF files to get. Query for use with getChanges.

  Returns BimChangeMetadataQuery<BimChangeBlob>