Google_ActivitiesServiceResource

The "activities" collection of methods.

Defined (2)

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

/inc/google-api-php-client/src/contrib/Google_PlusService.php  
  1. class Google_ActivitiesServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4. /** 
  5. * Search public activities. (activities.search) 
  6. * @param string $query Full-text search query string. 
  7. * @param array $optParams Optional parameters. 
  8. * @opt_param string orderBy Specifies how to order search results. 
  9. * @opt_param string pageToken The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token may be of any length. 
  10. * @opt_param string maxResults The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults. 
  11. * @opt_param string language Specify the preferred language to search with. See search language codes for available values. 
  12. * @return Google_ActivityFeed 
  13. */ 
  14. public function search($query, $optParams = array()) { 
  15. $params = array('query' => $query); 
  16. $params = array_merge($params, $optParams); 
  17. $data = $this->__call('search', array($params)); 
  18. if ($this->useObjects()) { 
  19. return new Google_ActivityFeed($data); 
  20. } else { 
  21. return $data; 
  22. /** 
  23. * List all of the activities in the specified collection for a particular user. (activities.list) 
  24. * @param string $userId The ID of the user to get activities for. The special value "me" can be used to indicate the authenticated user. 
  25. * @param string $collection The collection of activities to list. 
  26. * @param array $optParams Optional parameters. 
  27. * @opt_param string pageToken The continuation token, used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. 
  28. * @opt_param string maxResults The maximum number of activities to include in the response, used for paging. For any response, the actual number returned may be less than the specified maxResults. 
  29. * @return Google_ActivityFeed 
  30. */ 
  31. public function listActivities($userId, $collection, $optParams = array()) { 
  32. $params = array('userId' => $userId, 'collection' => $collection); 
  33. $params = array_merge($params, $optParams); 
  34. $data = $this->__call('list', array($params)); 
  35. if ($this->useObjects()) { 
  36. return new Google_ActivityFeed($data); 
  37. } else { 
  38. return $data; 
  39. /** 
  40. * Get an activity. (activities.get) 
  41. * @param string $activityId The ID of the activity to get. 
  42. * @param array $optParams Optional parameters. 
  43. * @return Google_Activity 
  44. */ 
  45. public function get($activityId, $optParams = array()) { 
  46. $params = array('activityId' => $activityId); 
  47. $params = array_merge($params, $optParams); 
  48. $data = $this->__call('get', array($params)); 
  49. if ($this->useObjects()) { 
  50. return new Google_Activity($data); 
  51. } else { 
  52. return $data; 
/inc/google-api-php-client/src/contrib/Google_OrkutService.php  
  1. class Google_ActivitiesServiceResource extends Google_ServiceResource { 
  2.  
  3.  
  4. /** 
  5. * Retrieves a list of activities. (activities.list) 
  6. * @param string $userId The ID of the user whose activities will be listed. Can be me to refer to the viewer (i.e. the authenticated user). 
  7. * @param string $collection The collection of activities to list. 
  8. * @param array $optParams Optional parameters. 
  9. * @opt_param string pageToken A continuation token that allows pagination. 
  10. * @opt_param string maxResults The maximum number of activities to include in the response. 
  11. * @opt_param string hl Specifies the interface language (host language) of your user interface. 
  12. * @return Google_ActivityList 
  13. */ 
  14. public function listActivities($userId, $collection, $optParams = array()) { 
  15. $params = array('userId' => $userId, 'collection' => $collection); 
  16. $params = array_merge($params, $optParams); 
  17. $data = $this->__call('list', array($params)); 
  18. if ($this->useObjects()) { 
  19. return new Google_ActivityList($data); 
  20. } else { 
  21. return $data; 
  22. /** 
  23. * Deletes an existing activity, if the access controls allow it. (activities.delete) 
  24. * @param string $activityId ID of the activity to remove. 
  25. * @param array $optParams Optional parameters. 
  26. */ 
  27. public function delete($activityId, $optParams = array()) { 
  28. $params = array('activityId' => $activityId); 
  29. $params = array_merge($params, $optParams); 
  30. $data = $this->__call('delete', array($params)); 
  31. return $data;