drive  v3
Classes | Properties | List of all members
Google.Apis.Drive.v3.Data.File Class Reference

The metadata for a file. More...

Inheritance diagram for Google.Apis.Drive.v3.Data.File:
Google::Apis::Requests::IDirectResponseSchema

Classes

class  CapabilitiesData
 Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. More...
 
class  ContentHintsData
 Additional information about the content of the file. These fields are never populated in responses. More...
 
class  ImageMediaMetadataData
 Additional metadata about image media, if available. More...
 
class  ShortcutDetailsData
 Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. More...
 
class  VideoMediaMetadataData
 Additional metadata about video media. This may not be available immediately upon upload. More...
 

Properties

virtual System.Collections.Generic.IDictionary< string, string > AppProperties [get, set]
 A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests. More...
 
virtual File.CapabilitiesData Capabilities [get, set]
 Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take. More...
 
virtual File.ContentHintsData ContentHints [get, set]
 Additional information about the content of the file. These fields are never populated in responses. More...
 
virtual System.Nullable< bool > CopyRequiresWriterPermission [get, set]
 Whether the options to copy, print, or download this file, should be disabled for readers and commenters. More...
 
virtual string CreatedTimeRaw [get, set]
 The time at which the file was created (RFC 3339 date-time). More...
 
virtual System.Nullable< System.DateTime > CreatedTime [get, set]
 
See also
System.DateTime

representation of CreatedTimeRaw. More...

 
virtual string Description [get, set]
 A short description of the file. More...
 
virtual string DriveId [get, set]
 ID of the shared drive the file resides in. Only populated for items in shared drives. More...
 
virtual System.Nullable< bool > ExplicitlyTrashed [get, set]
 Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder. More...
 
virtual System.Collections.Generic.IDictionary< string, string > ExportLinks [get, set]
 Links for exporting Google Docs to specific formats. More...
 
virtual string FileExtension [get, set]
 The final component of fullFileExtension. This is only available for files with binary content in Google Drive. More...
 
virtual string FolderColorRgb [get, set]
 The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead. More...
 
virtual string FullFileExtension [get, set]
 The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension. More...
 
virtual System.Nullable< bool > HasAugmentedPermissions [get, set]
 Whether there are permissions directly on this file. This field is only populated for items in shared drives. More...
 
virtual System.Nullable< bool > HasThumbnail [get, set]
 Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field. More...
 
virtual string HeadRevisionId [get, set]
 The ID of the file's head revision. This is currently only available for files with binary content in Google Drive. More...
 
virtual string IconLink [get, set]
 A static, unauthenticated link to the file's icon. More...
 
virtual string Id [get, set]
 The ID of the file. More...
 
virtual File.ImageMediaMetadataData ImageMediaMetadata [get, set]
 Additional metadata about image media, if available. More...
 
virtual System.Nullable< bool > IsAppAuthorized [get, set]
 Whether the file was created or opened by the requesting app. More...
 
virtual string Kind [get, set]
 Identifies what kind of resource this is. Value: the fixed string "drive#file". More...
 
virtual User LastModifyingUser [get, set]
 The last user to modify the file. More...
 
virtual string Md5Checksum [get, set]
 The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive. More...
 
virtual string MimeType [get, set]
 The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource. More...
 
virtual System.Nullable< bool > ModifiedByMe [get, set]
 Whether the file has been modified by this user. More...
 
virtual string ModifiedByMeTimeRaw [get, set]
 The last time the file was modified by the user (RFC 3339 date-time). More...
 
virtual System.Nullable< System.DateTime > ModifiedByMeTime [get, set]
 
See also
System.DateTime

representation of ModifiedByMeTimeRaw. More...

 
virtual string ModifiedTimeRaw [get, set]
 The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user. More...
 
virtual System.Nullable< System.DateTime > ModifiedTime [get, set]
 
See also
System.DateTime

representation of ModifiedTimeRaw. More...

 
virtual string Name [get, set]
 The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant. More...
 
virtual string OriginalFilename [get, set]
 The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive. More...
 
virtual System.Nullable< bool > OwnedByMe [get, set]
 Whether the user owns the file. Not populated for items in shared drives. More...
 
virtual System.Collections.Generic.IList< UserOwners [get, set]
 The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives. More...
 
virtual System.Collections.Generic.IList< string > Parents [get, set]
 The IDs of the parent folders which contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list. More...
 
virtual System.Collections.Generic.IList< string > PermissionIds [get, set]
 List of permission IDs for users with access to this file. More...
 
