source: vendor/google/apiclient-services/src/Books/Resource/LayersVolumeAnnotations.php

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

Upload project files

  • Property mode set to 100644
File size: 4.0 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\Books\Resource;
19
20use Google\Service\Books\Volumeannotation;
21use Google\Service\Books\Volumeannotations;
22
23/**
24 * The "volumeAnnotations" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $booksService = new Google\Service\Books(...);
28 * $volumeAnnotations = $booksService->layers_volumeAnnotations;
29 * </code>
30 */
31class LayersVolumeAnnotations extends \Google\Service\Resource
32{
33 /**
34 * Gets the volume annotation. (volumeAnnotations.get)
35 *
36 * @param string $volumeId The volume to retrieve annotations for.
37 * @param string $layerId The ID for the layer to get the annotations.
38 * @param string $annotationId The ID of the volume annotation to retrieve.
39 * @param array $optParams Optional parameters.
40 *
41 * @opt_param string locale The locale information for the data. ISO-639-1
42 * language and ISO-3166-1 country code. Ex: 'en_US'.
43 * @opt_param string source String to identify the originator of this request.
44 * @return Volumeannotation
45 * @throws \Google\Service\Exception
46 */
47 public function get($volumeId, $layerId, $annotationId, $optParams = [])
48 {
49 $params = ['volumeId' => $volumeId, 'layerId' => $layerId, 'annotationId' => $annotationId];
50 $params = array_merge($params, $optParams);
51 return $this->call('get', [$params], Volumeannotation::class);
52 }
53 /**
54 * Gets the volume annotations for a volume and layer.
55 * (volumeAnnotations.listLayersVolumeAnnotations)
56 *
57 * @param string $volumeId The volume to retrieve annotations for.
58 * @param string $layerId The ID for the layer to get the annotations.
59 * @param string $contentVersion The content version for the requested volume.
60 * @param array $optParams Optional parameters.
61 *
62 * @opt_param string endOffset The end offset to end retrieving data from.
63 * @opt_param string endPosition The end position to end retrieving data from.
64 * @opt_param string locale The locale information for the data. ISO-639-1
65 * language and ISO-3166-1 country code. Ex: 'en_US'.
66 * @opt_param string maxResults Maximum number of results to return
67 * @opt_param string pageToken The value of the nextToken from the previous
68 * page.
69 * @opt_param bool showDeleted Set to true to return deleted annotations.
70 * updatedMin must be in the request to use this. Defaults to false.
71 * @opt_param string source String to identify the originator of this request.
72 * @opt_param string startOffset The start offset to start retrieving data from.
73 * @opt_param string startPosition The start position to start retrieving data
74 * from.
75 * @opt_param string updatedMax RFC 3339 timestamp to restrict to items updated
76 * prior to this timestamp (exclusive).
77 * @opt_param string updatedMin RFC 3339 timestamp to restrict to items updated
78 * since this timestamp (inclusive).
79 * @opt_param string volumeAnnotationsVersion The version of the volume
80 * annotations that you are requesting.
81 * @return Volumeannotations
82 * @throws \Google\Service\Exception
83 */
84 public function listLayersVolumeAnnotations($volumeId, $layerId, $contentVersion, $optParams = [])
85 {
86 $params = ['volumeId' => $volumeId, 'layerId' => $layerId, 'contentVersion' => $contentVersion];
87 $params = array_merge($params, $optParams);
88 return $this->call('list', [$params], Volumeannotations::class);
89 }
90}
91
92// Adding a class alias for backwards compatibility with the previous class name.
93class_alias(LayersVolumeAnnotations::class, 'Google_Service_Books_Resource_LayersVolumeAnnotations');
Note: See TracBrowser for help on using the repository browser.