Google_TopicsServiceResource
The "topics" collection of methods.
Defined (1)
The class is defined in the following location(s).
- /google-api/src/contrib/Google_ModeratorService.php
- class Google_TopicsServiceResource extends Google_ServiceResource {
- /**
- * Inserts a new topic into the specified series. (topics.insert)
- *
- * @param string $seriesId The decimal ID of the Series.
- * @param Google_Topic $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Topic
- */
- public function insert($seriesId, Google_Topic $postBody, $optParams = array()) {
- $params = array('seriesId' => $seriesId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new Google_Topic($data);
- } else {
- return $data;
- }
- }
- /**
- * Searches the topics within the specified series and returns the search results. (topics.list)
- *
- * @param string $seriesId The decimal ID of the Series.
- * @param array $optParams Optional parameters.
- *
- * @opt_param string max-results Maximum number of results to return.
- * @opt_param string q Search query.
- * @opt_param string start-index Index of the first result to be retrieved.
- * @opt_param string mode
- * @return Google_TopicList
- */
- public function listTopics($seriesId, $optParams = array()) {
- $params = array('seriesId' => $seriesId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new Google_TopicList($data);
- } else {
- return $data;
- }
- }
- /**
- * Updates the specified topic within the specified series. (topics.update)
- *
- * @param string $seriesId The decimal ID of the Series.
- * @param string $topicId The decimal ID of the Topic within the Series.
- * @param Google_Topic $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Topic
- */
- public function update($seriesId, $topicId, Google_Topic $postBody, $optParams = array()) {
- $params = array('seriesId' => $seriesId, 'topicId' => $topicId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('update', array($params));
- if ($this->useObjects()) {
- return new Google_Topic($data);
- } else {
- return $data;
- }
- }
- /**
- * Returns the specified topic from the specified series. (topics.get)
- *
- * @param string $seriesId The decimal ID of the Series.
- * @param string $topicId The decimal ID of the Topic within the Series.
- * @param array $optParams Optional parameters.
- * @return Google_Topic
- */
- public function get($seriesId, $topicId, $optParams = array()) {
- $params = array('seriesId' => $seriesId, 'topicId' => $topicId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Google_Topic($data);
- } else {
- return $data;
- }
- }
- }