TrimbleCloud.FileService

APIBase
- JsonContentType
- JsonWrapperFormat
- _client
- _wrapperName
- GetRequestId(message)
- ThrowErrorAsync(response)
Acl
- AccessExpiresAt
- Actor
- Role
AclActor
- Actor
AclApplicationIdentity
- #ctor(applicationId)
- FormatEntity()
AclCustomIdentity
- #ctor(entityTrn)
- FormatEntity()
AclDeviceIdentity
- #ctor(deviceId)
- FormatEntity()
AclIdentity
- EntityId
- Equals(obj)
- FormatEntity()
- GetHashCode()
- Parse(entityTrn)
- ToString()
AclIdentityConverter
- CanConvertFrom()
- ConvertFrom()
AclRole
- ContentContributor
- ContentManager
- ContentViewer
- LimitedViewer
- SpaceManager
- SupportFileAdmin
- Unknown
AclUserIdentity
- #ctor(userId)
- FormatEntity()
BatchFolderCreate
- Folders
BatchFolderList
- InvalidItems
- Items
BatchMinimalFolderList
- InvalidItems
- Items
BatchResourceListResponse
- InvalidItems
- Items
Capabilities
- CanCheckIn
- CanCheckOut
- CanCreate
- CanDelete
- CanLock
- CanManageAccess
- CanRead
- CanUnlock
- CanUpdate
Checkout
- CheckedOutAt
- CheckedOutBy
- Reason
CopyFileRequest
- CopyAcl
- FileId
- Headers
- IncludeSupportFiles
- Name
- OverwriteExisting
- PermissionsLocal
- SpaceId
- TargetParentId
- Version
CopyFolderRequest
- CopyAcl
- FolderId
- Headers
- IncludeSupportFiles
- Name
- OverwriteExisting
- PermissionsLocal
- SpaceId
- TargetParentId
Download
- Url
DownloadUrlHelper
- RemoveWildcardFromDownloadUrl(url)
EnumConverter`1
- ReadJson()
EnumHelper`1
- GetEnumMemberValue()
Export
- CreatedAt
- CreatedBy
- ExportTrn
- Id
- Output
- ResourceId
- ResourceTrn
- SpaceId
- SpaceTrn
- Status
- UpdatedAt
- UpdatedBy
File
- Capabilities
- Checkout
- CreatedBy
- Deleted
- DeletedAt
- Download
- ExpiresAt
- FileSet
- LastMalwareScanDate
- Links
- Lock
- MD5
- MalwareScanResult
- MalwareScanStatus
- MalwareType
- Metadata
- Multipart
- ParentId
- ParentTrn
- ParentType
- Path
- PermissionsEvaluated
- PermissionsInherited
- PermissionsLocal
- ResourceTrn
- ResponseHeaders
- RestrictedAccess
- Size
- SpaceId
- SpaceTrn
- Statistics
- UpdatedBy
- Version
FileAcl
- AccessExpiresAt
- Actor
- Role
- Versions
FileInputUploadDetails
- AddToLinks
- ExpiresAt
- FileId
- FileSet
- FileTrn
- Metadata
- Multipart
- Name
- ParentId
- ParentMajorVersion
- ParentTrn
- ParentType
- Path
- PermissionsLocal
- ResponseHeaders
- RestrictedAccess
- SpaceId
- SpaceTrn
- Status
- SupportFileKey
- Upload
FileOrFolder
- CreatedAt
- CreatedBy
- Deleted
- DeletedAt
- Id
- Name
- ResourceTrn
- SpaceId
- SpaceTrn
- Type
- UpdatedAt
- UpdatedBy
- Version
FilePart
- ETag
- PartNumber
FilePermissionsLocal
- Acl
- FileAcl
- Inherits
FileServiceClient
- #ctor(httpClientProvider)
- #ctor(httpClientProvider,clientConfig)
- #ctor(httpClientProvider,httpMessageHandler)
- Exports
- Files
- Folders
- Jobs
- ObjectTypes
- Objects
- Resources
- Spaces
- _clientConfig
- _httpClientProvider
FileServiceClientConfig
- #ctor()
- HttpTimeout
- Retries
- RetryInterval
FileStatistics
- DecompressedSize
- SupportFilesCount
- SupportFilesSize
- SupportFilesUpdatedAt
FileStatus
- Unknown
- Uploadable
- Uploaded
FileUpdate
- ExpiresAt
- Links
- Metadata
- PermissionsLocal
FileUpdateAcl
- Add
- AddFileAcl
- Remove
FileUpdatePermissionsLocal
- Inherits
- ReplaceAcl
- ReplaceFileAcl
- UpdateAcl
FileUploadCreate
- ExpiresAt
- Fileset
- Metadata
- Multipart
- Name
- ParentId
- ParentType
- PermissionsLocal
- ResponseHeaders
- RestrictedAccess
FilesAPI
- GetDefaultUrlDuration()
Folder
- Capabilities
- Checkout
- CreatedBy
- Deleted
- DeletedAt
- Metadata
- ParentId
- ParentTrn
- Path
- PermissionsEvaluated
- PermissionsInherited
- PermissionsLocal
- ResourceTrn
- Size
- SpaceId
- SpaceTrn
- Statistics
- UpdatedBy
- Version
FolderCreate
- Metadata
- Name
- ParentId
- PermissionsLocal
FolderCreateChild
- Children
- Metadata
- Name
- PermissionsLocal
FolderCreateWithChildren
- Children
FolderListChildrenRequest
- FilterCriteria
- FolderId
- MaxItems
- NextPageToken
- Path
- Recursive
- SortBy
- SortOrder
- SpaceId
FolderListFilterCriteria
- ResourceType
- Status
- UrlDuration
FolderPermissionsLocal
- Acl
- Inherits
FolderStatistics
- ContentsUpdatedAt
- ImmediateFilesCount
- ImmediateFoldersCount
- SupportFilesSize
FolderUpdate
- Metadata
- PermissionsLocal
FolderUpdateAcl
- Add
- Remove
FolderUpdatePermissionsLocal
- Inherits
- ReplaceAcl
- UpdateAcl
GetJobQueryParams
- FastCheck
- LongPoll
GetObjectParams
- Status
- GetQueryParameters()
GetObjectVersionParams
- Status
- GetQueryParameters()
GetUploadDetailsQueryParams
- FastCheck
- LongPoll
- UrlDuration
HttpClientResponse
- #ctor(requestId,responseMessage)
- ContentLength
- IsError
- Metadata
- ReasonPhrase
- RequestId
- Status
- Dispose()
- Dispose(disposing)
- ToString()
IExportsAPI
- Create(spaceId,folderId,includeTopLevel)
- Get(spaceId,exportId,urlDuration)
IFileServiceClient
- Exports
- Files
- Folders
- Jobs
- ObjectTypes
- Objects
- Resources
- Spaces
IFilesAPI
- CheckInFile(spaceId,fileId)
- CheckInFileWithMinimalResponse(spaceId,fileId)
- CheckOutFile(spaceId,fileId,reason,headers)
- CheckOutFileWithMinimalResponse(spaceId,fileId,reason,headers)
- CompleteMultipartUpload(spaceId,uploadId,parts)
- Copy(spaceId,fileId,targetParentId,name,includeSupportFiles,overwriteExisting)
- Copy(copyFileRequest)
- CopyWithMinimalResponse(spaceId,fileId,targetParentId,name,includeSupportFiles,overwriteExisting)
- CopyWithMinimalResponse(copyFileRequest)
- CreateFileUpload(spaceId,file,urlDuration,includeLinks)
- CreateFileUpload(spaceId,file,headers,urlDuration,includeLinks)
- CreateOrUpdateLinks(spaceId,fileId,fileMajorVersion,links)
- CreateOrUpdateLinksWithMinimalResponse(spaceId,fileId,fileMajorVersion,links)
- CreatePackageUpload(spaceId,packageUpload,urlDuration)
- CreatePackageUpload(spaceId,packageUpload,headers,urlDuration)
- CreateSupportFileUpload(spaceId,supportFile,urlDuration)
- CreateSupportFileUpload(spaceId,supportFile,headers,urlDuration)
- Delete(spaceId,fileId,permanent)
- Delete(spaceId,fileId,headers,permanent)
- Download(spaceId,fileId,stream,chunkSize,maxConcurrentRequests)
- Download(spaceId,path,stream,chunkSize,maxConcurrentRequests)
- Download(spaceId,fileId,stream,urlDuration,transferConfiguration)
- Download(spaceId,path,stream,urlDuration,transferConfiguration)
- Get(spaceId,fileId,status,urlDuration,responseContentType)
- Get(spaceId,path,status,urlDuration,responseContentType)
- GetUploadDetails(spaceId,uploadId,urlDuration)
- GetUploadDetails(spaceId,uploadId,queryParams)
- GetVersion(spaceId,fileId,versionId,status,urlDuration,responseContentType)
- GetVersion(spaceId,path,versionId,status,urlDuration,responseContentType)
- GetVersionWithMinimalResponse(spaceId,fileId,versionId,status,urlDuration,responseContentType)
- GetVersionWithMinimalResponse(spaceId,path,versionId,status,urlDuration,responseContentType)
- GetWithMinimalResponse(spaceId,fileId,status,urlDuration,responseContentType)
- GetWithMinimalResponse(spaceId,path,status,urlDuration,responseContentType)
- ListManifestFiles(spaceId,fileId,nextPageToken,maxItems,urlDuration)
- ListSupportFiles(spaceId,fileId,nextPageToken,maxItems,listFilter)
- ListSupportFiles(spaceId,path,nextPageToken,maxItems,listFilter)
- ListSupportFilesWithMinimalResponse(spaceId,fileId,nextPageToken,maxItems,listFilter)
- ListSupportFilesWithMinimalResponse(spaceId,path,nextPageToken,maxItems,listFilter)
- ListVersions(spaceId,fileId,nextPageToken,maxItems,listFilter)
- ListVersions(spaceId,path,nextPageToken,maxItems,listFilter)
- ListVersionsWithMinimalResponse(spaceId,fileId,nextPageToken,maxItems,listFilter)
- ListVersionsWithMinimalResponse(spaceId,path,nextPageToken,maxItems,listFilter)
- Lock(spaceId,fileId,reason)
- Lock(spaceId,fileId,headers,reason)
- LockWithMinimalResponse(spaceId,fileId,reason)
- LockWithMinimalResponse(spaceId,fileId,headers,reason)
- Move(spaceId,fileId,targetParentId,name)
- Move(spaceId,fileId,targetParentId,headers,name)
- MoveWithMinimalResponse(spaceId,fileId,targetParentId,name)
- MoveWithMinimalResponse(spaceId,fileId,targetParentId,headers,name)
- PollForMalwareScanCompletion(spaceId,fileId,timeout,interval,callback)
- Rename(spaceId,fileId,name)
- Rename(spaceId,fileId,name,headers)
- RenameWithMinimalResponse(spaceId,fileId,name)
- RenameWithMinimalResponse(spaceId,fileId,name,headers)
- Restore(spaceId,fileId,name,targetParentId)
- Restore(spaceId,fileId,headers,name,targetParentId)
- RestoreWithMinimalResponse(spaceId,fileId,name,targetParentId)
- RestoreWithMinimalResponse(spaceId,fileId,headers,name,targetParentId)
- Unlock(spaceId,fileId)
- UnlockWithMinimalResponse(spaceId,fileId)
- Update(spaceId,fileId,file)
- Update(spaceId,fileId,file,headers)
- UpdateWithMinimalResponse(spaceId,fileId,file)
- UpdateWithMinimalResponse(spaceId,fileId,file,headers)
- Upload(request,chunkSize,maxConcurrentRequests)
- Upload(request,chunkSize,maxConcurrentRequests)
- Upload(uploadDetails,stream,transferConfiguration)
- Upload(uploadDetails,mainFileStream,supportFiles,transferConfiguration)
- WaitForUpload(spaceId,uploadId,timeout,interval,callback)
- WaitForUpload(spaceId,uploadId,urlDuration,timeout,interval,callback)
IFoldersAPI
- CheckInFolder(spaceId,folderId)
- CheckInFolderWithMinimalResponse(spaceId,folderId)
- CheckOutFolder(spaceId,folderId,reason,headers)
- CheckOutFolderWithMinimalResponse(spaceId,folderId,reason,headers)
- Copy(spaceId,folderId,targetParentId,name,includeSupportFiles,overwriteExisting)
- Copy(copyFolderRequest)
- CopyWithMinimalResponse(spaceId,folderId,targetParentId,name,includeSupportFiles,overwriteExisting)
- CopyWithMinimalResponse(copyFolderRequest)
- Create(spaceId,folder)
- CreateBatch(spaceId,folderRequest)
- CreateBatchWithMinimalResponse(spaceId,folderRequest)
- CreateWithMinimalResponse(spaceId,folder)
- Delete(spaceId,folderId,recursive,permanent)
- Delete(spaceId,folderId,headers,recursive,permanent)
- Get(spaceId,folderId,status)
- Get(spaceId,path,status)
- GetVersion(spaceId,folderId,versionId,status)
- GetVersion(spaceId,path,versionId,status)
- GetVersionWithMinimalResponse(spaceId,folderId,versionId,status)
- GetVersionWithMinimalResponse(spaceId,path,versionId,status)
- GetWithMinimalResponse(spaceId,folderId,status)
- GetWithMinimalResponse(spaceId,path,status)
- ListChildren(spaceId,folderId,nextPageToken,maxItems,listFilter,sortBy,sortOrder,recursive)
- ListChildren(spaceId,path,nextPageToken,maxItems,listFilter,sortBy,sortOrder,recursive)
- ListChildren(request)
- ListVersions(spaceId,folderId,nextPageToken,maxItems,status)
- ListVersions(spaceId,path,nextPageToken,maxItems,status)
- ListVersionsWithMinimalResponse(spaceId,folderId,nextPageToken,maxItems,status)
- ListVersionsWithMinimalResponse(spaceId,path,nextPageToken,maxItems,status)
- Move(spaceId,folderId,targetParentId,name)
- Move(spaceId,folderId,targetParentId,name,headers)
- MoveWithMinimalResponse(spaceId,folderId,targetParentId,name)
- MoveWithMinimalResponse(spaceId,folderId,targetParentId,name,headers)
- Rename(spaceId,folderId,name)
- Rename(spaceId,folderId,name,headers)
- RenameWithMinimalResponse(spaceId,folderId,name)
- RenameWithMinimalResponse(spaceId,folderId,name,headers)
- Restore(spaceId,folderId,name,targetParentId)
- Restore(spaceId,folderId,headers,name,targetParentId)
- RestoreWithMinimalResponse(spaceId,folderId,name,targetParentId)
- RestoreWithMinimalResponse(spaceId,folderId,headers,name,targetParentId)
- Update(spaceId,folderId,folder)
- Update(spaceId,folderId,folder,headers)
- UpdateWithMinimalResponse(spaceId,folderId,folder)
- UpdateWithMinimalResponse(spaceId,folderId,folder,headers)
IJobsAPI
- Get(id)
- Get(jobId,queryParams)
- WaitForJob(id,timeout,interval,callback)
IObjectTypesAPI
- Create(request)
- Get(objectTypeId)
IObjectsAPI
- Checkin(spaceId,objectId)
- Checkin(spaceId,objectId,headers)
- CheckinWithMinimalResponse(spaceId,objectId)
- CheckinWithMinimalResponse(spaceId,objectId,headers)
- Checkout(spaceId,objectId,reason)
- Checkout(spaceId,objectId,reason,headers)
- CheckoutWithMinimalResponse(spaceId,objectId,reason)
- CheckoutWithMinimalResponse(spaceId,objectId,reason,headers)
- Create(spaceId,request)
- CreateWithMinimalResponse(spaceId,request)
- Delete(spaceId,objectId,permanent)
- Delete(spaceId,objectId,permanent,headers)
- Get(spaceId,objectId)
- Get(spaceId,objectId,parameters)
- Get(spaceId,objectPath)
- Get(spaceId,objectPath,parameters)
- GetVersion(spaceId,objectId,versionId)
- GetVersion(spaceId,objectId,versionId,parameters)
- GetVersion(spaceId,objectPath,versionId)
- GetVersion(spaceId,objectPath,versionId,parameters)
- GetWithMinimalResponse(spaceId,objectId)
- GetWithMinimalResponse(spaceId,objectId,parameters)
- GetWithMinimalResponse(spaceId,objectPath)
- GetWithMinimalResponse(spaceId,objectPath,parameters)
- LinkSupportFiles(spaceId,objectId,request)
- LinkSupportFilesWithMinimalResponse(spaceId,objectId,request)
- ListResources(spaceId,objectId)
- ListResources(spaceId,objectId,parameters)
- ListResources(spaceId,objectPath)
- ListResources(spaceId,objectPath,parameters)
- ListResourcesWithMinimalResponse(spaceId,objectId)
- ListResourcesWithMinimalResponse(spaceId,objectId,parameters)
- ListResourcesWithMinimalResponse(spaceId,objectPath)
- ListResourcesWithMinimalResponse(spaceId,objectPath,parameters)
- ListVersions(spaceId,objectId)
- ListVersions(spaceId,objectId,parameters)
- ListVersions(spaceId,objectPath)
- ListVersions(spaceId,objectPath,parameters)
- ListVersionsWithMinimalResponse(spaceId,objectId)
- ListVersionsWithMinimalResponse(spaceId,objectId,parameters)
- ListVersionsWithMinimalResponse(spaceId,objectPath)
- ListVersionsWithMinimalResponse(spaceId,objectPath,parameters)
- Move(spaceId,objectId,targetParentId,name)
- Move(spaceId,objectId,targetParentId,name,headers)
- MoveWithMinimalResponse(spaceId,objectId,targetParentId,name)
- MoveWithMinimalResponse(spaceId,objectId,targetParentId,name,headers)
- Rename(spaceId,objectId,name)
- Rename(spaceId,objectId,name,headers)
- RenameWithMinimalResponse(spaceId,objectId,name)
- RenameWithMinimalResponse(spaceId,objectId,name,headers)
- Restore(spaceId,objectId,targetParentId,name)
- Restore(spaceId,objectId,targetParentId,name,headers)
- RestoreWithMinimalResponse(spaceId,objectId,targetParentId,name)
- RestoreWithMinimalResponse(spaceId,objectId,targetParentId,name,headers)
- Update(spaceId,objectId,request)
- Update(spaceId,objectId,request,headers)
- UpdateWithMinimalResponse(spaceId,objectId,request)
- UpdateWithMinimalResponse(spaceId,objectId,request,headers)
IPage`1
- NextPageToken
IResourcesAPI
- BatchGet(spaceId,resourceIds,status,urlDuration,responseContentType)
- BatchGet(spaceId,resourcePaths,status,urlDuration,responseContentType)
- BatchGetWithMinimalResponse(spaceId,resourceIds,status,urlDuration,responseContentType)
- BatchGetWithMinimalResponse(spaceId,resourcePaths,status,urlDuration,responseContentType)
- Get(spaceId,resourceId,status,urlDuration,responseContentType)
- Get(spaceId,resourcePath,status,urlDuration,responseContentType)
- GetWithMinimalResponse(spaceId,resourceId,status,urlDuration,responseContentType)
- GetWithMinimalResponse(spaceId,resourcePath,status,urlDuration,responseContentType)
ISpacesAPI
- Create(space)
- CreateWithMinimalResponse(space)
- Delete(id,recursive,permanent)
- Get(id,status)
- GetWithMinimalResponse(id,status)
- ListChildren(spaceId,nextPageToken,maxItems,includeSupportFiles,listFilter,sortOrder)
- ListPublicResources(spaceId,nextPageToken,maxItems)
- Restore(id)
- RestoreWithMinimalResponse(id)
- Update(id,space)
- UpdateWithMinimalResponse(id,space)
InheritedAcl
- Actor
- InheritedFrom
- InheritedFromTrn
- Role
- Versions
InvalidFolderItem
- Code
- Detail
- Path
- Status
- Title
- Type
InvalidResourceItem
- Code
- Detail
- Id
- Status
- Title
- Type
Job
- CreatedAt
- CreatedBy
- Id
- Message
- ResourceTrn
- Status
- Type
JobStatus
- Completed
- Failed
- Queued
- Running
- Unknown
JobType
- Copy
- Delete
- Export
- FileDeletion
- FileRestore
- FolderDeletion
- Move
- Rename
- Restore
- Unknown
- Upload
JsonRawStringConverter
- ReadJson()
- WriteJson()
ListFilterBase
ListFilterCriteria
- Status
- UrlDuration
ListObjectResourcesParams
- NextPageToken
- PageSize
- Status
- UrlDuration
- GetQueryParameters()
ListObjectVersionsParams
- NextPageToken
- PageSize
- Status
- GetQueryParameters()
ListQueryStringFormatter`1
- ToQueryString()
Lock
- LockedAt
- LockedBy
- Reason
MalwareScanStatus
- CannotScan
- Clean
- Failed
- Infected
- QueuedForScan
- Scanning
- Unknown
- Unscanned
ManifestFile
- Download
- MD5
- Path
- Size
MinimalFile
- CreatedBy
- Deleted
- DeletedAt
- ResourceTrn
- SpaceId
- SpaceTrn
- UpdatedBy
- Version
MinimalFolder
- CreatedBy
- Deleted
- DeletedAt
- ResourceTrn
- SpaceId
- SpaceTrn
- UpdatedBy
- Version
MinimalObjectEntity
- CreatedBy
- Deleted
- ResourceTrn
- SpaceId
- SpaceTrn
- UpdatedBy
- Version
MinimalObjectJobResponse
- JobId
- Resource
MinimalSpace
- CreatedAt
- CreatedBy
- Deleted
- DeletedAt
- Id
- Name
- ResourceTrn
- RootId
- RootTrn
- Type
- UpdatedAt
- UpdatedBy
MinimalSpaceList
- CreatedAt
- CreatedBy
- Deleted
- DeletedAt
- Id
- Name
- ResourceTrn
- RootId
- RootTrn
- SpaceId
- SpaceTrn
- Type
- UpdatedAt
- UpdatedBy
- Version
ObjectAcl
- AccessExpiresAt
- Actor
- Role
- Versions
ObjectCheckin
- ObjectId
- SpaceId
ObjectCheckout
- ObjectId
- Reason
- SpaceId
ObjectCreate
- Content
- Metadata
- Name
- ObjectTypeId
- ParentId
- PermissionsLocal
- Size
ObjectDelete
- ObjectId
- Permanent
- SpaceId
ObjectEntity
- Actions
- Capabilities
- Checkout
- Content
- CreatedBy
- Deleted
- DeletedAt
- Links
- Metadata
- ObjectType
- ObjectTypeId
- ParentId
- ParentTrn
- ParentType
- Path
- PermissionsEvaluated
- PermissionsInherited
- PermissionsLocal
- ResourceTrn
- Size
- SpaceId
- SpaceTrn
- Statistics
- UpdatedBy
- Version
ObjectJobResponse
- InvalidResources
- JobId
- Resource
ObjectLink
- Links
ObjectMove
- Name
- ObjectId
- SpaceId
- TargetParentId
ObjectPermissionsLocal
- Acl
- Inherits
ObjectRename
- Name
- ObjectId
- SpaceId
ObjectRestore
- Name
- ObjectId
- SpaceId
- TargetParentId
ObjectStatistics
- SupportFilesCount
- SupportFilesSize
- SupportFilesUpdatedAt
ObjectSupportFileDetails
- Id
- Version
ObjectType
- Actions
- CreatedAt
- CreatedBy
- DisplayName
- Id
- Name
- Schema
- UpdatedAt
- UpdatedBy
ObjectTypeCreate
- Actions
- DisplayName
- Name
- Schema
ObjectUpdate
- Content
- Links
- Metadata
- PermissionsLocal
- Size
ObjectUpdateAcl
- Add
- Remove
ObjectUpdatePermissionsLocal
- Inherits
- ReplaceAcl
- UpdateAcl
ObjectUpdateSupportFileDetails
- Id
- Version
Output
- Url
PackageUploadCreate
- ExpiresAt
- Fileset
- Metadata
- Multipart
- Name
- ParentId
- ParentType
- PermissionsLocal
- ResponseHeaders
- RestrictedAccess
- SupportFileResources
PackageUploadRequest
- MainFileStream
- SpaceId
- SupportFiles
- UploadId
- Url
- UrlDuration
Page`1
- Items
- NextPageToken
- GetEnumerator()
- System#Collections#IEnumerable#GetEnumerator()
ParentType
- File
- Folder
- Object
- Unknown
PermissionsEvaluated
- Acl
PermissionsInherited
- Acl
Provider
- AWS
- Azure
- Unknown
ResourceBase
- CreatedAt
- Id
- Name
- Type
- UpdatedAt
ResourceConverter
- #ctor(complete)
- CanConvert()
- ReadJson()
- WriteJson()
ResourceListConverter
- #ctor(complete)
- CanConvert()
- ReadJson()
- WriteJson()
ResourceNotFoundException
- #ctor()
ResourceStatus
- Active
- All
- Deleted
- Unknown
ResourceType
- Export
- File
- Folder
- Job
- Object
- Space
- Unknown
- Upload
Response
- ContentLength
- IsError
- Metadata
- ReasonPhrase
- RequestId
- ResponseContent
- Status
- Dispose()
- Dispose(disposing)
- FromValue“1(value,response)
- ToString()
Response`1
- Data
- HasData
- GetResponse()
- op_Implicit(response)
Result
- Message
- Status
RetentionPeriod
- NeverDelete
- OneYear
- SixMonths
- ThirtyDays
- Unknown
Space
- AccountId
- AllowAnonymousShares
- Capabilities
- CreatedAt
- CreatedBy
- Deleted
- DeletedAt
- Id
- Name
- PermissionsEvaluated
- PermissionsLocal
- Provider
- ResourceTrn
- RootId
- RootTrn
- SoftDeleteRetention
- SpaceMembershipBoundary
- Statistics
- StorageMode
- StorageModeUpdatedAt
- StorageModeUpdatedBy
- Type
- UpdatedAt
- UpdatedBy
SpaceCreate
- AccountId
- AllowAnonymousShares
- Name
- PermissionsLocal
- Provider
- SoftDeleteRetention
- SpaceMembershipBoundary
SpaceListFilterCriteria
- ResourceType
- SinceTime
- Status
- UrlDuration
SpaceMembershipBoundary
- AllowLimitedViewerOutsideBoundaryGroup
- Group
SpacePermissionsLocal
- Acl
SpaceStatistics
- ContentsUpdatedAt
- DeletedFilesCount
- DeletedFoldersCount
- DeletedSize
- DeletedSupportFilesSize
- FilesCount
- FoldersCount
- Size
- SupportFilesSize
- TotalStorageUsed
SpaceUpdate
- AllowAnonymousShares
- Name
- PermissionsLocal
- SoftDeleteRetention
- SpaceMembershipBoundary
- StorageMode
SpaceUpdateAcl
- Add
- Remove
SpaceUpdatePermissionsLocal
- ReplaceAcl
- UpdateAcl
SupportFileDetails
- DownloadUrl
- Id
- ResourceTrn
- Version
SupportFileLink
- Id
- Version
SupportFileResource
- Metadata
- Name
- ResponseHeaders
- RestrictedAccess
- SupportFileKey
SupportFileResourceDetails
- FileId
- FileTrn
- MD5
- Metadata
- Name
- ResponseHeaders
- RestrictedAccess
- Size
- Status
- SupportFileKey
- Upload
- Version
SupportFileResourceUploadItem
- SupportFileKey
- SupportFileStream
SupportFileUploadCreate
- AddToLinks
- ExpiresAt
- Metadata
- Multipart
- Name
- ParentId
- ParentMajorVersion
- ParentType
- ResponseHeaders
- RestrictedAccess
- SupportFileKey
TransferFileConfiguration
- ChunkSize
- MaxConcurrentRequests
TrimbleServiceException
- #ctor(message,response)
- #ctor()
- #ctor(message,response,innerException)
- #ctor(info,context)
- _response
- RequestId
- StatusCode
- GetObjectData()
- GetRawResponse()
- ToString()
Upload
- Type
- Url
UploadDetails
- CreatedAt
- CreatedBy
- FileInputUploadDetails
- Id
- MD5
- ResourceTrn
- Result
- Size
- SupportFileResources
- UpdatedAt
- UpdatedBy
- Version
UploadRequest
- SpaceId
- Stream
- UploadId
- Url
- UrlDuration
UploadStatus
- Completed
- Failed
- Running
- Unknown
- Uploadable
UploadType
- Multipart
- Singlepart
- Unknown
Utility
- ConvertUrlDuration(urlDuration)
- ExtractExportId(input)
- ExtractJobId(input)
- GetRetryPolicy(config)
- ToQueryString(parameters)

