blob: 77122dbe30e390a0b49aa94ab0024b2098360625 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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">
78 <code><a href="#getFamilyInfo">getFamilyInfo(source=None)</a></code></p>
79<p class="firstline">Gets information regarding the family that the user is part of.</p>
80<p class="toc_element">
81 <code><a href="#share">share(docId=None, source=None, volumeId=None)</a></code></p>
82<p class="firstline">Initiates sharing of the content with the user's family. Empty response indicates success.</p>
83<p class="toc_element">
84 <code><a href="#unshare">unshare(docId=None, source=None, volumeId=None)</a></code></p>
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">
88 <code class="details" id="getFamilyInfo">getFamilyInfo(source=None)</code>
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.
93
94Returns:
95 An object of the form:
96
97 {
98 "kind": "books#familyInfo", # Resource type.
99 "membership": { # Family membership info of the user that made the request.
100 "acquirePermission": "A String", # Restrictions on user buying and acquiring content.
101 "allowedMaturityRating": "A String", # The maximum allowed maturity rating for the user.
102 "role": "A String", # The role of the user in the family.
103 "ageGroup": "A String", # The age group of the user.
104 "isInFamily": True or False,
105 },
106 }</pre>
107</div>
108
109<div class="method">
110 <code class="details" id="share">share(docId=None, source=None, volumeId=None)</code>
111 <pre>Initiates sharing of the content with the user's family. Empty response indicates success.
112
113Args:
114 docId: string, The docid to share.
115 source: string, String to identify the originator of this request.
116 volumeId: string, The volume to share.
117</pre>
118</div>
119
120<div class="method">
121 <code class="details" id="unshare">unshare(docId=None, source=None, volumeId=None)</code>
122 <pre>Initiates revoking content that has already been shared with the user's family. Empty response indicates success.
123
124Args:
125 docId: string, The docid to unshare.
126 source: string, String to identify the originator of this request.
127 volumeId: string, The volume to unshare.
128</pre>
129</div>
130
131</body></html>