Table of Contents

Class FolderExtensions

Namespace
RevitServerNet.Extensions
Assembly
RevitServerNet.dll
public static class FolderExtensions

Inheritance

Inherited Members

Methods

CreateFolderAsync(RevitServerApi, string, string)

public static Task<OperationResult> CreateFolderAsync(this RevitServerApi api, string parentFolderPath, string folderName)

Parameters

api RevitServerApi
parentFolderPath string
folderName string

Returns

Task<OperationResult>

CreateLocalModelWithoutToolAsync(RevitServerApi, string, string, string, string, bool)

public static Task<string> CreateLocalModelWithoutToolAsync(this RevitServerApi api, string modelPipePath, string destinationFile, string revitVersion = null, string assembliesPath = null, bool overwrite = false)

Parameters

api RevitServerApi
modelPipePath string
destinationFile string
revitVersion string
assembliesPath string
overwrite bool

Returns

Task<string>

CreateLocalModelWithoutToolAsync(RevitServerApi, string, string, bool, string, string, bool, IProgress<long>, CancellationToken)

public static Task<string> CreateLocalModelWithoutToolAsync(this RevitServerApi api, string modelPipePath, string destinationFile, bool createLocal, string revitVersion = null, string assembliesPath = null, bool overwrite = false, IProgress<long> bytesProgress = null, CancellationToken cancellationToken = default)

Parameters

api RevitServerApi
modelPipePath string
destinationFile string
createLocal bool
revitVersion string
assembliesPath string
overwrite bool
bytesProgress IProgress<long>
cancellationToken CancellationToken

Returns

Task<string>

DeleteFolderAsync(RevitServerApi, string)

public static Task<OperationResult> DeleteFolderAsync(this RevitServerApi api, string folderPath)

Parameters

api RevitServerApi
folderPath string

Returns

Task<OperationResult>

FolderExistsAsync(RevitServerApi, string)

public static Task<bool> FolderExistsAsync(this RevitServerApi api, string folderPath)

Parameters

api RevitServerApi
folderPath string

Returns

Task<bool>

GetAllFoldersRecursiveAsync(RevitServerApi, string)

public static Task<List<FolderInfo>> GetAllFoldersRecursiveAsync(this RevitServerApi api, string folderPath = "|")

Parameters

api RevitServerApi
folderPath string

Returns

Task<List<FolderInfo>>

GetAllModelsRecursiveAsync(RevitServerApi, string)

public static Task<List<ModelInfo>> GetAllModelsRecursiveAsync(this RevitServerApi api, string folderPath = "|")

Parameters

api RevitServerApi
folderPath string

Returns

Task<List<ModelInfo>>

GetFolderContentsAsync(RevitServerApi, string)

public static Task<FolderContents> GetFolderContentsAsync(this RevitServerApi api, string folderPath)

Parameters

api RevitServerApi
folderPath string

Returns

Task<FolderContents>

GetFolderInfoAsync(RevitServerApi, string)

public static Task<FolderInfo> GetFolderInfoAsync(this RevitServerApi api, string folderPath)

Parameters

api RevitServerApi
folderPath string

Returns

Task<FolderInfo>

GetFolderSizeAsync(RevitServerApi, string)

public static Task<long> GetFolderSizeAsync(this RevitServerApi api, string folderPath)

Parameters

api RevitServerApi
folderPath string

Returns

Task<long>

GetModelInfoAsync(RevitServerApi, string)

public static Task<ModelInfo> GetModelInfoAsync(this RevitServerApi api, string modelPath)

Parameters

api RevitServerApi
modelPath string

Returns

Task<ModelInfo>

GetRootFolderContentsAsync(RevitServerApi)

public static Task<FolderContents> GetRootFolderContentsAsync(this RevitServerApi api)

Parameters

api RevitServerApi

Returns

Task<FolderContents>

ListFilesAsync(RevitServerApi, string)

public static Task<List<RevitFileInfo>> ListFilesAsync(this RevitServerApi api, string folderPath = "|")

Parameters

api RevitServerApi
folderPath string

Returns

Task<List<RevitFileInfo>>

ListFoldersAsync(RevitServerApi, string)

public static Task<List<FolderInfo>> ListFoldersAsync(this RevitServerApi api, string folderPath = "|")

Parameters

api RevitServerApi
folderPath string

Returns

Task<List<FolderInfo>>

ListModelsAsync(RevitServerApi, string)

public static Task<List<ModelInfo>> ListModelsAsync(this RevitServerApi api, string folderPath = "|")

Parameters

api RevitServerApi
folderPath string

Returns

Task<List<ModelInfo>>

ModelExistsAsync(RevitServerApi, string)

public static Task<bool> ModelExistsAsync(this RevitServerApi api, string modelPath)

Parameters

api RevitServerApi
modelPath string

Returns

Task<bool>

RenameFolderAsync(RevitServerApi, string, string)

public static Task<OperationResult> RenameFolderAsync(this RevitServerApi api, string folderPath, string newName)

Parameters

api RevitServerApi
folderPath string
newName string

Returns

Task<OperationResult>

WalkAsync(RevitServerApi, string, bool, bool, bool)

public static Task<WalkResult> WalkAsync(this RevitServerApi api, string topPath = "|", bool includeFiles = true, bool includeModels = true, bool digModels = false)

Parameters

api RevitServerApi
topPath string
includeFiles bool
includeModels bool
digModels bool

Returns

Task<WalkResult>