APIBase `type`

Namespace

Returns

The request ID if present, otherwise an empty string

Parameters

Name	Type	Description
message	System.Net.Http.HttpResponseMessage	The HTTP response message

ThrowErrorAsync(response) `method`

Summary

Throws a TrimbleServiceException for HTTP error responses

Parameters

Name	Type	Description
response	System.Net.Http.HttpResponseMessage	The HTTP response message

Exceptions

Name	Description
TrimbleCloud.FileService.TrimbleServiceException	Always thrown with error details (includes ArgumentNullException as inner exception if response is null)

Acl `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents the actor role mapping for the resources.

AccessExpiresAt `property`

Summary

Time when the actor’s access to the resource expires.

Actor `property`

Summary

The TRN (Trimble Resource Name) of the actor (User/Device/Application).

Role `property`

Summary

The role assigned to the actor.

AclActor `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents an actor in the ACL (Access Control List).

Actor `property`

Summary

Represents an identity in the access control list (ACL).

EntityId `property`

Checkout `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents a checkout of a file in File Service.

CheckedOutAt `property`

Summary

The date and time when the file was checked out.

CheckedOutBy `property`

Summary

The actor who checked out the file.

Reason `property`

Summary

The reason for checking out the file.

CopyFileRequest `type`

Namespace

Namespace

TrimbleCloud.FileService.Models

Summary

Contains the download URL of a file.

Url `property`

Summary

The download URL of the file.

DownloadUrlHelper `type`

Namespace

TrimbleCloud.FileService.Utilities

Summary

Helpers for download URLs returned by the File Service API.

RemoveWildcardFromDownloadUrl(url) `method`

Summary

Removes a placeholder asterisk from a presigned download URL so HTTP range requests work (for example zip or fileset downloads).

Returns

The URL with the wildcard removed, or the original value if null, empty, or no asterisk is present.

Parameters

Name	Type	Description
url	System.String	The download URL from Download.

FilePart `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents a part that was uploaded.

