GoogleApi.Drive.V3.Api.Files.drive_files_list

You're seeing just the function drive_files_list, go back to GoogleApi.Drive.V3.Api.Files module for more information.
Link to this function

drive_files_list(connection, optional_params \\ [], opts \\ [])

View Source

Specs

drive_files_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Drive.V3.Model.FileList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists or searches files.

Parameters

  • connection (type: GoogleApi.Drive.V3.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :alt (type: String.t) - Data format for the response.
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
    • :corpora (type: String.t) - Groupings of files to which the query applies. Supported groupings are: 'user' (files created by, opened by, or shared directly with the user), 'drive' (files in the specified shared drive as indicated by the 'driveId'), 'domain' (files shared to the user's domain), and 'allDrives' (A combination of 'user' and 'drive' for all drives where the user is a member). When able, use 'user' or 'drive', instead of 'allDrives', for efficiency.
    • :corpus (type: String.t) - The source of files to list. Deprecated: use 'corpora' instead.
    • :driveId (type: String.t) - ID of the shared drive to search.
    • :includeItemsFromAllDrives (type: boolean()) - Whether both My Drive and shared drive items should be included in results.
    • :includePermissionsForView (type: String.t) - Specifies which additional view's permissions to include in the response. Only 'published' is supported.
    • :includeTeamDriveItems (type: boolean()) - Deprecated use includeItemsFromAllDrives instead.
    • :orderBy (type: String.t) - A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'. Each key sorts ascending by default, but may be reversed with the 'desc' modifier. Example usage: ?orderBy=folder,modifiedTime desc,name. Please note that there is a current limitation for users with approximately one million files in which the requested sort order is ignored.
    • :pageSize (type: integer()) - The maximum number of files to return per page. Partial or empty result pages are possible even before the end of the files list has been reached.
    • :pageToken (type: String.t) - The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
    • :q (type: String.t) - A query for filtering the file results. See the "Search for Files" guide for supported syntax.
    • :spaces (type: String.t) - A comma-separated list of spaces to query within the corpus. Supported values are 'drive', 'appDataFolder' and 'photos'.
    • :supportsAllDrives (type: boolean()) - Whether the requesting application supports both My Drives and shared drives.
    • :supportsTeamDrives (type: boolean()) - Deprecated use supportsAllDrives instead.
    • :teamDriveId (type: String.t) - Deprecated use driveId instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Drive.V3.Model.FileList{}} on success
  • {:error, info} on failure