 |
FormIt C++ API v25.0.0 (2025.0.0)
|
|
FormIt C++ API v25.0.0 (2025.0.0)
|
Namespaces | |
| namespace | UI |
Classes | |
| struct | ElementInfo |
| Base class that represents a BIM360 element. More... | |
| struct | ExtensionInfo |
| This class is used to store specific extension information in FileInfo. More... | |
| struct | FileData |
| Compact representation of a file in BIM360 along with data. More... | |
| struct | FileInfo |
| Represents a file in BIM360 The file element has a containing folder and version. More... | |
| struct | FolderContents |
| Compact representation of BIM360 folder contents. More... | |
| struct | FolderInfo |
| Represents a folder in BIM360. More... | |
| struct | HubInfo |
| Represents a Hub on BIM360 Contains a list of projects represented as ProjectInfo structs. More... | |
| struct | PermissionsInfo |
| Represents BIM360 Permissions for an ElementInfo. More... | |
| struct | ProjectInfo |
| Represents a project on BIM360 The rootFolderId is the entry point for ListContents API to navigate the project. More... | |
| struct | RevitFamilyInfo |
| Holds Revit family information obtained from derivative service. More... | |
Functions | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | SetForgeMode (Forge::ForgeMode mode, 1::string path) |
| instantiate forge mode for testing | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | CheckEntitlements (const 1::string &token) |
| CheckEntitlements() function. | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | InitHttpClient (const FormIt::StringType &uri) |
| Initializes an http client to be used on Forge calls. | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | GetHubsWithProjects (const 1::string &token, 1::vector< HubInfo > &hubs) |
| Obtains the hubs for the logged in account in BIM360. | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | GetContentPermissions (const 1::string &token, const Forge::ProjectInfo &project, FolderContents &content) |
| Obtains BIM 360 permissions of files and folders inside a folder content from a BIM 360 project. | |
| FORMIT_CORE_EXPORT Forge::ErrorCode | GetTopFolders (const 1::string &token, const Forge::HubInfo &hub, const Forge::ProjectInfo &project, Forge::FolderContents &topContent) |
| Obtains the top folders of a BIM 360 project (top folders refers to the content of project root folder) | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | ListContents (const 1::string &token, const ProjectInfo &project, const 1::string &folderId, FolderContents &contents) |
| List the contents of a given folder in BIM360. | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | DownloadFile (const 1::string &token, const FileInfo &fileInfo, 1::vector< unsigned char > &data) |
| Downloads a file from BIM360. | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | UpdateRemoteFile (const 1::string &token, const FileData &fileData, const 1::string &projectId, FileInfo &fileInfo) |
| Updates an existing file in BIM360. | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | CreateRemoteFile (const 1::string &token, const 1::string fileName, const 1::vector< unsigned char > &data, const 1::string &destinationFolder, const 1::string &projectId, FormIt::Forge::FileInfo &fileInfo) |
| Creates a new file in BIM360 within a specified folder. | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | GetThumbNail (const 1::string &token, const FormIt::Forge::FileInfo &file, 1::vector< unsigned char > &data) |
| Returns the thumbnail image for the given file. | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | CreateThumbNailDerivative (const 1::string &token, const FormIt::Forge::FileInfo &file) |
| Create the thumbnail via the derivate service. | |
| FORMIT_CORE_EXPORT FormIt::Forge::ErrorCode | GetRevitFamilyInfo (const 1::string &token, FormIt::Forge::FileInfo &file) |
| Get Revit information via the derivative service First ensures that file exist in Derivative Service calling CreateThumbNailDerivative in order to request Revit Family info of file. | |
| FORMIT_CORE_EXPORT ::string | GetSerialNumber (1::string &token) |
| Get the Pelican Entitlement serial number. | |
| enum | ForgeMode { Default = 0 , Test = 1 , Journal = 2 } |
| enum | ErrorCode { Success = 0 , Forbidden = 1 , Unauthorized = 2 , BadInput = 3 , ElementNotFound = 4 , AlreadyExists = 5 , MalformedResponse = 6 , InternalError = 7 , ConnectionError = 8 , ProjectNotFound = 9 , Pending = 10 , ReceiveHubProjectFailed = 11 , ReceiveFileListFailed = 12 , ReceiveEmptyFileList = 13 , OpenFileFailed = 14 , NoBIM360DocsEntitlements = 15 , SavingInProgress = 16 , ExportingInProgress = 17 , FileSaveSuccess = 18 , FileExportSuccess = 19 , FileSaveFailed = 20 , FileExportFailed = 21 , GetOAuthBearerTokenFailed = 22 , UnknownBIM360DocsException = 23 , CacheRefreshNeeded = 24 , FileUpdateDenied = 25 , ReceiveEmptyFileListContentLibrary = 26 , NoPermissionsToShowContent = 27 , NoPermissionsAndEmptyFileList = 28 , NoPermissionsAndEmptyFileListContentLibrary = 29 } |
| using | ExtensionInfoPtr = 1::shared_ptr< ExtensionInfo > |
| using FormIt::Forge::ExtensionInfoPtr = typedef 1::shared_ptr<ExtensionInfo> |
| Enumerator | |
|---|---|
| Success | Forge Client Error Codes. |
| Forbidden | |
| Unauthorized | |
| BadInput | |
| ElementNotFound | |
| AlreadyExists | |
| MalformedResponse | |
| InternalError | |
| ConnectionError | |
| ProjectNotFound | |
| Pending | |
| ReceiveHubProjectFailed | UI Error Codes. |
| ReceiveFileListFailed | |
| ReceiveEmptyFileList | |
| OpenFileFailed | |
| NoBIM360DocsEntitlements | |
| SavingInProgress | |
| ExportingInProgress | |
| FileSaveSuccess | |
| FileExportSuccess | |
| FileSaveFailed | |
| FileExportFailed | |
| GetOAuthBearerTokenFailed | |
| UnknownBIM360DocsException | |
| CacheRefreshNeeded | |
| FileUpdateDenied | |
| ReceiveEmptyFileListContentLibrary | |
| NoPermissionsToShowContent | |
| NoPermissionsAndEmptyFileList | |
| NoPermissionsAndEmptyFileListContentLibrary | |
1.9.8