ETag `property`

Summary

Entity tag for the part.

PartNumber `property`

Inherits `property`

Summary

Specifies if permissions are inherited from the parent folder.

FileServiceClient `type`

Namespace

TrimbleCloud.FileService

Summary

A client for the Trimble Cloud Platform File Service

#ctor(httpClientProvider) `constructor`

Summary

Public constructor for File Service client

Parameters

Name	Type	Description
httpClientProvider	Trimble.ID.IHttpClientProvider	A provider of a pre-configured HttpClient used for API calls made by this client

Exceptions

Name	Description
System.ArgumentNullException	Thrown when httpClientProvider is null

#ctor(httpClientProvider,clientConfig) `constructor`

Summary

Public constructor for File Service client

Parameters

Name	Type	Description
httpClientProvider	Trimble.ID.IHttpClientProvider	A provider of a pre-configured HttpClient used for API calls made by this client
clientConfig	TrimbleCloud.FileService.FileServiceClientConfig	The configuration values for the client

#ctor(httpClientProvider,httpMessageHandler) `constructor`

Summary

Public constructor for File Service client

Parameters

Name	Type	Description
httpClientProvider	Trimble.ID.IHttpClientProvider	A provider of a pre-configured HttpClient used for API calls made by this client
httpMessageHandler	System.Net.Http.HttpMessageHandler	The HttpMessageHandler to use the custom Http Message handler

