Google_PropertiesServiceResource

The "properties" collection of methods.

Defined (1)

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

/gdwpm-api/contrib/Google_DriveService.php  
  1. class Google_PropertiesServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Deletes a property. (properties.delete) 
  5. * @param string $fileId The ID of the file. 
  6. * @param string $propertyKey The key of the property. 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string visibility The visibility of the property. 
  9. */ 
  10. public function delete($fileId, $propertyKey, $optParams = array()) { 
  11. $params = array('fileId' => $fileId, 'propertyKey' => $propertyKey); 
  12. $params = array_merge($params, $optParams); 
  13. $data = $this->__call('delete', array($params)); 
  14. return $data; 
  15. /** 
  16. * Gets a property by its key. (properties.get) 
  17. * @param string $fileId The ID of the file. 
  18. * @param string $propertyKey The key of the property. 
  19. * @param array $optParams Optional parameters. 
  20. * @opt_param string visibility The visibility of the property. 
  21. * @return Google_Property 
  22. */ 
  23. public function get($fileId, $propertyKey, $optParams = array()) { 
  24. $params = array('fileId' => $fileId, 'propertyKey' => $propertyKey); 
  25. $params = array_merge($params, $optParams); 
  26. $data = $this->__call('get', array($params)); 
  27. if ($this->useObjects()) { 
  28. return new Google_Property($data); 
  29. } else { 
  30. return $data; 
  31. /** 
  32. * Adds a property to a file. (properties.insert) 
  33. * @param string $fileId The ID of the file. 
  34. * @param Google_Property $postBody 
  35. * @param array $optParams Optional parameters. 
  36. * @return Google_Property 
  37. */ 
  38. public function insert($fileId, Google_Property $postBody, $optParams = array()) { 
  39. $params = array('fileId' => $fileId, 'postBody' => $postBody); 
  40. $params = array_merge($params, $optParams); 
  41. $data = $this->__call('insert', array($params)); 
  42. if ($this->useObjects()) { 
  43. return new Google_Property($data); 
  44. } else { 
  45. return $data; 
  46. /** 
  47. * Lists a file's properties. (properties.list) 
  48. * @param string $fileId The ID of the file. 
  49. * @param array $optParams Optional parameters. 
  50. * @return Google_PropertyList 
  51. */ 
  52. public function listProperties($fileId, $optParams = array()) { 
  53. $params = array('fileId' => $fileId); 
  54. $params = array_merge($params, $optParams); 
  55. $data = $this->__call('list', array($params)); 
  56. if ($this->useObjects()) { 
  57. return new Google_PropertyList($data); 
  58. } else { 
  59. return $data; 
  60. /** 
  61. * Updates a property. This method supports patch semantics. (properties.patch) 
  62. * @param string $fileId The ID of the file. 
  63. * @param string $propertyKey The key of the property. 
  64. * @param Google_Property $postBody 
  65. * @param array $optParams Optional parameters. 
  66. * @opt_param string visibility The visibility of the property. 
  67. * @return Google_Property 
  68. */ 
  69. public function patch($fileId, $propertyKey, Google_Property $postBody, $optParams = array()) { 
  70. $params = array('fileId' => $fileId, 'propertyKey' => $propertyKey, 'postBody' => $postBody); 
  71. $params = array_merge($params, $optParams); 
  72. $data = $this->__call('patch', array($params)); 
  73. if ($this->useObjects()) { 
  74. return new Google_Property($data); 
  75. } else { 
  76. return $data; 
  77. /** 
  78. * Updates a property. (properties.update) 
  79. * @param string $fileId The ID of the file. 
  80. * @param string $propertyKey The key of the property. 
  81. * @param Google_Property $postBody 
  82. * @param array $optParams Optional parameters. 
  83. * @opt_param string visibility The visibility of the property. 
  84. * @return Google_Property 
  85. */ 
  86. public function update($fileId, $propertyKey, Google_Property $postBody, $optParams = array()) { 
  87. $params = array('fileId' => $fileId, 'propertyKey' => $propertyKey, 'postBody' => $postBody); 
  88. $params = array_merge($params, $optParams); 
  89. $data = $this->__call('update', array($params)); 
  90. if ($this->useObjects()) { 
  91. return new Google_Property($data); 
  92. } else { 
  93. return $data;