Viewing file:  Ideas.php (2.7 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
<?php
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*/
namespace Google\Service\Ideahub\Resource;
use Google\Service\Ideahub\GoogleSearchIdeahubV1alphaListIdeasResponse;
/**
* The "ideas" collection of methods.
* Typical usage is:
* <code>
* $ideahubService = new Google\Service\Ideahub(...);
* $ideas = $ideahubService->ideas;
* </code>
*/
class Ideas extends \Google\Service\Resource
{
/**
* List ideas for a given Creator and filter and sort options. (ideas.listIdeas)
*
* @param array $optParams Optional parameters.
*
* @opt_param string filter Allows filtering. Supported syntax: * Filter
* expressions are made up of one or more restrictions. * Restrictions are
* implicitly combined, as if the `AND` operator was always used. The `OR`
* operator is currently unsupported. * Supported functions: - `saved(bool)`: If
* set to true, fetches only saved ideas. If set to false, fetches all except
* saved ideas. Can't be simultaneously used with `dismissed(bool)`. -
* `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can't be
* simultaneously used with `saved(bool)`. The `false` value is currently
* unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)`
* The length of this field should be no more than 500 characters.
* @opt_param string orderBy Order semantics described below.
* @opt_param int pageSize The maximum number of ideas per page. If unspecified,
* at most 10 ideas will be returned. The maximum value is 2000; values above
* 2000 will be coerced to 2000.
* @opt_param string pageToken Used to fetch next page.
* @opt_param string parent If defined, specifies the creator for which to
* filter by. Format: publishers/{publisher}/properties/{property}
* @return GoogleSearchIdeahubV1alphaListIdeasResponse
*/
public function listIdeas($optParams = [])
{
$params = [];
$params = array_merge($params, $optParams);
return $this->call('list', [$params], GoogleSearchIdeahubV1alphaListIdeasResponse::class);
}
}
// Adding a class alias for backwards compatibility with the previous class name.
class_alias(Ideas::class, 'Google_Service_Ideahub_Resource_Ideas');
|