Exceptions

Name	Description
System.ArgumentNullException	Thrown when httpClientProvider is null
System.ArgumentNullException	Thrown when httpMessageHandler is null

Retries `property`

Summary

The number of times to retry a request if it fails

RetryInterval `property`

Summary

The interval between retries

FileStatistics `type`

Namespace

Summary

The status of the File upload

Unknown `constants`

Summary

Unknown status

Uploadable `constants`

Summary

The file is uploadable

Uploaded `constants`

Summary

The file has been uploaded

FileUpdate `type`

Namespace

FolderCreate `type`

Namespace

Create parent folder request

Children `property`

Summary

List of nested child folders to create within this folder

FolderListChildrenRequest `type`

Namespace

FolderListFilterCriteria `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Criteria for filtering a list of files

ResourceType `property`

Summary

Gets or sets the type of the Resource to filter by.

Status `property`

Summary

Gets or sets the folder status.

UrlDuration `property`

Summary

Gets or sets the file URL duration.

FolderPermissionsLocal `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents the permissions explicitly assigned to a folder.

Acl `property`

Summary

The list of actors and their roles.

Inherits `property`

Summary

Specifies if permissions are inherited from the parent folder.

FolderStatistics `type`

Namespace

Summary

Represents a folder update request. Note: Both ReplaceAcl and UpdateAcl cannot be used in the same request.

Metadata `property`

Summary

Update the metadata for the folder.

PermissionsLocal `property`

ReplaceAcl `property`

Summary

Completely replace the existing permissions on the resource. When this field is used, all previous permissions are overwritten by the new ones.

UpdateAcl `property`

Summary

Add or remove roles to the existing permissions on the resource.

