Google_FilesServiceResource

The "files" collection of methods.

Defined (2)

The class is defined in the following location(s).

/google-api/src/contrib/Google_DfareportingService.php  
  1. class Google_FilesServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4.   /** 
  5.    * Lists files for a user profile. (files.list) 
  6.    * 
  7.    * @param string $profileId The DFA profile ID. 
  8.    * @param array $optParams Optional parameters. 
  9.    * 
  10.    * @opt_param int maxResults Maximum number of results to return. 
  11.    * @opt_param string pageToken The value of the nextToken from the previous result page. 
  12.    * @opt_param string sortField The field by which to sort the list. 
  13.    * @opt_param string sortOrder Order of sorted results, default is 'DESCENDING'. 
  14.    * @return Google_FileList 
  15.    */ 
  16.   public function listFiles($profileId, $optParams = array()) { 
  17.     $params = array('profileId' => $profileId); 
  18.     $params = array_merge($params, $optParams); 
  19.     $data = $this->__call('list', array($params)); 
  20.     if ($this->useObjects()) { 
  21.       return new Google_FileList($data); 
  22.     } else { 
  23.       return $data; 
  24.     } 
  25.   } 
  26. } 
/google-api/src/contrib/Google_DriveService.php  
  1. class Google_FilesServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4.   /** 
  5.    * Creates a copy of the specified file. (files.copy) 
  6.    * 
  7.    * @param string $fileId The ID of the file to copy. 
  8.    * @param Google_DriveFile $postBody 
  9.    * @param array $optParams Optional parameters. 
  10.    * 
  11.    * @opt_param bool convert Whether to convert this file to the corresponding Google Docs format. 
  12.    * @opt_param bool ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. 
  13.    * @opt_param string ocrLanguage If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes. 
  14.    * @opt_param bool pinned Whether to pin the head revision of the new copy. 
  15.    * @opt_param string timedTextLanguage The language of the timed text. 
  16.    * @opt_param string timedTextTrackName The timed text track name. 
  17.    * @return Google_DriveFile 
  18.    */ 
  19.   public function copy($fileId, Google_DriveFile $postBody, $optParams = array()) { 
  20.     $params = array('fileId' => $fileId, 'postBody' => $postBody); 
  21.     $params = array_merge($params, $optParams); 
  22.     $data = $this->__call('copy', array($params)); 
  23.     if ($this->useObjects()) { 
  24.       return new Google_DriveFile($data); 
  25.     } else { 
  26.       return $data; 
  27.     } 
  28.   } 
  29.   /** 
  30.    * Permanently deletes a file by ID. Skips the trash. (files.delete) 
  31.    * 
  32.    * @param string $fileId The ID of the file to delete. 
  33.    * @param array $optParams Optional parameters. 
  34.    */ 
  35.   public function delete($fileId, $optParams = array()) { 
  36.     $params = array('fileId' => $fileId); 
  37.     $params = array_merge($params, $optParams); 
  38.     $data = $this->__call('delete', array($params)); 
  39.     return $data; 
  40.   } 
  41.   /** 
  42.    * Gets a file's metadata by ID. (files.get) 
  43.    * 
  44.    * @param string $fileId The ID for the file in question. 
  45.    * @param array $optParams Optional parameters. 
  46.    * 
  47.    * @opt_param string projection This parameter is deprecated and has no function. 
  48.    * @opt_param bool updateViewedDate Whether to update the view date after successfully retrieving the file. 
  49.    * @return Google_DriveFile 
  50.    */ 
  51.   public function get($fileId, $optParams = array()) { 
  52.     $params = array('fileId' => $fileId); 
  53.     $params = array_merge($params, $optParams); 
  54.     $data = $this->__call('get', array($params)); 
  55.     if ($this->useObjects()) { 
  56.       return new Google_DriveFile($data); 
  57.     } else { 
  58.       return $data; 
  59.     } 
  60.   } 
  61.   /** 
  62.    * Insert a new file. (files.insert) 
  63.    * 
  64.    * @param Google_DriveFile $postBody 
  65.    * @param array $optParams Optional parameters. 
  66.    * 
  67.    * @opt_param bool convert Whether to convert this file to the corresponding Google Docs format. 
  68.    * @opt_param bool ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. 
  69.    * @opt_param string ocrLanguage If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes. 
  70.    * @opt_param bool pinned Whether to pin the head revision of the uploaded file. 
  71.    * @opt_param string timedTextLanguage The language of the timed text. 
  72.    * @opt_param string timedTextTrackName The timed text track name. 
  73.    * @opt_param bool useContentAsIndexableText Whether to use the content as indexable text. 
  74.    * @return Google_DriveFile 
  75.    */ 
  76.   public function insert(Google_DriveFile $postBody, $optParams = array()) { 
  77.     $params = array('postBody' => $postBody); 
  78.     $params = array_merge($params, $optParams); 
  79.     $data = $this->__call('insert', array($params)); 
  80.     if ($this->useObjects()) { 
  81.       return new Google_DriveFile($data); 
  82.     } else { 
  83.       return $data; 
  84.     } 
  85.   } 
  86.   /** 
  87.    * Lists the user's files. (files.list) 
  88.    * 
  89.    * @param array $optParams Optional parameters. 
  90.    * 
  91.    * @opt_param int maxResults Maximum number of files to return. 
  92.    * @opt_param string pageToken Page token for files. 
  93.    * @opt_param string projection This parameter is deprecated and has no function. 
  94.    * @opt_param string q Query string for searching files. 
  95.    * @return Google_FileList 
  96.    */ 
  97.   public function listFiles($optParams = array()) { 
  98.     $params = array(); 
  99.     $params = array_merge($params, $optParams); 
  100.     $data = $this->__call('list', array($params)); 
  101.     if ($this->useObjects()) { 
  102.       return new Google_FileList($data); 
  103.     } else { 
  104.       return $data; 
  105.     } 
  106.   } 
  107.   /** 
  108.    * Updates file metadata and/or content. This method supports patch semantics. (files.patch) 
  109.    * 
  110.    * @param string $fileId The ID of the file to update. 
  111.    * @param Google_DriveFile $postBody 
  112.    * @param array $optParams Optional parameters. 
  113.    * 
  114.    * @opt_param bool convert Whether to convert this file to the corresponding Google Docs format. 
  115.    * @opt_param bool newRevision Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision is replaced. If true, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota). 
  116.    * @opt_param bool ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. 
  117.    * @opt_param string ocrLanguage If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes. 
  118.    * @opt_param bool pinned Whether to pin the new revision. 
  119.    * @opt_param bool setModifiedDate Whether to set the modified date with the supplied modified date. 
  120.    * @opt_param string timedTextLanguage The language of the timed text. 
  121.    * @opt_param string timedTextTrackName The timed text track name. 
  122.    * @opt_param bool updateViewedDate Whether to update the view date after successfully updating the file. 
  123.    * @opt_param bool useContentAsIndexableText Whether to use the content as indexable text. 
  124.    * @return Google_DriveFile 
  125.    */ 
  126.   public function patch($fileId, Google_DriveFile $postBody, $optParams = array()) { 
  127.     $params = array('fileId' => $fileId, 'postBody' => $postBody); 
  128.     $params = array_merge($params, $optParams); 
  129.     $data = $this->__call('patch', array($params)); 
  130.     if ($this->useObjects()) { 
  131.       return new Google_DriveFile($data); 
  132.     } else { 
  133.       return $data; 
  134.     } 
  135.   } 
  136.   /** 
  137.    * Set the file's updated time to the current server time. (files.touch) 
  138.    * 
  139.    * @param string $fileId The ID of the file to update. 
  140.    * @param array $optParams Optional parameters. 
  141.    * @return Google_DriveFile 
  142.    */ 
  143.   public function touch($fileId, $optParams = array()) { 
  144.     $params = array('fileId' => $fileId); 
  145.     $params = array_merge($params, $optParams); 
  146.     $data = $this->__call('touch', array($params)); 
  147.     if ($this->useObjects()) { 
  148.       return new Google_DriveFile($data); 
  149.     } else { 
  150.       return $data; 
  151.     } 
  152.   } 
  153.   /** 
  154.    * Moves a file to the trash. (files.trash) 
  155.    * 
  156.    * @param string $fileId The ID of the file to trash. 
  157.    * @param array $optParams Optional parameters. 
  158.    * @return Google_DriveFile 
  159.    */ 
  160.   public function trash($fileId, $optParams = array()) { 
  161.     $params = array('fileId' => $fileId); 
  162.     $params = array_merge($params, $optParams); 
  163.     $data = $this->__call('trash', array($params)); 
  164.     if ($this->useObjects()) { 
  165.       return new Google_DriveFile($data); 
  166.     } else { 
  167.       return $data; 
  168.     } 
  169.   } 
  170.   /** 
  171.    * Restores a file from the trash. (files.untrash) 
  172.    * 
  173.    * @param string $fileId The ID of the file to untrash. 
  174.    * @param array $optParams Optional parameters. 
  175.    * @return Google_DriveFile 
  176.    */ 
  177.   public function untrash($fileId, $optParams = array()) { 
  178.     $params = array('fileId' => $fileId); 
  179.     $params = array_merge($params, $optParams); 
  180.     $data = $this->__call('untrash', array($params)); 
  181.     if ($this->useObjects()) { 
  182.       return new Google_DriveFile($data); 
  183.     } else { 
  184.       return $data; 
  185.     } 
  186.   } 
  187.   /** 
  188.    * Updates file metadata and/or content. (files.update) 
  189.    * 
  190.    * @param string $fileId The ID of the file to update. 
  191.    * @param Google_DriveFile $postBody 
  192.    * @param array $optParams Optional parameters. 
  193.    * 
  194.    * @opt_param bool convert Whether to convert this file to the corresponding Google Docs format. 
  195.    * @opt_param bool newRevision Whether a blob upload should create a new revision. If not set or false, the blob data in the current head revision is replaced. If true, a new blob is created as head revision, and previous revisions are preserved (causing increased use of the user's data storage quota). 
  196.    * @opt_param bool ocr Whether to attempt OCR on .jpg, .png, .gif, or .pdf uploads. 
  197.    * @opt_param string ocrLanguage If ocr is true, hints at the language to use. Valid values are ISO 639-1 codes. 
  198.    * @opt_param bool pinned Whether to pin the new revision. 
  199.    * @opt_param bool setModifiedDate Whether to set the modified date with the supplied modified date. 
  200.    * @opt_param string timedTextLanguage The language of the timed text. 
  201.    * @opt_param string timedTextTrackName The timed text track name. 
  202.    * @opt_param bool updateViewedDate Whether to update the view date after successfully updating the file. 
  203.    * @opt_param bool useContentAsIndexableText Whether to use the content as indexable text. 
  204.    * @return Google_DriveFile 
  205.    */ 
  206.   public function update($fileId, Google_DriveFile $postBody, $optParams = array()) { 
  207.     $params = array('fileId' => $fileId, 'postBody' => $postBody); 
  208.     $params = array_merge($params, $optParams); 
  209.     $data = $this->__call('update', array($params)); 
  210.     if ($this->useObjects()) { 
  211.       return new Google_DriveFile($data); 
  212.     } else { 
  213.       return $data; 
  214.     } 
  215.   } 
  216. }