source: vendor/google/apiclient-services/src/Ideahub/Resource/Ideas.php

Last change on this file was e3d4e0a, checked in by Vlado 222039 <vlado.popovski@…>, 2 weeks ago

Upload project files

  • Property mode set to 100644
File size: 2.7 KB
Line 
1<?php
2/*
3 * Copyright 2014 Google Inc.
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
6 * use this file except in compliance with the License. You may obtain a copy of
7 * the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14 * License for the specific language governing permissions and limitations under
15 * the License.
16 */
17
18namespace Google\Service\Ideahub\Resource;
19
20use Google\Service\Ideahub\GoogleSearchIdeahubV1alphaListIdeasResponse;
21
22/**
23 * The "ideas" collection of methods.
24 * Typical usage is:
25 * <code>
26 * $ideahubService = new Google\Service\Ideahub(...);
27 * $ideas = $ideahubService->ideas;
28 * </code>
29 */
30class Ideas extends \Google\Service\Resource
31{
32 /**
33 * List ideas for a given Creator and filter and sort options. (ideas.listIdeas)
34 *
35 * @param array $optParams Optional parameters.
36 *
37 * @opt_param string filter Allows filtering. Supported syntax: * Filter
38 * expressions are made up of one or more restrictions. * Restrictions are
39 * implicitly combined, as if the `AND` operator was always used. The `OR`
40 * operator is currently unsupported. * Supported functions: - `saved(bool)`: If
41 * set to true, fetches only saved ideas. If set to false, fetches all except
42 * saved ideas. Can't be simultaneously used with `dismissed(bool)`. -
43 * `dismissed(bool)`: If set to true, fetches only dismissed ideas. Can't be
44 * simultaneously used with `saved(bool)`. The `false` value is currently
45 * unsupported. Examples: * `saved(true)` * `saved(false)` * `dismissed(true)`
46 * The length of this field should be no more than 500 characters.
47 * @opt_param string orderBy Order semantics described below.
48 * @opt_param int pageSize The maximum number of ideas per page. If unspecified,
49 * at most 10 ideas will be returned. The maximum value is 2000; values above
50 * 2000 will be coerced to 2000.
51 * @opt_param string pageToken Used to fetch next page.
52 * @opt_param string parent If defined, specifies the creator for which to
53 * filter by. Format: publishers/{publisher}/properties/{property}
54 * @return GoogleSearchIdeahubV1alphaListIdeasResponse
55 */
56 public function listIdeas($optParams = [])
57 {
58 $params = [];
59 $params = array_merge($params, $optParams);
60 return $this->call('list', [$params], GoogleSearchIdeahubV1alphaListIdeasResponse::class);
61 }
62}
63
64// Adding a class alias for backwards compatibility with the previous class name.
65class_alias(Ideas::class, 'Google_Service_Ideahub_Resource_Ideas');
Note: See TracBrowser for help on using the repository browser.