GetJobQueryParams `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Query parameters for retrieving job details in File Service.

FastCheck `property`

Summary

Optimize internal polling frequency. Effective only if longpoll is true

LongPoll `property`

Summary

Performs a long-polling request for the status

Performs a long-polling request for the status

UrlDuration `property`

Returns

String representation of the response

Parameters

This method has no parameters.

IExportsAPI `type`

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
uploadId	System.Guid	The upload ID
parts	System.Collections.Generic.IEnumerable{TrimbleCloud.FileService.Models.FilePart}	List of parts that are uploaded

Copy(spaceId,fileId,targetParentId,name,includeSupportFiles,overwriteExisting) `method`

Summary

Copy a file to a new location within the same space

Returns

A Task that resolves to the a Tuple of Response of File data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
targetParentId	System.Guid	The target parent ID
name	System.String	The new name of the copied file. If not specified, the file will be copied with its original name
includeSupportFiles	System.Boolean	Copy support files and links along with the files
overwriteExisting	System.Boolean	Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

Copy(copyFileRequest) `method`

Summary

Copy a file to a new location within the same space

Returns

Parameters

Name	Type	Description
copyFileRequest	TrimbleCloud.FileService.Models.CopyFileRequest

CopyWithMinimalResponse(spaceId,fileId,targetParentId,name,includeSupportFiles,overwriteExisting) `method`

Summary

Copy a file to a new location within the same space and get minimal response

Returns

A Task that resolves to the a Tuple of Response of MinimalFile data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
targetParentId	System.Guid	The target parent ID
name	System.String	The new name of the copied file. If not specified, the file will be copied with its original name
includeSupportFiles	System.Boolean	Copy support files and links along with the file
overwriteExisting	System.Boolean	Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

CopyWithMinimalResponse(copyFileRequest) `method`

Summary

Copy a file to a new location within the same space and get minimal response

Returns

Parameters

Name	Type	Description
copyFileRequest	TrimbleCloud.FileService.Models.CopyFileRequest

CreateFileUpload(spaceId,file,urlDuration,includeLinks) `method`

Summary

Create a file upload

Returns

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
file	TrimbleCloud.FileService.Models.FileUploadCreate	The information of the file to create
urlDuration	System.Nullable{System.TimeSpan}	The file upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
includeLinks	System.Boolean	Whether to include the links from the last version during a parent file’s major version change.

CreateFileUpload(spaceId,file,headers,urlDuration,includeLinks) `method`

Summary

Create a file upload with custom headers

Returns

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
file	TrimbleCloud.FileService.Models.FileUploadCreate	The information of the file to create
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
urlDuration	System.Nullable{System.TimeSpan}	The file upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
includeLinks	System.Boolean	Whether to include the links from the last version during a parent file’s major version change.

CreateOrUpdateLinks(spaceId,fileId,fileMajorVersion,links) `method`

Summary

Create or update support file links of a file

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
fileMajorVersion	System.Int32	The major version of the file
links	System.Collections.Generic.IDictionary{System.String,TrimbleCloud.FileService.Models.SupportFileLink}	The links to create or update as dictionary of key and SupportFileLink

CreateOrUpdateLinksWithMinimalResponse(spaceId,fileId,fileMajorVersion,links) `method`

Summary

Create or update support file links of a file and get minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
fileMajorVersion	System.Int32	The major version of the file
links	System.Collections.Generic.IDictionary{System.String,TrimbleCloud.FileService.Models.SupportFileLink}	The links to create or update as dictionary of key and SupportFileLink

CreatePackageUpload(spaceId,packageUpload,urlDuration) `method`

Summary

Create a package upload

Returns

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
packageUpload	TrimbleCloud.FileService.Models.PackageUploadCreate	The information of the package upload to create
urlDuration	System.Nullable{System.TimeSpan}	The package upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

CreatePackageUpload(spaceId,packageUpload,headers,urlDuration) `method`

Summary

Create a package upload with custom headers

Returns

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
packageUpload	TrimbleCloud.FileService.Models.PackageUploadCreate	The information of the package upload to create
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
urlDuration	System.Nullable{System.TimeSpan}	The package upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

CreateSupportFileUpload(spaceId,supportFile,urlDuration) `method`

Summary

Create a support file upload

Returns

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
supportFile	TrimbleCloud.FileService.Models.SupportFileUploadCreate	The information of the support file to create
urlDuration	System.Nullable{System.TimeSpan}	The support file’s upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

CreateSupportFileUpload(spaceId,supportFile,headers,urlDuration) `method`

Summary

Create a support file upload with custom headers

Returns

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
supportFile	TrimbleCloud.FileService.Models.SupportFileUploadCreate	The information of the support file to create
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
urlDuration	System.Nullable{System.TimeSpan}	The support file’s upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

Delete(spaceId,fileId,permanent) `method`

Summary

Delete a file

Returns

A Task that resolves to possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
permanent	System.Boolean	Permanently delete the file

Delete(spaceId,fileId,headers,permanent) `method`

Summary

Delete a file with custom headers

Returns

A Task that resolves to possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
permanent	System.Boolean	Permanently delete the file

Download(spaceId,fileId,stream,chunkSize,maxConcurrentRequests) `method`

Summary

Downloads a file given the file ID

Returns

A Task that resolves to completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
stream	System.IO.Stream	The stream to write content to
chunkSize	System.Int32	The size of the chunks in bytes if provided; otherwise `15MB` chunks are used
maxConcurrentRequests	System.Int32	The number of concurrent download tasks if provided; otherwise `8` tasks are used

Download(spaceId,path,stream,chunkSize,maxConcurrentRequests) `method`

Summary

Downloads a file given the file path

Returns

A Task that resolves to completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
stream	System.IO.Stream	The stream to write content to
chunkSize	System.Int32	The size of the chunks in bytes if provided; otherwise `15MB` chunks are used
maxConcurrentRequests	System.Int32	The number of concurrent download tasks if provided; otherwise `8` tasks are used

Download(spaceId,fileId,stream,urlDuration,transferConfiguration) `method`

Summary

Downloads a file given the file ID with custom URL duration

Returns

A Task that resolves to completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
stream	System.IO.Stream	The stream to write content to
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
transferConfiguration	TrimbleCloud.FileService.Models.TransferFileConfiguration	Chunk size and concurrency for the transfer.

Download(spaceId,path,stream,urlDuration,transferConfiguration) `method`

Summary

Downloads a file given the file path with custom URL duration

Returns

A Task that resolves to completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
stream	System.IO.Stream	The stream to write content to
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
transferConfiguration	TrimbleCloud.FileService.Models.TransferFileConfiguration	Chunk size and concurrency for the transfer.

Get(spaceId,fileId,status,urlDuration,responseContentType) `method`

Summary

Get a file given the file ID

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the file
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType	System.String	Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

Get(spaceId,path,status,urlDuration,responseContentType) `method`

Summary

Get a file given the file path

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the file
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType	System.String	Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetUploadDetails(spaceId,uploadId,urlDuration) `method`

Summary

Get details of the upload

Returns

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
uploadId	System.Guid	The upload ID
urlDuration	System.Nullable{System.TimeSpan}	The file upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes

GetUploadDetails(spaceId,uploadId,queryParams) `method`

Summary

Get details of the upload

Returns

Parameters

Name	Type	Description
spaceId	System.Guid
uploadId	System.Guid
queryParams	TrimbleCloud.FileService.Models.GetUploadDetailsQueryParams

GetVersion(spaceId,fileId,versionId,status,urlDuration,responseContentType) `method`

Summary

Get file version details given the file ID

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
versionId	System.String	The version ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the file
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType	System.String	Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetVersion(spaceId,path,versionId,status,urlDuration,responseContentType) `method`

Summary

Get file version details given the file path

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
versionId	System.String	The version ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the file
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType	System.String	Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetVersionWithMinimalResponse(spaceId,fileId,versionId,status,urlDuration,responseContentType) `method`

Summary

Get file version details given the file ID with minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
versionId	System.String	The version ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the file
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType	System.String	Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetVersionWithMinimalResponse(spaceId,path,versionId,status,urlDuration,responseContentType) `method`

Summary

Get file version details given the file path with minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
versionId	System.String	The version ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the file
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType	System.String	Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetWithMinimalResponse(spaceId,fileId,status,urlDuration,responseContentType) `method`

Summary

Get a file given the file ID with minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the file
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType	System.String	Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

GetWithMinimalResponse(spaceId,path,status,urlDuration,responseContentType) `method`

Summary

Get a file given the file path with minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the file
urlDuration	System.Nullable{System.TimeSpan}	The file download URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
responseContentType	System.String	Specify the content type of the response. It overrides the file settings for the response content type which is given when creating the file.

ListManifestFiles(spaceId,fileId,nextPageToken,maxItems,urlDuration) `method`

Summary

Lists all files from inside the unpacked fileset.

Returns

Parameters

Name	Type	Description
spaceId	System.Guid
fileId	System.Guid
nextPageToken	System.String
maxItems	System.Int32
urlDuration	System.Nullable{System.TimeSpan}

ListSupportFiles(spaceId,fileId,nextPageToken,maxItems,listFilter) `method`

Summary

List all support files for a file given the file ID

Returns

A Task that resolves to IPage`1 that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list

ListSupportFiles(spaceId,path,nextPageToken,maxItems,listFilter) `method`

Summary

List all support files for a file given the file path

Returns

A Task that resolves toIPage`1 that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list

ListSupportFilesWithMinimalResponse(spaceId,fileId,nextPageToken,maxItems,listFilter) `method`

Summary

List all support files for a file given the file ID with minimal response

Returns

A Task that resolves to IPage`1 that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list

ListSupportFilesWithMinimalResponse(spaceId,path,nextPageToken,maxItems,listFilter) `method`

Summary

List all support files for a file given the file path with minimal response

Returns

A Task that resolves toIPage`1 that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list

ListVersions(spaceId,fileId,nextPageToken,maxItems,listFilter) `method`

Summary

List all versions for a file given the file ID

Returns

A Task that resolves to IPage`1 that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list

ListVersions(spaceId,path,nextPageToken,maxItems,listFilter) `method`

Summary

List all versions for a file given the file path

Returns

A Task that resolves to IPage that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list

ListVersionsWithMinimalResponse(spaceId,fileId,nextPageToken,maxItems,listFilter) `method`

Summary

List all versions for a file given the file ID with minimal response

Returns

