source: vendor/google/apiclient-services/src/Books/Resource/Familysharing.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: 2.9 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\BooksEmpty;
21use Google\Service\Books\FamilyInfo;
22
23/**
24 * The "familysharing" collection of methods.
25 * Typical usage is:
26 * <code>
27 * $booksService = new Google\Service\Books(...);
28 * $familysharing = $booksService->familysharing;
29 * </code>
30 */
31class Familysharing extends \Google\Service\Resource
32{
33 /**
34 * Gets information regarding the family that the user is part of.
35 * (familysharing.getFamilyInfo)
36 *
37 * @param array $optParams Optional parameters.
38 *
39 * @opt_param string source String to identify the originator of this request.
40 * @return FamilyInfo
41 * @throws \Google\Service\Exception
42 */
43 public function getFamilyInfo($optParams = [])
44 {
45 $params = [];
46 $params = array_merge($params, $optParams);
47 return $this->call('getFamilyInfo', [$params], FamilyInfo::class);
48 }
49 /**
50 * Initiates sharing of the content with the user's family. Empty response
51 * indicates success. (familysharing.share)
52 *
53 * @param array $optParams Optional parameters.
54 *
55 * @opt_param string docId The docid to share.
56 * @opt_param string source String to identify the originator of this request.
57 * @opt_param string volumeId The volume to share.
58 * @return BooksEmpty
59 * @throws \Google\Service\Exception
60 */
61 public function share($optParams = [])
62 {
63 $params = [];
64 $params = array_merge($params, $optParams);
65 return $this->call('share', [$params], BooksEmpty::class);
66 }
67 /**
68 * Initiates revoking content that has already been shared with the user's
69 * family. Empty response indicates success. (familysharing.unshare)
70 *
71 * @param array $optParams Optional parameters.
72 *
73 * @opt_param string docId The docid to unshare.
74 * @opt_param string source String to identify the originator of this request.
75 * @opt_param string volumeId The volume to unshare.
76 * @return BooksEmpty
77 * @throws \Google\Service\Exception
78 */
79 public function unshare($optParams = [])
80 {
81 $params = [];
82 $params = array_merge($params, $optParams);
83 return $this->call('unshare', [$params], BooksEmpty::class);
84 }
85}
86
87// Adding a class alias for backwards compatibility with the previous class name.
88class_alias(Familysharing::class, 'Google_Service_Books_Resource_Familysharing');
Note: See TracBrowser for help on using the repository browser.