Overview

//trimblecloud-fileservice/trimblecloud.fileservice.models/File

File

[JVM]
open class File

Represents a file response.

Constructors

File	[JVM] constructor()

Properties

Name	Summary
capabilities	[JVM] open var capabilities: Capabilities The actions that can be performed on the resource by the current user.
checkout	[JVM] open var checkout: Checkout Checkout attached to the file.
createdAt	[JVM] open var createdAt: Date Creation date of the file.
createdBy	[JVM] open var createdBy: AclIdentity The TRN of the application/device/user that created this resource.
deleted	[JVM] open var deleted: Boolean True if the entity has been deleted
deletedAt	[JVM] open var deletedAt: Date Deletion date of the file.
download	[JVM] open var download: Download Retrieves the download information.
expiresAt	[JVM] open var expiresAt: Date Time period when the file object gets automatically removed.
fileset	[JVM] open var fileset: Boolean Whether the object consists of a set of multiple files that should be treated as a single file, such as with shape files.
id	[JVM] open var id: UUID Retrieves the unique identifier of the file.
lastMalwareScanDate	[JVM] open var lastMalwareScanDate: Date The date and time of the last malware scan for the file..
links	[JVM] open var links: HashMap<String, SupportFileDetails> The support file links.
lock	[JVM] open var lock: Lock The lock details of the file.
malwareScanResult	[JVM] open var malwareScanResult: String The result of the malware scan for the file.
malwareScanStatus	[JVM] open var malwareScanStatus: MalwareScanStatus The malware scan status of the file
malwareType	[JVM] open var malwareType: String The type of malware detected.
md5	[JVM] open var md5: String MD5 hash of the file object.
metadata	[JVM] open var metadata: HashMap<String, Any> The metadata of the space.
name	[JVM] open var name: String Retrieves the name of the file.
parentId	[JVM] open var parentId: UUID Retrieves the unique identifier of the parent folder.
parentTrn	[JVM] open var parentTrn: String The Trimble Resource Name (TRN) of the parent folder.
parentType	[JVM] open var parentType: ParentType Retrieves the type of the parent.
path	[JVM] open var path: String Retrieves the path of the file.
permissionsEvaluated	[JVM] open var permissionsEvaluated: PermissionsEvaluated Permissions evaluated for the actors on the resource.
permissionsInherited	[JVM] open var permissionsInherited: PermissionsInherited Permissions inherited from the entire parent hierarchy applicable for the actor.
permissionsLocal	[JVM] open var permissionsLocal: FilePermissionsLocal Permissions that are set directly for an actor on the resource itself.
resourceTrn	[JVM] open var resourceTrn: String The Trimble Resource Name (TRN) of the file.
responseHeaders	[JVM] open var responseHeaders: HashMap<String, String> The response headers.
restrictedAccess	[JVM] open var restrictedAccess: Boolean Set to false if the download url of the file shouldn’t be expired.
size	[JVM] open var size: Long Size of the file in bytes.
spaceId	[JVM] open var spaceId: UUID Retrieves the unique identifier of the space in which the file is stored.
spaceTrn	[JVM] open var spaceTrn: String The Trimble Resource Name (TRN) of the space in which the file is stored.
statistics	[JVM] open var statistics: FileStatistics The statistics of the file.
type	[JVM] open var type: ResourceType Retrieves the type of the resource.
updatedAt	[JVM] open var updatedAt: Date Update date of the file.
updatedBy	[JVM] open var updatedBy: AclIdentity The TRN of the application/device/user that last updated this resource.
version	[JVM] open var version: String Retrieves the version of the file.

Functions

Name	Summary
isMultipart	[JVM] open fun isMultipart(): Boolean Whether the object consists of multiple parts that should be treated as a single file, such as with multipart uploads.
setMultipart	[JVM] open fun setMultipart(multipart: Boolean) Whether the object consists of multiple parts that should be treated as a single file, such as with multipart uploads.
toString	[JVM] open fun toString(): String