Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / books_v1.familysharing.html
blob: 80fb47f2f112aa8177356a12b7a4761bbb0faf9a [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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]78 <code><a href="#getFamilyInfo">getFamilyInfo(source=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Gets information regarding the family that the user is part of.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]81 <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]82<p class="firstline">Initiates sharing of the content with the user's family. Empty response indicates success.</p>
83<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]84 <code><a href="#unshare">unshare(source=None, volumeId=None, docId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Initiates revoking content that has already been shared with the user's family. Empty response indicates success.</p>
86<h3>Method Details</h3>
87<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]88 <code class="details" id="getFamilyInfo">getFamilyInfo(source=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89 <pre>Gets information regarding the family that the user is part of.
90
91Args:
92 source: string, String to identify the originator of this request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]93 x__xgafv: string, V1 error format.
94 Allowed values
95 1 - v1 error format
96 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]97
98Returns:
99 An object of the form:
100
101 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]102 &quot;membership&quot;: { # Family membership info of the user that made the request.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]103 &quot;role&quot;: &quot;A String&quot;, # The role of the user in the family.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]104 &quot;acquirePermission&quot;: &quot;A String&quot;, # Restrictions on user buying and acquiring content.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]105 &quot;isInFamily&quot;: True or False,
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]106 &quot;ageGroup&quot;: &quot;A String&quot;, # The age group of the user.
107 &quot;allowedMaturityRating&quot;: &quot;A String&quot;, # The maximum allowed maturity rating for the user.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]109 &quot;kind&quot;: &quot;A String&quot;, # Resource type.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110 }</pre>
111</div>
112
113<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]114 <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]115 <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]116
117Args:
118 docId: string, The docid to share.
119 source: string, String to identify the originator of this request.
120 volumeId: string, The volume to share.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]121 x__xgafv: string, V1 error format.
122 Allowed values
123 1 - v1 error format
124 2 - v2 error format
125
126Returns:
127 An object of the form:
128
129 { # 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 `{}`.
130 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131</div>
132
133<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]134 <code class="details" id="unshare">unshare(source=None, volumeId=None, docId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 <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]136
137Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 source: string, String to identify the originator of this request.
139 volumeId: string, The volume to unshare.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]140 docId: string, The docid to unshare.
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 { # 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 `{}`.
150 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]151</div>
152
153</body></html>