A Task that resolves to IPage`1 that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list

ListVersionsWithMinimalResponse(spaceId,path,nextPageToken,maxItems,listFilter) `method`

Summary

List all versions for a file given the file with minimal response

Returns

A Task that resolves to IPage that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The file path
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list

Lock(spaceId,fileId,reason) `method`

Summary

Lock a file

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
reason	System.String	Reason for locking the file

Lock(spaceId,fileId,headers,reason) `method`

Summary

Lock a file with custom headers

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
reason	System.String	Reason for locking the file

LockWithMinimalResponse(spaceId,fileId,reason) `method`

Summary

Lock a file and get minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
reason	System.String	Reason for locking the file

LockWithMinimalResponse(spaceId,fileId,headers,reason) `method`

Summary

Lock a file and get minimal response with custom headers

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
reason	System.String	Reason for locking the file

Move(spaceId,fileId,targetParentId,name) `method`

Summary

Move a file to a new location within the same space

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
targetParentId	System.Guid	The target parent ID
name	System.String	The new name of the file. If not specified, the file will be moved with its original name

Move(spaceId,fileId,targetParentId,headers,name) `method`

Summary

Move a file to a new location within the same space with custom headers

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
targetParentId	System.Guid	The target parent ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
name	System.String	The new name of the file. If not specified, the file will be moved with its original name

MoveWithMinimalResponse(spaceId,fileId,targetParentId,name) `method`

Summary

Move a file to a new location within the same space and get minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
targetParentId	System.Guid	The target parent ID
name	System.String	The new name of the file. If not specified, the file will be moved with its original name

MoveWithMinimalResponse(spaceId,fileId,targetParentId,headers,name) `method`

Summary

Move a file to a new location within the same space and get minimal response with custom headers

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
targetParentId	System.Guid	The target parent ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
name	System.String	The new name of the file. If not specified, the file will be moved with its original name

PollForMalwareScanCompletion(spaceId,fileId,timeout,interval,callback) `method`

Summary

Poll for malware scan completion

Returns

A Task that resolves to completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
timeout	System.Nullable{System.TimeSpan}	The maximum time to listen for the malware scan. Default is 3 minutes
interval	System.Nullable{System.TimeSpan}	The time interval to poll the malware scan status. Default is 5 seconds
callback	System.Action{System.Nullable{TrimbleCloud.FileService.Models.MalwareScanStatus}}	The callback to be called after each check

Rename(spaceId,fileId,name) `method`

Summary

Rename a file with a new name

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
name	System.String	The new name of the file

Rename(spaceId,fileId,name,headers) `method`

Summary

Rename a file with a new name with custom headers

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
name	System.String	The new name of the file
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers

RenameWithMinimalResponse(spaceId,fileId,name) `method`

Summary

Rename a file with a new name and get minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
name	System.String	The new name of the file

RenameWithMinimalResponse(spaceId,fileId,name,headers) `method`

Summary

Rename a file with a new name and get minimal response with custom headers

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
name	System.String	The new name of the file
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers

Restore(spaceId,fileId,name,targetParentId) `method`

Summary

Restore a file and any support files linked to it from the deleted state

Returns

A Task that resolves to the a Tuple of Response of File data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
name	System.String	The new name of the restored file. If not specified, the file will be restored with its original name
targetParentId	System.Nullable{System.Guid}	The target parent ID to restore the file to. If not specified, the file will be restored to its original location

Restore(spaceId,fileId,headers,name,targetParentId) `method`

Summary

Restore a file and any support files linked to it from the deleted state with custom headers

Returns

A Task that resolves to the a Tuple of Response of File data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
name	System.String	The new name of the restored file. If not specified, the file will be restored with its original name
targetParentId	System.Nullable{System.Guid}	The target parent ID to restore the file to. If not specified, the file will be restored to its original location

RestoreWithMinimalResponse(spaceId,fileId,name,targetParentId) `method`

Summary

Restore a file and any support files linked to it from the deleted state and get minimal response

Returns

A Task that resolves to the a Tuple of Response of MinimalFile data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
name	System.String	The new name of the restored file. If not specified, the file will be restored with its original name
targetParentId	System.Nullable{System.Guid}	The target parent ID to restore the file to. If not specified, the file will be restored to its original location

RestoreWithMinimalResponse(spaceId,fileId,headers,name,targetParentId) `method`

Summary

Restore a file and any support files linked to it from the deleted state and get minimal response with custom headers

Returns

A Task that resolves to the a Tuple of Response of MinimalFile data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers
name	System.String	The new name of the restored file. If not specified, the file will be restored with its original name
targetParentId	System.Nullable{System.Guid}	The target parent ID to restore the file to. If not specified, the file will be restored to its original location

Unlock(spaceId,fileId) `method`

Summary

Unlock a file

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID

UnlockWithMinimalResponse(spaceId,fileId) `method`

Summary

Unlock a file and get minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID

Update(spaceId,fileId,file) `method`

Summary

Update a file given the file ID

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
file	TrimbleCloud.FileService.Models.FileUpdate	The file information to update

Update(spaceId,fileId,file,headers) `method`

Summary

Update a file given the file ID with custom headers

Returns

A Task that resolves to Response that contains File data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
file	TrimbleCloud.FileService.Models.FileUpdate	The file information to update
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers

UpdateWithMinimalResponse(spaceId,fileId,file) `method`

Summary

Update a file given the file ID and get minimal response

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
file	TrimbleCloud.FileService.Models.FileUpdate	The file information to update

UpdateWithMinimalResponse(spaceId,fileId,file,headers) `method`

Summary

Update a file given the file ID and get minimal response with custom headers

Returns

A Task that resolves to Response that contains MinimalFile data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
fileId	System.Guid	The file ID
file	TrimbleCloud.FileService.Models.FileUpdate	The file information to update
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Dictionary of custom headers

Upload(request,chunkSize,maxConcurrentRequests) `method`

Summary

Upload a file

Returns

A Task that resolves to completion

Parameters

Name	Type	Description
request	TrimbleCloud.FileService.Models.UploadRequest	The upload request
chunkSize	System.Int32	The size of the chunks in bytes if provided; otherwise `15MB` chunks are used
maxConcurrentRequests	System.Int32	The number of concurrent upload tasks if provided; otherwise `8` tasks are used

Upload(request,chunkSize,maxConcurrentRequests) `method`

Summary

Upload a package

Returns

A Task that resolves to completion

Parameters

Name	Type	Description
request	TrimbleCloud.FileService.Models.PackageUploadRequest	The package upload request
chunkSize	System.Int32	The size of the chunks in bytes if provided; otherwise `15MB` chunks are used
maxConcurrentRequests	System.Int32	The number of concurrent upload tasks if provided; otherwise `8` tasks are used

Upload(uploadDetails,stream,transferConfiguration) `method`

Summary

Upload a file using pre-fetched upload details

Returns

A Task that resolves to completion

Parameters

Name	Type	Description
uploadDetails	TrimbleCloud.FileService.Models.UploadDetails	The pre-fetched upload details
stream	System.IO.Stream	The file stream to upload
transferConfiguration	TrimbleCloud.FileService.Models.TransferFileConfiguration	Chunk size and concurrency for the transfer.

Upload(uploadDetails,mainFileStream,supportFiles,transferConfiguration) `method`

Summary

Upload a package using pre-fetched upload details

Returns

A Task that resolves to completion

Parameters

Name	Type	Description
uploadDetails	TrimbleCloud.FileService.Models.UploadDetails	The pre-fetched upload details
mainFileStream	System.IO.Stream	The main file stream to upload
supportFiles	System.Collections.Generic.IList{TrimbleCloud.FileService.Models.SupportFileResourceUploadItem}	The support files to upload
transferConfiguration	TrimbleCloud.FileService.Models.TransferFileConfiguration	Chunk size and concurrency for the transfer.

WaitForUpload(spaceId,uploadId,timeout,interval,callback) `method`

Summary

Waits for upload to finish

Returns

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
uploadId	System.Guid	The upload ID
timeout	System.Nullable{System.TimeSpan}	The maximum time to wait for the upload to finish. Default is 3 minutes
interval	System.Nullable{System.TimeSpan}	The time interval to poll the upload status. Default is 5 seconds
callback	System.Action{TrimbleCloud.FileService.Models.UploadDetails}	The callback to be called after each check

WaitForUpload(spaceId,uploadId,urlDuration,timeout,interval,callback) `method`

Summary

Waits for upload to finish with custom URL duration

Returns

A Task that resolves to Response that contains UploadDetails data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
uploadId	System.Guid	The upload ID
urlDuration	System.Nullable{System.TimeSpan}	The upload URL’s validity duration. Minimum value is 5 minutes and maximum value is 7 days. Default = 60 minutes
timeout	System.Nullable{System.TimeSpan}	The maximum time to wait for the upload to finish. Default is 3 minutes
interval	System.Nullable{System.TimeSpan}	The time interval to poll the upload status. Default is 5 seconds
callback	System.Action{TrimbleCloud.FileService.Models.UploadDetails}	The callback to be called after each check

IFoldersAPI `type`

Namespace

TrimbleCloud.FileService

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
targetParentId	System.Guid	The target parent ID
name	System.String	The new name of the copied folder. If not specified, the folder will be copied with its original name
includeSupportFiles	System.Boolean	Copy support files and links along with the files
overwriteExisting	System.Boolean	Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

Copy(copyFolderRequest) `method`

Summary

Copy a folder and its children to a new location within the same space

Returns

Parameters

Name	Type	Description
copyFolderRequest	TrimbleCloud.FileService.Models.CopyFolderRequest

CopyWithMinimalResponse(spaceId,folderId,targetParentId,name,includeSupportFiles,overwriteExisting) `method`

Summary

Copy a folder to a new location within the same space and get minimal response

Returns

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
targetParentId	System.Guid	The target parent ID
name	System.String	The new name of the copied folder. If not specified, the folder will be copied with its original name
includeSupportFiles	System.Boolean	Copy support files and links along with the files
overwriteExisting	System.Boolean	Whether to overwrite an existing resource. If true, the existing resource will have a new version created with the copied content

CopyWithMinimalResponse(copyFolderRequest) `method`

Summary

Copy a folder and its children to a new location within the same space with custom headers

Returns

Parameters

Name	Type	Description
copyFolderRequest	TrimbleCloud.FileService.Models.CopyFolderRequest

Create(spaceId,folder) `method`

Summary

Create a folder

Returns

A Task that resolves to Response that contains Folder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folder	TrimbleCloud.FileService.Models.FolderCreate	The information of the folder to create

CreateBatch(spaceId,folderRequest) `method`

Summary

Create folders in batch mode. This allows you to create multiple folders at once, including nested folders.

Returns

Parameters

Name	Type	Description
spaceId	System.Guid
folderRequest	TrimbleCloud.FileService.Models.BatchFolderCreate

CreateBatchWithMinimalResponse(spaceId,folderRequest) `method`

Summary

Create folders in batch mode with minimal response. This allows you to create multiple folders at once, including nested folders.

Returns

Parameters

Name	Type	Description
spaceId	System.Guid
folderRequest	TrimbleCloud.FileService.Models.BatchFolderCreate

CreateWithMinimalResponse(spaceId,folder) `method`

Summary

Create a folder and get minimal response

Returns

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folder	TrimbleCloud.FileService.Models.FolderCreate	The information of the folder to create

Delete(spaceId,folderId,recursive,permanent) `method`

Summary

Delete a folder

Returns

A Task that resolves to possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
recursive	System.Boolean	Delete descendant folders and files
permanent	System.Boolean	Permanently delete the folder

Delete(spaceId,folderId,headers,recursive,permanent) `method`

Summary

Delete a folder with custom headers

Returns

A Task that resolves to possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Custom HTTP headers to include in the request
recursive	System.Boolean	Delete descendant folders and files
permanent	System.Boolean	Permanently delete the folder

Get(spaceId,folderId,status) `method`

Summary

Get a folder given the folder ID

Returns

A Task that resolves to Response that contains Folder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

Get(spaceId,path,status) `method`

Summary

Get a folder given the folder path

Returns

A Task that resolves to Response that contains Folder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The folder path
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

GetVersion(spaceId,folderId,versionId,status) `method`

Summary

Get folder version details given the folder ID

Returns

A Task that resolves to Response that contains Folder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
versionId	System.Int32	The version ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

GetVersion(spaceId,path,versionId,status) `method`

Summary

Get folder version details given the folder path

Returns

A Task that resolves to Response that contains Folder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The folder path
versionId	System.Int32	The version ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

GetVersionWithMinimalResponse(spaceId,folderId,versionId,status) `method`

Summary

Get folder version details given the folder ID with minimal response

Returns

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
versionId	System.Int32	The version ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

GetVersionWithMinimalResponse(spaceId,path,versionId,status) `method`

Summary

Get folder version details given the folder path with minimal response

Returns

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The folder path
versionId	System.Int32	The version ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

GetWithMinimalResponse(spaceId,folderId,status) `method`

Summary

Get a folder given the folder ID with minimal response

Returns

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

GetWithMinimalResponse(spaceId,path,status) `method`

Summary

Get a folder given the folder path with minimal response

Returns

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The folder path
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

ListChildren(spaceId,folderId,nextPageToken,maxItems,listFilter,sortBy,sortOrder,recursive) `method`

Summary

List the children of a folder given the folder ID

Returns

A Task that resolves to IPage`1 that contains FileOrFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list
sortBy	System.String
sortOrder	System.String
recursive	System.Boolean

