[e3d4e0a] | 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 |
|
---|
| 18 | namespace Google\Service\Pollen\Resource;
|
---|
| 19 |
|
---|
| 20 | use Google\Service\Pollen\LookupForecastResponse;
|
---|
| 21 |
|
---|
| 22 | /**
|
---|
| 23 | * The "forecast" collection of methods.
|
---|
| 24 | * Typical usage is:
|
---|
| 25 | * <code>
|
---|
| 26 | * $pollenService = new Google\Service\Pollen(...);
|
---|
| 27 | * $forecast = $pollenService->forecast;
|
---|
| 28 | * </code>
|
---|
| 29 | */
|
---|
| 30 | class Forecast extends \Google\Service\Resource
|
---|
| 31 | {
|
---|
| 32 | /**
|
---|
| 33 | * Returns up to 5 days of daily pollen information in more than 65 countries,
|
---|
| 34 | * up to 1km resolution. (forecast.lookup)
|
---|
| 35 | *
|
---|
| 36 | * @param array $optParams Optional parameters.
|
---|
| 37 | *
|
---|
| 38 | * @opt_param int days Required. A number that indicates how many forecast days
|
---|
| 39 | * to request (minimum value 1, maximum value is 5).
|
---|
| 40 | * @opt_param string languageCode Optional. Allows the client to choose the
|
---|
| 41 | * language for the response. If data cannot be provided for that language, the
|
---|
| 42 | * API uses the closest match. Allowed values rely on the IETF BCP-47 standard.
|
---|
| 43 | * The default value is "en".
|
---|
| 44 | * @opt_param double location.latitude The latitude in degrees. It must be in
|
---|
| 45 | * the range [-90.0, +90.0].
|
---|
| 46 | * @opt_param double location.longitude The longitude in degrees. It must be in
|
---|
| 47 | * the range [-180.0, +180.0].
|
---|
| 48 | * @opt_param int pageSize Optional. The maximum number of daily info records to
|
---|
| 49 | * return per page. The default and max value is 5, indicating 5 days of data.
|
---|
| 50 | * @opt_param string pageToken Optional. A page token received from a previous
|
---|
| 51 | * daily call. It is used to retrieve the subsequent page. Note that when
|
---|
| 52 | * providing a value for the page token, all other request parameters provided
|
---|
| 53 | * must match the previous call that provided the page token.
|
---|
| 54 | * @opt_param bool plantsDescription Optional. Contains general information
|
---|
| 55 | * about plants, including details on their seasonality, special shapes and
|
---|
| 56 | * colors, information about allergic cross-reactions, and plant photos. The
|
---|
| 57 | * default value is "true".
|
---|
| 58 | * @return LookupForecastResponse
|
---|
| 59 | * @throws \Google\Service\Exception
|
---|
| 60 | */
|
---|
| 61 | public function lookup($optParams = [])
|
---|
| 62 | {
|
---|
| 63 | $params = [];
|
---|
| 64 | $params = array_merge($params, $optParams);
|
---|
| 65 | return $this->call('lookup', [$params], LookupForecastResponse::class);
|
---|
| 66 | }
|
---|
| 67 | }
|
---|
| 68 |
|
---|
| 69 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
| 70 | class_alias(Forecast::class, 'Google_Service_Pollen_Resource_Forecast');
|
---|