Skip to content

Commit ff6cd70

Browse files
1 parent 58bf973 commit ff6cd70

File tree

1 file changed

+22
-18
lines changed

1 file changed

+22
-18
lines changed

src/Drive/Resource/Files.php

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -303,11 +303,12 @@ public function get($fileId, $optParams = [])
303303
*
304304
* @param array $optParams Optional parameters.
305305
*
306-
* @opt_param string corpora Bodies of items (files or documents) to which the
307-
* query applies. Supported bodies are: * `user` * `domain` * `drive` *
308-
* `allDrives` Prefer `user` or `drive` to `allDrives` for efficiency. By
309-
* default, corpora is set to `user`. However, this can change depending on the
310-
* filter set through the `q` parameter. For more information, see [File
306+
* @opt_param string corpora Specifies a collection of items (files or
307+
* documents) to which the query applies. Supported items include: * `user` *
308+
* `domain` * `drive` * `allDrives` Prefer `user` or `drive` to `allDrives` for
309+
* efficiency. By default, corpora is set to `user`. However, this can change
310+
* depending on the filter set through the `q` parameter. For more information,
311+
* see [File
311312
* organization](https://developers.google.com/workspace/drive/api/guides/about-
312313
* files#file-organization).
313314
* @opt_param string corpus Deprecated: The source of files to list. Use
@@ -322,19 +323,22 @@ public function get($fileId, $optParams = [])
322323
* @opt_param bool includeTeamDriveItems Deprecated: Use
323324
* `includeItemsFromAllDrives` instead.
324325
* @opt_param string orderBy A comma-separated list of sort keys. Valid keys
325-
* are: * `createdTime`: When the file was created. * `folder`: The folder ID.
326-
* This field is sorted using alphabetical ordering. * `modifiedByMeTime`: The
327-
* last time the file was modified by the user. * `modifiedTime`: The last time
328-
* the file was modified by anyone. * `name`: The name of the file. This field
329-
* is sorted using alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The
330-
* name of the file. This field is sorted using natural sort ordering, so 1, 2,
331-
* 12, 22. * `quotaBytesUsed`: The number of storage quota bytes used by the
332-
* file. * `recency`: The most recent timestamp from the file's date-time
333-
* fields. * `sharedWithMeTime`: When the file was shared with the user, if
334-
* applicable. * `starred`: Whether the user has starred the file. *
335-
* `viewedByMeTime`: The last time the file was viewed by the user. Each key
336-
* sorts ascending by default, but can be reversed with the `desc` modifier.
337-
* Example usage: `?orderBy=folder,modifiedTime desc,name`.
326+
* are: * `createdTime`: When the file was created. Avoid using this key for
327+
* queries on large item collections as it might result in timeouts or other
328+
* issues. For time-related sorting on large item collections, use
329+
* `modifiedTime` instead. * `folder`: The folder ID. This field is sorted using
330+
* alphabetical ordering. * `modifiedByMeTime`: The last time the file was
331+
* modified by the user. * `modifiedTime`: The last time the file was modified
332+
* by anyone. * `name`: The name of the file. This field is sorted using
333+
* alphabetical ordering, so 1, 12, 2, 22. * `name_natural`: The name of the
334+
* file. This field is sorted using natural sort ordering, so 1, 2, 12, 22. *
335+
* `quotaBytesUsed`: The number of storage quota bytes used by the file. *
336+
* `recency`: The most recent timestamp from the file's date-time fields. *
337+
* `sharedWithMeTime`: When the file was shared with the user, if applicable. *
338+
* `starred`: Whether the user has starred the file. * `viewedByMeTime`: The
339+
* last time the file was viewed by the user. Each key sorts ascending by
340+
* default, but can be reversed with the `desc` modifier. Example usage:
341+
* `?orderBy=folder,modifiedTime desc,name`.
338342
* @opt_param int pageSize The maximum number of files to return per page.
339343
* Partial or empty result pages are possible even before the end of the files
340344
* list has been reached.

0 commit comments

Comments
 (0)