package gapi-ocaml

You can search for identifiers within the package.

in-package search v0.2.0

package gapi-ocaml

gapi-ocaml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `GapiDriveV3Model.File`Source

Sourcemodule LabelInfo : sig ... end

Sourcemodule LinkShareMetadata : sig ... end

Sourcemodule ShortcutDetails : sig ... end

Sourcemodule VideoMediaMetadata : sig ... end

Sourcemodule ImageMediaMetadata : sig ... end

Sourcemodule Capabilities : sig ... end

Sourcemodule ContentHints : sig ... end

Sourcetype t = {

kind : string;
(*
Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#file"`.
*)
driveId : string;
(*
Output only. ID of the shared drive the file resides in. Only populated for items in shared drives.
*)
fileExtension : string;
(*
Output only. The final component of `fullFileExtension`. This is only available for files with binary content in Google Drive.
*)
copyRequiresWriterPermission : bool;
(*
Whether the options to copy, print, or download this file, should be disabled for readers and commenters.
*)
md5Checksum : string;
(*
Output only. The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive.
*)
contentHints : ContentHints.t;
(*
Additional information about the content of the file. These fields are never populated in responses.
*)
writersCanShare : bool;
(*
Whether users with only `writer` permission can modify the file's permissions. Not populated for items in shared drives.
*)
viewedByMe : bool;
(*
Output only. Whether the file has been viewed by this user.
*)
mimeType : string;
(*
The MIME type of the file. Google Drive attempts 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 is imported, if possible. The supported import formats are published in the About resource.
*)
exportLinks : (string * string) list;
(*
Output only. Links for exporting Docs Editors files to specific formats.
*)
parents : string list;
(*
The ID of the parent folder containing the file. A file can only have one parent folder; specifying multiple parents isn't supported. If not specified as part of a create request, the file is placed directly in the user's My Drive folder. If not specified as part of a copy request, the file inherits any discoverable parent of the source file. Update requests must use the `addParents` and `removeParents` parameters to modify the parents list.
*)
thumbnailLink : string;
(*
Output only. A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Not intended for direct usage on web applications due to [Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) policies, consider using a proxy server. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in `Files.thumbnailLink` must be fetched using a credentialed request.
*)
iconLink : string;
(*
Output only. A static, unauthenticated link to the file's icon.
*)
shared : bool;
(*
Output only. Whether the file has been shared. Not populated for items in shared drives.
*)
lastModifyingUser : User.t;
(*
Output only. The last user to modify the file. This field is only populated when the last modification was performed by a signed-in user.
*)
owners : User.t list;
(*
Output only. The owner of this file. Only certain legacy files may have more than one owner. This field isn't populated for items in shared drives.
*)
headRevisionId : string;
(*
Output only. The ID of the file's head revision. This is currently only available for files with binary content in Google Drive.
*)
sharingUser : User.t;
(*
Output only. The user who shared the file with the requesting user, if applicable.
*)
webViewLink : string;
(*
Output only. A link for opening the file in a relevant Google editor or viewer in a browser.
*)
webContentLink : string;
(*
Output only. A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive.
*)
size : int64;
(*
Output only. Size in bytes of blobs and first party editor files. Won't be populated for files that have no size, like shortcuts and folders.
*)
viewersCanCopyContent : bool;
(*
Deprecated: Use `copyRequiresWriterPermission` instead.
*)
permissions : Permission.t list;
(*
Output only. 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.
*)
hasThumbnail : bool;
(*
Output only. 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.
*)
spaces : string list;
(*
Output only. The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'.
*)
folderColorRgb : string;
(*
The color for a folder or a shortcut to 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 is used instead.
*)
id : string;
(*
The ID of the file.
*)
name : string;
(*
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.
*)
description : string;
(*
A short description of the file.
*)
starred : bool;
(*
Whether the user has starred the file.
*)
trashed : bool;
(*
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.
*)
explicitlyTrashed : bool;
(*
Output only. Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder.
*)
createdTime : GapiDate.t;
(*
The time at which the file was created (RFC 3339 date-time).
*)
modifiedTime : GapiDate.t;
(*
he last time the file was modified by anyone (RFC 3339 date-time). Note that setting modifiedTime will also update modifiedByMeTime for the user.
*)
modifiedByMeTime : GapiDate.t;
(*
The last time the file was modified by the user (RFC 3339 date-time).
*)
viewedByMeTime : GapiDate.t;
(*
The last time the file was viewed by the user (RFC 3339 date-time).
*)
sharedWithMeTime : GapiDate.t;
(*
The time at which the file was shared with the user, if applicable (RFC 3339 date-time).
*)
quotaBytesUsed : int64;
(*
Output only. The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with `keepForever` enabled.
*)
version : int64;
(*
Output only. 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.
*)
originalFilename : string;
(*
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 : bool;
(*
Output only. Whether the user owns the file. Not populated for items in shared drives.
*)
fullFileExtension : string;
(*
Output only. 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.
*)
properties : (string * string) list;
(*
A collection of arbitrary key-value pairs which are visible to all apps. Entries with null values are cleared in update and copy requests.
*)
appProperties : (string * string) list;
(*
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. These properties can only be retrieved using an authenticated request. An authenticated request uses an access token obtained with a OAuth 2 client ID. You cannot use an API key to retrieve private properties.
*)
isAppAuthorized : bool;
(*
Output only. Whether the file was created or opened by the requesting app.
*)
teamDriveId : string;
(*
Deprecated: Output only. Use `driveId` instead.
*)
capabilities : Capabilities.t;
(*
Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.
*)
hasAugmentedPermissions : bool;
(*
Output only. Whether there are permissions directly on this file. This field is only populated for items in shared drives.
*)
trashingUser : User.t;
(*
Output only. If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives.
*)
thumbnailVersion : int64;
(*
Output only. The thumbnail version for use in thumbnail cache invalidation.
*)
trashedTime : GapiDate.t;
(*
The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives.
*)
modifiedByMe : bool;
(*
Output only. Whether the file has been modified by this user.
*)
permissionIds : string list;
(*
Output only. List of permission IDs for users with access to this file.
*)
imageMediaMetadata : ImageMediaMetadata.t;
(*
Output only. Additional metadata about image media, if available.
*)
videoMediaMetadata : VideoMediaMetadata.t;
(*
Output only. Additional metadata about video media. This may not be available immediately upon upload.
*)
shortcutDetails : ShortcutDetails.t;
(*
Shortcut file details. Only populated for shortcut files, which have the mimeType field set to `application/vnd.google-apps.shortcut`. Can only be set on `files.create` requests.
*)
contentRestrictions : ContentRestriction.t list;
(*
Restrictions for accessing the content of the file. Only populated if such a restriction exists.
*)
resourceKey : string;
(*
Output only. A key needed to access the item via a shared link.
*)
linkShareMetadata : LinkShareMetadata.t;
(*
Contains details about the link URLs that clients are using to refer to this item.
*)
labelInfo : LabelInfo.t;
(*
Output only. An overview of the labels on the file.
*)
sha1Checksum : string;
(*
Output only. The SHA1 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
*)
sha256Checksum : string;
(*
Output only. The SHA256 checksum associated with this file, if available. This field is only populated for files with content stored in Google Drive; it is not populated for Docs Editors or shortcut files.
*)
inheritedPermissionsDisabled : bool;
(*
Whether this file has inherited permissions disabled. Inherited permissions are enabled by default.
*)

}

Sourceval kind : (t, string) GapiLens.t

Sourceval driveId : (t, string) GapiLens.t

Sourceval fileExtension : (t, string) GapiLens.t

Sourceval copyRequiresWriterPermission : (t, bool) GapiLens.t

Sourceval md5Checksum : (t, string) GapiLens.t

Sourceval contentHints : (t, ContentHints.t) GapiLens.t

Sourceval writersCanShare : (t, bool) GapiLens.t

Sourceval viewedByMe : (t, bool) GapiLens.t

Sourceval mimeType : (t, string) GapiLens.t

Sourceval exportLinks : (t, (string * string) list) GapiLens.t

Sourceval parents : (t, string list) GapiLens.t

Sourceval thumbnailLink : (t, string) GapiLens.t

Sourceval iconLink : (t, string) GapiLens.t

Sourceval shared : (t, bool) GapiLens.t

Sourceval lastModifyingUser : (t, User.t) GapiLens.t

Sourceval owners : (t, User.t list) GapiLens.t

Sourceval headRevisionId : (t, string) GapiLens.t

Sourceval sharingUser : (t, User.t) GapiLens.t

Sourceval webViewLink : (t, string) GapiLens.t

Sourceval webContentLink : (t, string) GapiLens.t

Sourceval size : (t, int64) GapiLens.t

Sourceval viewersCanCopyContent : (t, bool) GapiLens.t

Sourceval permissions : (t, Permission.t list) GapiLens.t

Sourceval hasThumbnail : (t, bool) GapiLens.t

Sourceval spaces : (t, string list) GapiLens.t

Sourceval folderColorRgb : (t, string) GapiLens.t

Sourceval id : (t, string) GapiLens.t

Sourceval name : (t, string) GapiLens.t

Sourceval description : (t, string) GapiLens.t

Sourceval starred : (t, bool) GapiLens.t

Sourceval trashed : (t, bool) GapiLens.t

Sourceval explicitlyTrashed : (t, bool) GapiLens.t

Sourceval createdTime : (t, GapiDate.t) GapiLens.t

Sourceval modifiedTime : (t, GapiDate.t) GapiLens.t

Sourceval modifiedByMeTime : (t, GapiDate.t) GapiLens.t

Sourceval viewedByMeTime : (t, GapiDate.t) GapiLens.t

Sourceval sharedWithMeTime : (t, GapiDate.t) GapiLens.t

Sourceval quotaBytesUsed : (t, int64) GapiLens.t

Sourceval version : (t, int64) GapiLens.t

Sourceval originalFilename : (t, string) GapiLens.t

Sourceval ownedByMe : (t, bool) GapiLens.t

Sourceval fullFileExtension : (t, string) GapiLens.t

Sourceval properties : (t, (string * string) list) GapiLens.t

Sourceval appProperties : (t, (string * string) list) GapiLens.t

Sourceval isAppAuthorized : (t, bool) GapiLens.t

Sourceval teamDriveId : (t, string) GapiLens.t

Sourceval capabilities : (t, Capabilities.t) GapiLens.t

Sourceval hasAugmentedPermissions : (t, bool) GapiLens.t

Sourceval trashingUser : (t, User.t) GapiLens.t

Sourceval thumbnailVersion : (t, int64) GapiLens.t

Sourceval trashedTime : (t, GapiDate.t) GapiLens.t

Sourceval modifiedByMe : (t, bool) GapiLens.t

Sourceval permissionIds : (t, string list) GapiLens.t

Sourceval imageMediaMetadata : (t, ImageMediaMetadata.t) GapiLens.t

Sourceval videoMediaMetadata : (t, VideoMediaMetadata.t) GapiLens.t

Sourceval shortcutDetails : (t, ShortcutDetails.t) GapiLens.t

Sourceval contentRestrictions : (t, ContentRestriction.t list) GapiLens.t

Sourceval resourceKey : (t, string) GapiLens.t

Sourceval linkShareMetadata : (t, LinkShareMetadata.t) GapiLens.t

Sourceval labelInfo : (t, LabelInfo.t) GapiLens.t

Sourceval sha1Checksum : (t, string) GapiLens.t

Sourceval sha256Checksum : (t, string) GapiLens.t

Sourceval inheritedPermissionsDisabled : (t, bool) GapiLens.t

Sourceval empty : t

Sourceval render : t -> GapiJson.json_data_model list

Sourceval parse : t -> GapiJson.json_data_model -> t

Sourceval to_data_model : t -> GapiJson.json_data_model

Sourceval of_data_model : GapiJson.json_data_model -> t

package gapi-ocaml

Module GapiDriveV3Model.FileSource

Module `GapiDriveV3Model.File`Source