Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3b53d7997789959ebae7dfe7c8e79e9e8806da66 / . / docs / dyn / books_v1.familysharing.html
blob: 2fe8c60e4412620fac7218d1afe03cd2a6512860 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="books_v1.html">Books API</a> . <a href="books_v1.familysharing.html">familysharing</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]81 <code><a href="#getFamilyInfo">getFamilyInfo(source=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Gets information regarding the family that the user is part of.</p>
83<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]84 <code><a href="#share">share(docId=None, source=None, volumeId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Initiates sharing of the content with the user's family. Empty response indicates success.</p>
86<p class="toc_element">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]87 <code><a href="#unshare">unshare(docId=None, source=None, volumeId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88<p class="firstline">Initiates revoking content that has already been shared with the user's family. Empty response indicates success.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]96 <code class="details" id="getFamilyInfo">getFamilyInfo(source=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97 <pre>Gets information regarding the family that the user is part of.
98
99Args:
100 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105
106Returns:
107 An object of the form:
108
109 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]110 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
111 &quot;membership&quot;: { # Family membership info of the user that made the request.
112 &quot;acquirePermission&quot;: &quot;A String&quot;, # Restrictions on user buying and acquiring content.
113 &quot;ageGroup&quot;: &quot;A String&quot;, # The age group of the user.
114 &quot;allowedMaturityRating&quot;: &quot;A String&quot;, # The maximum allowed maturity rating for the user.
115 &quot;isInFamily&quot;: True or False,
116 &quot;role&quot;: &quot;A String&quot;, # The role of the user in the family.
117 },
118}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]119</div>
120
121<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]122 <code class="details" id="share">share(docId=None, source=None, volumeId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 <pre>Initiates sharing of the content with the user&#x27;s family. Empty response indicates success.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124
125Args:
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]126 docId: string, The docid to share.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]127 source: string, String to identify the originator of this request.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]128 volumeId: string, The volume to share.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133
134Returns:
135 An object of the form:
136
137 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]138}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]139</div>
140
141<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]142 <code class="details" id="unshare">unshare(docId=None, source=None, volumeId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 <pre>Initiates revoking content that has already been shared with the user&#x27;s family. Empty response indicates success.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144
145Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]146 docId: string, The docid to unshare.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]147 source: string, String to identify the originator of this request.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]148 volumeId: string, The volume to unshare.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154Returns:
155 An object of the form:
156
157 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]158}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159</div>
160
161</body></html>