Google_TimelineServiceResource

The "timeline" collection of methods.

Defined (1)

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

/google-api-php-client/src/contrib/Google_MirrorService.php  
  1. class Google_TimelineServiceResource extends Google_ServiceResource { 
  2.  
  3. /** 
  4. * Deletes a timeline item. (timeline.delete) 
  5. * @param string $id The ID of the timeline item. 
  6. * @param array $optParams Optional parameters. 
  7. */ 
  8. public function delete($id, $optParams = array()) { 
  9. $params = array('id' => $id); 
  10. $params = array_merge($params, $optParams); 
  11. $data = $this->__call('delete', array($params)); 
  12. return $data; 
  13. /** 
  14. * Gets a single timeline item by ID. (timeline.get) 
  15. * @param string $id The ID of the timeline item. 
  16. * @param array $optParams Optional parameters. 
  17. * @return Google_TimelineItem 
  18. */ 
  19. public function get($id, $optParams = array()) { 
  20. $params = array('id' => $id); 
  21. $params = array_merge($params, $optParams); 
  22. $data = $this->__call('get', array($params)); 
  23. if ($this->useObjects()) { 
  24. return new Google_TimelineItem($data); 
  25. } else { 
  26. return $data; 
  27. /** 
  28. * Inserts a new item into the timeline. (timeline.insert) 
  29. * @param Google_TimelineItem $postBody 
  30. * @param array $optParams Optional parameters. 
  31. * @return Google_TimelineItem 
  32. */ 
  33. public function insert(Google_TimelineItem $postBody, $optParams = array()) { 
  34. $params = array('postBody' => $postBody); 
  35. $params = array_merge($params, $optParams); 
  36. $data = $this->__call('insert', array($params)); 
  37. if ($this->useObjects()) { 
  38. return new Google_TimelineItem($data); 
  39. } else { 
  40. return $data; 
  41. /** 
  42. * Retrieves a list of timeline items for the authenticated user. 
  43. * (timeline.list) 
  44. * @param array $optParams Optional parameters. 
  45. * @opt_param string bundleId If provided, only items with the given bundleId will be returned. 
  46. * @opt_param bool includeDeleted If true, tombstone records for deleted items will be returned. 
  47. * @opt_param string maxResults The maximum number of items to include in the response, used for paging. 
  48. * @opt_param string orderBy Controls the order in which timeline items are returned. 
  49. * @opt_param string pageToken Token for the page of results to return. 
  50. * @opt_param bool pinnedOnly If true, only pinned items will be returned. 
  51. * @opt_param string sourceItemId If provided, only items with the given sourceItemId will be returned. 
  52. * @return Google_TimelineListResponse 
  53. */ 
  54. public function listTimeline($optParams = array()) { 
  55. $params = array(); 
  56. $params = array_merge($params, $optParams); 
  57. $data = $this->__call('list', array($params)); 
  58. if ($this->useObjects()) { 
  59. return new Google_TimelineListResponse($data); 
  60. } else { 
  61. return $data; 
  62. /** 
  63. * Updates a timeline item in place. This method supports patch semantics. 
  64. * (timeline.patch) 
  65. * @param string $id The ID of the timeline item. 
  66. * @param Google_TimelineItem $postBody 
  67. * @param array $optParams Optional parameters. 
  68. * @return Google_TimelineItem 
  69. */ 
  70. public function patch($id, Google_TimelineItem $postBody, $optParams = array()) { 
  71. $params = array('id' => $id, 'postBody' => $postBody); 
  72. $params = array_merge($params, $optParams); 
  73. $data = $this->__call('patch', array($params)); 
  74. if ($this->useObjects()) { 
  75. return new Google_TimelineItem($data); 
  76. } else { 
  77. return $data; 
  78. /** 
  79. * Updates a timeline item in place. (timeline.update) 
  80. * @param string $id The ID of the timeline item. 
  81. * @param Google_TimelineItem $postBody 
  82. * @param array $optParams Optional parameters. 
  83. * @return Google_TimelineItem 
  84. */ 
  85. public function update($id, Google_TimelineItem $postBody, $optParams = array()) { 
  86. $params = array('id' => $id, 'postBody' => $postBody); 
  87. $params = array_merge($params, $optParams); 
  88. $data = $this->__call('update', array($params)); 
  89. if ($this->useObjects()) { 
  90. return new Google_TimelineItem($data); 
  91. } else { 
  92. return $data;