package gapi-ocaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module VideoMediaMetadata : sig ... end
module Thumbnail : sig ... end
module Labels : sig ... end
module IndexableText : sig ... end
module ImageMediaMetadata : sig ... end
type t = {
  1. appDataContents : bool;
    (*

    Whether this file is in the Application Data folder.

    *)
  2. canComment : bool;
    (*

    Whether the current user can comment on the file.

    *)
  3. canReadRevisions : bool;
    (*

    Whether the current user has read access to the Revisions resource of the file.

    *)
  4. copyable : bool;
    (*

    Whether the file can be copied by the current user.

    *)
  5. createdDate : GapiDate.t;
    (*

    Create time for this file (formatted RFC 3339 timestamp).

    *)
  6. description : string;
    (*

    A short description of the file.

    *)
  7. downloadUrl : string;
  8. editable : bool;
    (*

    Whether the file can be edited by the current user.

    *)
  9. etag : string;
    (*

    ETag of the file.

    *)
  10. explicitlyTrashed : bool;
    (*

    Whether this file has been explicitly trashed, as opposed to recursively trashed.

    *)
  11. fileExtension : string;
    (*

    The final component of fullFileExtension with trailing text that does not appear to be part of the extension removed. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.

    *)
  12. fileSize : int64;
    (*

    The size of the file in bytes. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.

    *)
  13. folderColorRgb : string;
    (*

    Folder color as an RGB hex string if the file is a folder. The list of supported colors is available in the folderColorPalette field of the About resource. If an unsupported color is specified, it will be changed to the closest color in the palette.

    *)
  14. fullFileExtension : string;
    (*

    The full file extension; extracted from the title. May contain multiple concatenated extensions, such as "tar.gz". Removing an extension from the title does not clear this field; however, changing the extension on the title does update this field. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.

    *)
  15. headRevisionId : string;
    (*

    The ID of the file's head revision. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.

    *)
  16. id : string;
    (*

    The ID of the file.

    *)
  17. imageMediaMetadata : ImageMediaMetadata.t;
    (*

    Metadata about image media. This will only be present for image types, and its contents will depend on what can be parsed from the image content.

    *)
  18. indexableText : IndexableText.t;
    (*

    Indexable text attributes for the file (can only be written)

    *)
  19. isAppAuthorized : bool;
    (*

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

    *)
  20. kind : string;
    (*

    The type of file. This is always drive#file.

    *)
  21. labels : Labels.t;
    (*

    A group of labels for the file.

    *)
  22. lastModifyingUser : User.t;
    (*

    The last user to modify this file.

    *)
  23. lastModifyingUserName : string;
    (*

    Name of the last user to modify this file.

    *)
  24. lastViewedByMeDate : GapiDate.t;
    (*

    Last time this file was viewed by the user (formatted RFC 3339 timestamp).

    *)
  25. markedViewedByMeDate : GapiDate.t;
    (*

    Deprecated.

    *)
  26. md5Checksum : string;
    (*

    An MD5 checksum for the content of this file. This field is only populated for files with content stored in Drive; it is not populated for Google Docs or shortcut files.

    *)
  27. mimeType : string;
    (*

    The MIME type of the file. This is only mutable on update when uploading new content. This field can be left blank, and the mimetype will be determined from the uploaded content's MIME type.

    *)
  28. modifiedByMeDate : GapiDate.t;
    (*

    Last time this file was modified by the user (formatted RFC 3339 timestamp). Note that setting modifiedDate will also update the modifiedByMe date for the user which set the date.

    *)
  29. modifiedDate : GapiDate.t;
    (*

    Last time this file was modified by anyone (formatted RFC 3339 timestamp). This is only mutable on update when the setModifiedDate parameter is set.

    *)
  30. originalFilename : string;
    (*

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

    *)
  31. ownedByMe : bool;
    (*

    Whether the file is owned by the current user.

    *)
  32. ownerNames : string list;
    (*

    Name(s) of the owner(s) of this file.

    *)
  33. owners : User.t list;
    (*

    The owner(s) of this file.

    *)
  34. parents : ParentReference.t list;
    (*

    Collection of parent folders which contain this file. Setting this field will put the file in all of the provided folders. On insert, if no folders are provided, the file will be placed in the default root folder.

    *)
  35. permissions : Permission.t list;
    (*

    The list of permissions for users with access to this file.

    *)
  36. properties : Property.t list;
    (*

    The list of properties.

    *)
  37. quotaBytesUsed : int64;
    (*

    The number of quota bytes used by this file.

    *)
  38. shareable : bool;
    (*

    Whether the file's sharing settings can be modified by the current user.

    *)
  39. shared : bool;
    (*

    Whether the file has been shared.

    *)
  40. sharedWithMeDate : GapiDate.t;
    (*

    Time at which this file was shared with the user (formatted RFC 3339 timestamp).

    *)
  41. sharingUser : User.t;
    (*

    User that shared the item with the current user, if available.

    *)
  42. spaces : string list;
    (*

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

    *)
  43. thumbnail : Thumbnail.t;
    (*

    Thumbnail for the file. Only accepted on upload and for files that are not already thumbnailed by Google.

    *)
  44. title : string;
    (*

    The title of this file.

    *)
  45. userPermission : Permission.t;
    (*

    The permissions for the authenticated user on this file.

    *)
  46. version : int64;
    (*

    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 requesting user.

    *)
  47. videoMediaMetadata : VideoMediaMetadata.t;
    (*

    Metadata about video media. This will only be present for video types.

    *)
  48. writersCanShare : bool;
    (*

    Whether writers can share the document with other users.

    *)
}
val appDataContents : (t, bool) GapiLens.t
val canComment : (t, bool) GapiLens.t
val canReadRevisions : (t, bool) GapiLens.t
val copyable : (t, bool) GapiLens.t
val createdDate : (t, GapiDate.t) GapiLens.t
val description : (t, string) GapiLens.t
val downloadUrl : (t, string) GapiLens.t
val editable : (t, bool) GapiLens.t
val etag : (t, string) GapiLens.t
val explicitlyTrashed : (t, bool) GapiLens.t
val fileExtension : (t, string) GapiLens.t
val fileSize : (t, int64) GapiLens.t
val folderColorRgb : (t, string) GapiLens.t
val fullFileExtension : (t, string) GapiLens.t
val headRevisionId : (t, string) GapiLens.t
val id : (t, string) GapiLens.t
val imageMediaMetadata : (t, ImageMediaMetadata.t) GapiLens.t
val indexableText : (t, IndexableText.t) GapiLens.t
val isAppAuthorized : (t, bool) GapiLens.t
val kind : (t, string) GapiLens.t
val labels : (t, Labels.t) GapiLens.t
val lastModifyingUser : (t, User.t) GapiLens.t
val lastModifyingUserName : (t, string) GapiLens.t
val lastViewedByMeDate : (t, GapiDate.t) GapiLens.t
val markedViewedByMeDate : (t, GapiDate.t) GapiLens.t
val md5Checksum : (t, string) GapiLens.t
val mimeType : (t, string) GapiLens.t
val modifiedByMeDate : (t, GapiDate.t) GapiLens.t
val modifiedDate : (t, GapiDate.t) GapiLens.t
val originalFilename : (t, string) GapiLens.t
val ownedByMe : (t, bool) GapiLens.t
val ownerNames : (t, string list) GapiLens.t
val owners : (t, User.t list) GapiLens.t
val parents : (t, ParentReference.t list) GapiLens.t
val permissions : (t, Permission.t list) GapiLens.t
val properties : (t, Property.t list) GapiLens.t
val quotaBytesUsed : (t, int64) GapiLens.t
val shareable : (t, bool) GapiLens.t
val shared : (t, bool) GapiLens.t
val sharedWithMeDate : (t, GapiDate.t) GapiLens.t
val sharingUser : (t, User.t) GapiLens.t
val spaces : (t, string list) GapiLens.t
val thumbnail : (t, Thumbnail.t) GapiLens.t
val title : (t, string) GapiLens.t
val userPermission : (t, Permission.t) GapiLens.t
val version : (t, int64) GapiLens.t
val videoMediaMetadata : (t, VideoMediaMetadata.t) GapiLens.t
val writersCanShare : (t, bool) GapiLens.t
val empty : t
val render : t -> GapiJson.json_data_model list
val parse : t -> GapiJson.json_data_model -> t
val to_data_model : t -> GapiJson.json_data_model
val of_data_model : GapiJson.json_data_model -> t
OCaml

Innovation. Community. Security.