virtual System.Collections.Generic.IList< PermissionPermissions [get, set]
 The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives. More...
 
virtual System.Collections.Generic.IDictionary< string, string > Properties [get, set]
 A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests. More...
 
virtual System.Nullable< long > QuotaBytesUsed [get, set]
 The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled. More...
 
virtual System.Nullable< bool > Shared [get, set]
 Whether the file has been shared. Not populated for items in shared drives. More...
 
virtual string SharedWithMeTimeRaw [get, set]
 The time at which the file was shared with the user, if applicable (RFC 3339 date-time). More...
 
virtual System.Nullable< System.DateTime > SharedWithMeTime [get, set]
 
See also
System.DateTime

representation of SharedWithMeTimeRaw. More...

 
virtual User SharingUser [get, set]
 The user who shared the file with the requesting user, if applicable. More...
 
virtual File.ShortcutDetailsData ShortcutDetails [get, set]
 Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut. More...
 
virtual System.Nullable< long > Size [get, set]
 The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive. More...
 
virtual System.Collections.Generic.IList< string > Spaces [get, set]
 The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'. More...
 
virtual System.Nullable< bool > Starred [get, set]
 Whether the user has starred the file. More...
 
virtual string TeamDriveId [get, set]
 Deprecated - use driveId instead. More...
 
virtual string ThumbnailLink [get, set]
 A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. More...
 
virtual System.Nullable< long > ThumbnailVersion [get, set]
 The thumbnail version for use in thumbnail cache invalidation. More...
 
virtual System.Nullable< bool > Trashed [get, set]
 Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash. More...
 
virtual string TrashedTimeRaw [get, set]
 The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives. More...
 
virtual System.Nullable< System.DateTime > TrashedTime [get, set]
 
See also
System.DateTime

representation of TrashedTimeRaw. More...

 
virtual User TrashingUser [get, set]
 If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives. More...
 
virtual System.Nullable< long > Version [get, set]
 A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user. More...
 
virtual File.VideoMediaMetadataData VideoMediaMetadata [get, set]
 Additional metadata about video media. This may not be available immediately upon upload. More...
 
virtual System.Nullable< bool > ViewedByMe [get, set]
 Whether the file has been viewed by this user. More...
 
virtual string ViewedByMeTimeRaw [get, set]
 The last time the file was viewed by the user (RFC 3339 date-time). More...
 
virtual System.Nullable< System.DateTime > ViewedByMeTime [get, set]
 
See also
System.DateTime

representation of ViewedByMeTimeRaw. More...

 
virtual System.Nullable< bool > ViewersCanCopyContent [get, set]
 Deprecated - use copyRequiresWriterPermission instead. More...
 
virtual string WebContentLink [get, set]
 A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive. More...
 
virtual string WebViewLink [get, set]
 A link for opening the file in a relevant Google editor or viewer in a browser. More...
 
virtual System.Nullable< bool > WritersCanShare [get, set]
 Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives. More...
 
virtual string ETag [get, set]
 The ETag of the item. More...
 
- Properties inherited from Google::Apis::Requests::IDirectResponseSchema
string ETag
 

Detailed Description

The metadata for a file.

Property Documentation

◆ AppProperties

virtual System.Collections.Generic.IDictionary<string,string> Google.Apis.Drive.v3.Data.File.AppProperties
getset

A collection of arbitrary key-value pairs which are private to the requesting app. Entries with null values are cleared in update and copy requests.

◆ Capabilities

virtual File.CapabilitiesData Google.Apis.Drive.v3.Data.File.Capabilities
getset

Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

◆ ContentHints

virtual File.ContentHintsData Google.Apis.Drive.v3.Data.File.ContentHints
getset

Additional information about the content of the file. These fields are never populated in responses.

◆ CopyRequiresWriterPermission

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.CopyRequiresWriterPermission
getset

Whether the options to copy, print, or download this file, should be disabled for readers and commenters.

◆ CreatedTime

virtual System.Nullable<System.DateTime> Google.Apis.Drive.v3.Data.File.CreatedTime
getset

See also
System.DateTime

representation of CreatedTimeRaw.

◆ CreatedTimeRaw

virtual string Google.Apis.Drive.v3.Data.File.CreatedTimeRaw
getset

The time at which the file was created (RFC 3339 date-time).

◆ Description

virtual string Google.Apis.Drive.v3.Data.File.Description
getset

A short description of the file.

◆ DriveId

virtual string Google.Apis.Drive.v3.Data.File.DriveId
getset

ID of the shared drive the file resides in. Only populated for items in shared drives.