ListChildren(spaceId,path,nextPageToken,maxItems,listFilter,sortBy,sortOrder,recursive) `method`

Summary

List the children of a folder given the folder path

Returns

A Task that resolves to IPage`1 that contains FileOrFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The folder path
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
listFilter	TrimbleCloud.FileService.Models.ListFilterCriteria	The filter to apply to the list
sortBy	System.String
sortOrder	System.String
recursive	System.Boolean

ListChildren(request) `method`

Summary

List the children of a folder using a request object. Either FolderId or Path must be specified in the request, but not both.

Returns

A Task that resolves to IPage`1 that contains FileOrFolder data on completion

Parameters

Name	Type	Description
request	TrimbleCloud.FileService.Models.FolderListChildrenRequest	The request object containing all parameters for listing children

ListVersions(spaceId,folderId,nextPageToken,maxItems,status) `method`

Summary

List all versions for a folder in a space given the folder ID

Returns

A Task that resolves to IPage`1 that contains Folder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

ListVersions(spaceId,path,nextPageToken,maxItems,status) `method`

Summary

List all versions for a folder in a space given the folder path

Returns

A Task that resolves to IPage`1 that contains Folder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The folder path
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

ListVersionsWithMinimalResponse(spaceId,folderId,nextPageToken,maxItems,status) `method`

Summary

List all versions for a folder in a space given the folder ID with minimal response

Returns

A Task that resolves to IPage`1 that contains MinimalFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

ListVersionsWithMinimalResponse(spaceId,path,nextPageToken,maxItems,status) `method`

Summary

List all versions for a folder in a space given the folder path with minimal response

Returns

A Task that resolves to IPage`1 that contains MinimalFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
path	System.String	The folder path
nextPageToken	System.String	The token to retrieve the next page of items
maxItems	System.Int32	The number of items to return in each page
status	TrimbleCloud.FileService.Models.ResourceStatus	The status of the folder

Move(spaceId,folderId,targetParentId,name) `method`

Summary

Move a folder to a new location within the same space

Returns

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
targetParentId	System.Guid	The target parent ID
name	System.String

Move(spaceId,folderId,targetParentId,name,headers) `method`

Summary

Move a folder to a new location within the same space with custom headers

Returns

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
targetParentId	System.Guid	The target parent ID
name	System.Collections.Generic.IDictionary{System.String,System.String}
headers	System.String	Custom HTTP headers to include in the request

MoveWithMinimalResponse(spaceId,folderId,targetParentId,name) `method`

Summary

Move a folder to a new location within the same space and get minimal response

Returns

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
targetParentId	System.Guid	The target parent ID
name	System.String

MoveWithMinimalResponse(spaceId,folderId,targetParentId,name,headers) `method`

Summary

Move a folder to a new location within the same space and get minimal response with custom headers

Returns

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
targetParentId	System.Guid	The target parent ID
name	System.Collections.Generic.IDictionary{System.String,System.String}
headers	System.String	Custom HTTP headers to include in the request

Rename(spaceId,folderId,name) `method`

Summary

Rename a folder with a new name

Returns

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
name	System.String	The new name of the folder

Rename(spaceId,folderId,name,headers) `method`

Summary

Rename a folder with a new name with custom headers

Returns

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
name	System.String	The new name of the folder
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Custom HTTP headers to include in the request

RenameWithMinimalResponse(spaceId,folderId,name) `method`

Summary

Rename a folder with a new name and get minimal response

Returns

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
name	System.String	The new name of the folder

RenameWithMinimalResponse(spaceId,folderId,name,headers) `method`

Summary

Rename a folder with a new name and get minimal response with custom headers

Returns

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
name	System.String	The new name of the folder
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Custom HTTP headers to include in the request

Restore(spaceId,folderId,name,targetParentId) `method`

Summary

Restore a folder and its children from the deleted state

Returns

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
name	System.String	The new name of the restored folder. If not specified, the folder will be restored with its original name
targetParentId	System.Nullable{System.Guid}	The target parent ID to restore the folder to. If not specified, the folder will be restored to its original location

Restore(spaceId,folderId,headers,name,targetParentId) `method`

Summary

Restore a folder and its children from the deleted state with custom headers

Returns

A Task that resolves to the a Tuple of Response of Folder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Custom HTTP headers to include in the request
name	System.String	The new name of the restored folder. If not specified, the folder will be restored with its original name
targetParentId	System.Nullable{System.Guid}	The target parent ID to restore the folder to. If not specified, the folder will be restored to its original location

RestoreWithMinimalResponse(spaceId,folderId,name,targetParentId) `method`

Summary

Restore a folder and its children from the deleted state and get minimal response

Returns

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
name	System.String	The new name of the restored folder. If not specified, the folder will be restored with its original name
targetParentId	System.Nullable{System.Guid}	The target parent ID to restore the folder to. If not specified, the folder will be restored to its original location

RestoreWithMinimalResponse(spaceId,folderId,headers,name,targetParentId) `method`

Summary

Restore a folder and its children from the deleted state and get minimal response with custom headers

Returns

A Task that resolves to the a Tuple of Response of MinimalFolder data and possible JobId on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Custom HTTP headers to include in the request
name	System.String	The new name of the restored folder. If not specified, the folder will be restored with its original name
targetParentId	System.Nullable{System.Guid}	The target parent ID to restore the folder to. If not specified, the folder will be restored to its original location

Update(spaceId,folderId,folder) `method`

Summary

Update a folder

Returns

A Task that resolves to Response that contains Folder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
folder	TrimbleCloud.FileService.Models.FolderUpdate	The folder information to update

Update(spaceId,folderId,folder,headers) `method`

Summary

Update a folder with custom headers

Returns

A Task that resolves to Response that contains Folder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
folder	TrimbleCloud.FileService.Models.FolderUpdate	The folder information to update
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Custom HTTP headers to include in the request

UpdateWithMinimalResponse(spaceId,folderId,folder) `method`

Summary

Update a folder and get minimal response

Returns

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
folder	TrimbleCloud.FileService.Models.FolderUpdate	The folder information to update

UpdateWithMinimalResponse(spaceId,folderId,folder,headers) `method`

Summary

Update a folder and get minimal response with custom headers

Returns

A Task that resolves to Response that contains MinimalFolder data on completion

Parameters

Name	Type	Description
spaceId	System.Guid	The space ID
folderId	System.Guid	The folder ID
folder	TrimbleCloud.FileService.Models.FolderUpdate	The folder information to update
headers	System.Collections.Generic.IDictionary{System.String,System.String}	Custom HTTP headers to include in the request

IJobsAPI `type`

Namespace

Name	Type	Description
jobId	System.Guid
queryParams	TrimbleCloud.FileService.Models.GetJobQueryParams

WaitForJob(id,timeout,interval,callback) `method`

Summary

Waits for job to finish

Returns

A Task that resolves to Response that contains Job data on completion

Parameters

Name	Type	Description
id	System.Guid	The job id
timeout	System.Nullable{System.TimeSpan}	The maximum time to wait for the job to finish. Default is 3 minutes
interval	System.Nullable{System.TimeSpan}	The time interval to poll the job status. Default is 5 seconds
callback	System.Action{TrimbleCloud.FileService.Models.Job}	The callback function to be called when the job status is polled

IObjectTypesAPI `type`

Namespace

TrimbleCloud.FileService

Summary

Interface for Object Types API.

Create(request) `method`

Summary

Creates a new object type definition.

Returns

A Task that resolves to Response that contains ObjectType data on completion

Parameters

Name	Type	Description
request	TrimbleCloud.FileService.Models.ObjectTypeCreate	The object type to create.

Exceptions

Name	Description
TrimbleCloud.FileService.TrimbleServiceException	Thrown when an API or network error occurs
System.ArgumentNullException	Thrown when request is null

Get(objectTypeId) `method`

Summary

Gets an object type by ID.

Returns

A Task that resolves to Response that contains ObjectType data on completion

Parameters

Name	Type	Description
objectTypeId	System.String	The object type ID.

Exceptions

Name	Description
TrimbleCloud.FileService.TrimbleServiceException	Thrown when an API or network error occurs
System.ArgumentException	Thrown when objectTypeId is null or empty

IObjectsAPI `type`

IResourcesAPI `type`

Namespace

TrimbleCloud.FileService

Namespace

JobType `type`

Namespace

JsonRawStringConverter `type`

Namespace

Exceptions

Name	Description
Newtonsoft.Json.JsonSerializationException	Thrown when the string is not valid JSON.

Gets or sets the file URL duration.

ListObjectResourcesParams `type`

Namespace

Returns

Dictionary of query parameters

Parameters

This method has no parameters.

ListObjectVersionsParams `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Parameters for listing object versions.

NextPageToken `property`

Summary

The token for the next page of results.

PageSize `property`

Summary

The maximum number of items to return per page.

Status `property`

Summary

The status filter for objects.

GetQueryParameters() `method`

Summary

Gets query parameters for the request.

Returns

Dictionary of query parameters

Parameters

This method has no parameters.

ListQueryStringFormatter`1 `type`

