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   */
42  public function getFamilyInfo($optParams = [])
43  {
44    $params = [];
45    $params = array_merge($params, $optParams);
46    return $this->call('getFamilyInfo', [$params], FamilyInfo::class);
47  }
48  /**
49   * Initiates sharing of the content with the user's family. Empty response
50   * indicates success. (familysharing.share)
51   *
52   * @param array $optParams Optional parameters.
53   *
54   * @opt_param string docId The docid to share.
55   * @opt_param string source String to identify the originator of this request.
56   * @opt_param string volumeId The volume to share.
57   * @return BooksEmpty
58   */
59  public function share($optParams = [])
60  {
61    $params = [];
62    $params = array_merge($params, $optParams);
63    return $this->call('share', [$params], BooksEmpty::class);
64  }
65  /**
66   * Initiates revoking content that has already been shared with the user's
67   * family. Empty response indicates success. (familysharing.unshare)
68   *
69   * @param array $optParams Optional parameters.
70   *
71   * @opt_param string docId The docid to unshare.
72   * @opt_param string source String to identify the originator of this request.
73   * @opt_param string volumeId The volume to unshare.
74   * @return BooksEmpty
75   */
76  public function unshare($optParams = [])
77  {
78    $params = [];
79    $params = array_merge($params, $optParams);
80    return $this->call('unshare', [$params], BooksEmpty::class);
81  }
82}
83
84// Adding a class alias for backwards compatibility with the previous class name.
85class_alias(Familysharing::class, 'Google_Service_Books_Resource_Familysharing');
86