◆ ETag

virtual string Google.Apis.Drive.v3.Data.File.ETag
getset

The ETag of the item.

◆ ExplicitlyTrashed

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.ExplicitlyTrashed
getset

Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.

◆ ExportLinks

virtual System.Collections.Generic.IDictionary<string,string> Google.Apis.Drive.v3.Data.File.ExportLinks
getset

Links for exporting Google Docs to specific formats.

◆ FileExtension

virtual string Google.Apis.Drive.v3.Data.File.FileExtension
getset

The final component of fullFileExtension. This is only available for files with binary content in Google Drive.

◆ FolderColorRgb

virtual string Google.Apis.Drive.v3.Data.File.FolderColorRgb
getset

The color for a folder as an RGB hex string. The supported colors are published in the folderColorPalette field of the About resource. If an unsupported color is specified, the closest color in the palette will be used instead.

◆ FullFileExtension

virtual string Google.Apis.Drive.v3.Data.File.FullFileExtension
getset

The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz". This is only available for files with binary content in Google Drive. This is automatically updated when the name field changes, however it is not cleared if the new name does not contain a valid extension.

◆ HasAugmentedPermissions

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.HasAugmentedPermissions
getset

Whether there are permissions directly on this file. This field is only populated for items in shared drives.

◆ HasThumbnail

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.HasThumbnail
getset

Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail. To check access, look for the presence of the thumbnailLink field.

◆ HeadRevisionId

virtual string Google.Apis.Drive.v3.Data.File.HeadRevisionId
getset

The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.

◆ IconLink

virtual string Google.Apis.Drive.v3.Data.File.IconLink
getset

A static, unauthenticated link to the file's icon.

◆ Id

virtual string Google.Apis.Drive.v3.Data.File.Id
getset

The ID of the file.

◆ ImageMediaMetadata

virtual File.ImageMediaMetadataData Google.Apis.Drive.v3.Data.File.ImageMediaMetadata
getset

Additional metadata about image media, if available.

◆ IsAppAuthorized

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.IsAppAuthorized
getset

Whether the file was created or opened by the requesting app.

◆ Kind

virtual string Google.Apis.Drive.v3.Data.File.Kind
getset

Identifies what kind of resource this is. Value: the fixed string "drive#file".

◆ LastModifyingUser

virtual User Google.Apis.Drive.v3.Data.File.LastModifyingUser
getset

The last user to modify the file.

◆ Md5Checksum

virtual string Google.Apis.Drive.v3.Data.File.Md5Checksum
getset

The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.

◆ MimeType

virtual string Google.Apis.Drive.v3.Data.File.MimeType
getset

The MIME type of the file. Google Drive will attempt to automatically detect an appropriate value from uploaded content if no value is provided. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource.

◆ ModifiedByMe

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.ModifiedByMe
getset

Whether the file has been modified by this user.

◆ ModifiedByMeTime

virtual System.Nullable<System.DateTime> Google.Apis.Drive.v3.Data.File.ModifiedByMeTime
getset

See also
System.DateTime

representation of ModifiedByMeTimeRaw.

◆ ModifiedByMeTimeRaw

virtual string Google.Apis.Drive.v3.Data.File.ModifiedByMeTimeRaw
getset

The last time the file was modified by the user (RFC 3339 date-time).

◆ ModifiedTime

virtual System.Nullable<System.DateTime> Google.Apis.Drive.v3.Data.File.ModifiedTime
getset

See also
System.DateTime

representation of ModifiedTimeRaw.

◆ ModifiedTimeRaw

virtual string Google.Apis.Drive.v3.Data.File.ModifiedTimeRaw
getset

The last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.

◆ Name

virtual string Google.Apis.Drive.v3.Data.File.Name
getset

The name of the file. This is not necessarily unique within a folder. Note that for immutable items such as the top level folders of shared drives, My Drive root folder, and Application Data folder the name is constant.

◆ OriginalFilename

virtual string Google.Apis.Drive.v3.Data.File.OriginalFilename
getset

The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive.

◆ OwnedByMe

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.OwnedByMe
getset

Whether the user owns the file. Not populated for items in shared drives.

◆ Owners

virtual System.Collections.Generic.IList<User> Google.Apis.Drive.v3.Data.File.Owners
getset

The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives.

◆ Parents

virtual System.Collections.Generic.IList<string> Google.Apis.Drive.v3.Data.File.Parents
getset

The IDs of the parent folders which contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file. Update requests must use the addParents and removeParents parameters to modify the parents list.

◆ PermissionIds