Namespace

TrimbleCloud.FileService.Utilities

Summary

Query String Formatter

ToQueryString() `method`

Summary

Convert the filter to query string

Parameters

This method has no parameters.

Lock `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Contains the lock details of a file

LockedAt `property`

Summary

The date and time when the file was locked.

LockedBy `property`

Summary

The TRN (Trimble Resource Name) of the user/device/application that locked this file.

Reason `property`

Summary

The reason for locking the file.

MalwareScanStatus `type`

Namespace

MinimalObjectEntity `type`

Namespace

MinimalObjectJobResponse `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents a minimal job response for object operations (move, rename, restore). Contains the job ID and minimal object details for performance optimization.

JobId `property`

Summary

The job ID for tracking the async operation. Extracted from the Location header in the response.

Resource `property`

Summary

The object resource with minimal details returned by the operation.

MinimalSpace `type`

Namespace

The folder or root ID in which the object resides.

PermissionsLocal `property`

Summary

Permissions to be set on the object.

Size `property`

Summary

The size of the object in bytes.

ObjectDelete `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents a request to delete an object.

ObjectId `property`

Summary

The object ID.

Permanent `property`

Summary

Whether to permanently delete the object.

SpaceId `property`

Summary

The space ID.

ObjectEntity `type`

Namespace

ObjectJobResponse `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents a job response for object operations (move, rename, restore). Contains the job ID for tracking async operations and the resulting object.

InvalidResources `property`

Summary

List of invalid resources encountered during the operation.

JobId `property`

Summary

The job ID for tracking the async operation. Extracted from the Location header in the response.

Resource `property`

Summary

The object resource returned by the operation.

ObjectLink `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents a request to link support files to an object.

Links `property`

Summary

The support file links to create or update. Key is the link name, value is the support file details.

ObjectMove `type`

Namespace

Summary

Represents the permissions explicitly assigned to an object.

Acl `property`

Summary

The list of actors, their roles, and version restrictions.

Inherits `property`

Summary

Specifies if permissions are inherited from the parent folder.

ObjectRename `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents a request to rename an object.

Name `property`

Summary

The new name for the object.

ObjectId `property`

Summary

The object ID.

SpaceId `property`

Summary

The space ID.

ObjectRestore `type`

Namespace

Summary

Statistics about support files linked to an object.

SupportFilesCount `property`

Summary

The total count of support files.

SupportFilesSize `property`

Summary

The total size of all support files in bytes.

SupportFilesUpdatedAt `property`

Summary

The date and time when the support files were last updated.

ObjectSupportFileDetails `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents support file details for linking to an object.

Id `property`

Summary

The unique identifier of the support file.

Version `property`

Summary

The major version of the object to link the support file to.

ObjectType `type`

Namespace

ObjectTypeCreate `type`

Namespace

ReplaceAcl `property`

Summary

Replace the entire ACL with this list of entries. Mutually exclusive with UpdateAcl.

UpdateAcl `property`

Summary

Update specific ACL entries (add or remove actors). Mutually exclusive with ReplaceAcl.

ObjectUpdateSupportFileDetails `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents support file details for updating links on an object.

Id `property`

Summary

The unique identifier of the support file.

Version `property`

Summary

The major version of the object to link the support file to.

Output `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Contains the download URL of an export.

Url `property`

Summary

The URL to download the export from.

PackageUploadCreate `type`

Namespace

PackageUploadRequest `type`

Namespace

Summary

Defines a page in responses.

Generic Types

Name	Description
T	Type of the page content items

Items `property`

Summary

The items in the page.

Unknown `constants`

Summary

Unknown cloud provider

ResourceBase `type`

Namespace

All `constants`

Summary

Both active and deleted resources

Deleted `constants`

Summary

Deleted resources

Unknown `constants`

Summary

Unknown resource status

ResourceType `type`

Namespace

Returns

A new instance of Response`1 with the provided value and HTTP response.

Parameters

Name	Type	Description
value	“0	The value.
response	TrimbleCloud.FileService.Response	The HTTP response.

Generic Types

Name	Description
T	The type of the value.

ToString() `method`

Summary

Returns the string representation of this Response.

Returns

Summary

The status of the upload operation.

RetentionPeriod `type`

Namespace

Space `type`

Namespace

PermissionsLocal `property`

Summary

Permissions that are set directly for an actor on the resource itself.

Provider `property`

Summary

The cloud provider where the filespace will be created. Supported values are ‘AWS’ and ‘Azure’. Default: ‘AWS’

SoftDeleteRetention `property`

Summary

Duration of soft deleted resources being retained before being permanently removed. Supported values are ‘ThirtyDays’, ‘SixMonths’, ‘OneYear’, ‘NeverDelete’. Default: ‘ThirtyDays’

SpaceMembershipBoundary `property`

Summary

The membership boundary configuration for the space. Defines group-based access controls and viewer permissions outside the boundary group.

SpaceListFilterCriteria `type`

Namespace

Summary

Represents the membership boundary configuration for a space.

AllowLimitedViewerOutsideBoundaryGroup `property`

Summary

Indicates whether limited viewers outside the boundary group are allowed.

Group `property`

Summary

The TRN (Trimble Resource Name) of the group that defines the membership boundary.

SpacePermissionsLocal `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Represents the permissions explicitly assigned to a space.

Acl `property`

Summary

The list of actors and their roles.

SpaceStatistics `type`

Namespace

UpdateAcl `property`

Summary

Add or remove roles to the existing permissions on the resource.

SupportFileDetails `type`

Namespace

Summary

Represents support file link.

Id `property`

Summary

The unique identifier of the support file.

Version `property`

Summary

The version of the support file.

SupportFileResource `type`

Namespace

SupportFileResourceDetails `type`

Namespace

Summary

Represents a support file upload item.

SupportFileKey `property`

Summary

The key of the support file.

SupportFileStream `property`

Summary

The corresponding support file stream.

SupportFileUploadCreate `type`

Namespace

TransferFileConfiguration `type`

Namespace

TrimbleCloud.FileService.Models

Summary

Configuration for chunked file upload and download transfers.

ChunkSize `property`

Summary

The size of the chunks in bytes. Default is 15MB.

MaxConcurrentRequests `property`

RequestId `property`

Summary

Gets the request ID for tracking and support purposes.

StatusCode `property`

Summary

Gets the HTTP status code of the response. Returns 0 if response was not received.

TrimbleCloud.FileService.Models

Summary

Contains the upload URL and upload type of a file.

Type `property`

Summary

The type of the file upload URL.

Url `property`

Summary

The URL to upload the file to.

UploadDetails `type`

Namespace

Namespace

UploadType `type`

Namespace

Parameters

Name	Type	Description
parameters	System.Collections.Generic.IDictionary{System.String,System.String}	The dictionary of parameters to convert to a query string

TrimbleCloud.FileService

TrimbleCloud.FileService

Contents

APIBase type

Namespace

Summary

JsonContentType constants

Summary

JsonWrapperFormat constants

Summary

_client constants

Summary

_wrapperName constants

Summary

GetRequestId(message) method

Summary

Returns

Parameters

ThrowErrorAsync(response) method

Summary

Parameters

Exceptions

Acl type

Namespace

Summary

AccessExpiresAt property

Summary

Actor property

Summary

Role property

Summary

AclActor type

Namespace

Summary

Actor property

Summary

AclApplicationIdentity type

Namespace

Summary

#ctor(applicationId) constructor

Summary

Parameters

FormatEntity() method

Summary

Parameters

AclCustomIdentity type

Namespace

Summary

#ctor(entityTrn) constructor

Summary

Parameters

FormatEntity() method

Summary

Parameters

AclDeviceIdentity type

Namespace

Summary

#ctor(deviceId) constructor

Summary

Parameters

FormatEntity() method

Summary

Parameters

AclIdentity type

Namespace

Summary

EntityId property

Summary

Equals(obj) method

Summary

Returns

Parameters

FormatEntity() method

Summary

Returns

Parameters

GetHashCode() method

Summary

Returns

Parameters

APIBase `type`

JsonContentType `constants`

JsonWrapperFormat `constants`

_client `constants`

_wrapperName `constants`

GetRequestId(message) `method`

ThrowErrorAsync(response) `method`

Acl `type`

AccessExpiresAt `property`

Actor `property`

Role `property`

AclActor `type`

Actor `property`

AclApplicationIdentity `type`

#ctor(applicationId) `constructor`

FormatEntity() `method`

AclCustomIdentity `type`

#ctor(entityTrn) `constructor`

FormatEntity() `method`

AclDeviceIdentity `type`

#ctor(deviceId) `constructor`

FormatEntity() `method`

AclIdentity `type`

EntityId `property`

Equals(obj) `method`

FormatEntity() `method`

GetHashCode() `method`

Parse(entityTrn) `method`

ToString() `method`

AclIdentityConverter `type`

CanConvertFrom() `method`

ConvertFrom() `method`

AclRole `type`

ContentContributor `constants`

ContentManager `constants`

ContentViewer `constants`

LimitedViewer `constants`

SpaceManager `constants`

SupportFileAdmin `constants`

Unknown `constants`

AclUserIdentity `type`

#ctor(userId) `constructor`

FormatEntity() `method`

BatchFolderCreate `type`

Folders `property`

BatchFolderList `type`

InvalidItems `property`

Items `property`

BatchMinimalFolderList `type`

InvalidItems `property`

Items `property`

BatchResourceListResponse `type`

InvalidItems `property`

Items `property`