Google_SeriesServiceResource
The "series" collection of methods.
Defined (1)
The class is defined in the following location(s).
- /google-api-php-client/src/contrib/Google_ModeratorService.php
- class Google_SeriesServiceResource extends Google_ServiceResource {
- /**
- * Inserts a new series. (series.insert)
- *
- * @param Google_Series $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Series
- */
- public function insert(Google_Series $postBody, $optParams = array()) {
- $params = array('postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('insert', array($params));
- if ($this->useObjects()) {
- return new Google_Series($data);
- } else {
- return $data;
- }
- }
- /**
- * Updates the specified series. This method supports patch semantics. (series.patch)
- *
- * @param string $seriesId The decimal ID of the Series.
- * @param Google_Series $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Series
- */
- public function patch($seriesId, Google_Series $postBody, $optParams = array()) {
- $params = array('seriesId' => $seriesId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('patch', array($params));
- if ($this->useObjects()) {
- return new Google_Series($data);
- } else {
- return $data;
- }
- }
- /**
- * Searches the series and returns the search results. (series.list)
- *
- * @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.
- * @return Google_SeriesList
- */
- public function listSeries($optParams = array()) {
- $params = array();
- $params = array_merge($params, $optParams);
- $data = $this->__call('list', array($params));
- if ($this->useObjects()) {
- return new Google_SeriesList($data);
- } else {
- return $data;
- }
- }
- /**
- * Updates the specified series. (series.update)
- *
- * @param string $seriesId The decimal ID of the Series.
- * @param Google_Series $postBody
- * @param array $optParams Optional parameters.
- * @return Google_Series
- */
- public function update($seriesId, Google_Series $postBody, $optParams = array()) {
- $params = array('seriesId' => $seriesId, 'postBody' => $postBody);
- $params = array_merge($params, $optParams);
- $data = $this->__call('update', array($params));
- if ($this->useObjects()) {
- return new Google_Series($data);
- } else {
- return $data;
- }
- }
- /**
- * Returns the specified series. (series.get)
- *
- * @param string $seriesId The decimal ID of the Series.
- * @param array $optParams Optional parameters.
- * @return Google_Series
- */
- public function get($seriesId, $optParams = array()) {
- $params = array('seriesId' => $seriesId);
- $params = array_merge($params, $optParams);
- $data = $this->__call('get', array($params));
- if ($this->useObjects()) {
- return new Google_Series($data);
- } else {
- return $data;
- }
- }
- }