virtual System.Collections.Generic.IList<string> Google.Apis.Drive.v3.Data.File.PermissionIds
getset

List of permission IDs for users with access to this file.

◆ Permissions

virtual System.Collections.Generic.IList<Permission> Google.Apis.Drive.v3.Data.File.Permissions
getset

The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives.

◆ Properties

virtual System.Collections.Generic.IDictionary<string,string> Google.Apis.Drive.v3.Data.File.Properties
getset

A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.

◆ QuotaBytesUsed

virtual System.Nullable<long> Google.Apis.Drive.v3.Data.File.QuotaBytesUsed
getset

The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled.

◆ Shared

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.Shared
getset

Whether the file has been shared. Not populated for items in shared drives.

◆ SharedWithMeTime

virtual System.Nullable<System.DateTime> Google.Apis.Drive.v3.Data.File.SharedWithMeTime
getset

See also
System.DateTime

representation of SharedWithMeTimeRaw.

◆ SharedWithMeTimeRaw

virtual string Google.Apis.Drive.v3.Data.File.SharedWithMeTimeRaw
getset

The time at which the file was shared with the user, if applicable (RFC 3339 date-time).

◆ SharingUser

virtual User Google.Apis.Drive.v3.Data.File.SharingUser
getset

The user who shared the file with the requesting user, if applicable.

◆ ShortcutDetails

virtual File.ShortcutDetailsData Google.Apis.Drive.v3.Data.File.ShortcutDetails
getset

Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

◆ Size

virtual System.Nullable<long> Google.Apis.Drive.v3.Data.File.Size
getset

The size of the file's content in bytes. This is only applicable to files with binary content in Google Drive.

◆ Spaces

virtual System.Collections.Generic.IList<string> Google.Apis.Drive.v3.Data.File.Spaces
getset

The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.

◆ Starred

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.Starred
getset

Whether the user has starred the file.

◆ TeamDriveId

virtual string Google.Apis.Drive.v3.Data.File.TeamDriveId
getset

Deprecated - use driveId instead.

◆ ThumbnailLink

virtual string Google.Apis.Drive.v3.Data.File.ThumbnailLink
getset

A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content.

◆ ThumbnailVersion

virtual System.Nullable<long> Google.Apis.Drive.v3.Data.File.ThumbnailVersion
getset

The thumbnail version for use in thumbnail cache invalidation.

◆ Trashed

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.Trashed
getset

Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file, and other users cannot see files in the owner's trash.

◆ TrashedTime

virtual System.Nullable<System.DateTime> Google.Apis.Drive.v3.Data.File.TrashedTime
getset

See also
System.DateTime

representation of TrashedTimeRaw.

◆ TrashedTimeRaw

virtual string Google.Apis.Drive.v3.Data.File.TrashedTimeRaw
getset

The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.

◆ TrashingUser

virtual User Google.Apis.Drive.v3.Data.File.TrashingUser
getset

If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.

◆ Version

virtual System.Nullable<long> Google.Apis.Drive.v3.Data.File.Version
getset

A monotonically increasing version number for the file. This reflects every change made to the file on the server, even those not visible to the user.

◆ VideoMediaMetadata

virtual File.VideoMediaMetadataData Google.Apis.Drive.v3.Data.File.VideoMediaMetadata
getset

Additional metadata about video media. This may not be available immediately upon upload.

◆ ViewedByMe

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.ViewedByMe
getset

Whether the file has been viewed by this user.

◆ ViewedByMeTime

virtual System.Nullable<System.DateTime> Google.Apis.Drive.v3.Data.File.ViewedByMeTime
getset

See also
System.DateTime

representation of ViewedByMeTimeRaw.

◆ ViewedByMeTimeRaw

virtual string Google.Apis.Drive.v3.Data.File.ViewedByMeTimeRaw
getset

The last time the file was viewed by the user (RFC 3339 date-time).

◆ ViewersCanCopyContent

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.ViewersCanCopyContent
getset

Deprecated - use copyRequiresWriterPermission instead.

◆ WebContentLink

virtual string Google.Apis.Drive.v3.Data.File.WebContentLink
getset

A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.

◆ WebViewLink

virtual string Google.Apis.Drive.v3.Data.File.WebViewLink
getset

A link for opening the file in a relevant Google editor or viewer in a browser.

◆ WritersCanShare

virtual System.Nullable<bool> Google.Apis.Drive.v3.Data.File.WritersCanShare
getset

Whether users with only writer permission can modify the file's permissions. Not populated for items in shared drives.


The documentation for this class was generated from the following file: