Skip to content

Commit ee90896

Browse files
committed
Add missing docs
1 parent 0cd347a commit ee90896

5 files changed

+505
-0
lines changed
Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
<html><body>
2+
<style>
3+
4+
body, 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+
15+
body {
16+
font-size: 13px;
17+
padding: 1em;
18+
}
19+
20+
h1 {
21+
font-size: 26px;
22+
margin-bottom: 1em;
23+
}
24+
25+
h2 {
26+
font-size: 24px;
27+
margin-bottom: 1em;
28+
}
29+
30+
h3 {
31+
font-size: 20px;
32+
margin-bottom: 1em;
33+
margin-top: 1em;
34+
}
35+
36+
pre, code {
37+
line-height: 1.5;
38+
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39+
}
40+
41+
pre {
42+
margin-top: 0.5em;
43+
}
44+
45+
h1, h2, h3, p {
46+
font-family: Arial, sans serif;
47+
}
48+
49+
h1, 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="youtube_v3alpha.html">YouTube API</a> . <a href="youtube_v3alpha.playlistItems.html">playlistItems</a></h1>
76+
<h2>Instance Methods</h2>
77+
<p class="toc_element">
78+
<code><a href="#list">list(part, playlistId=None, maxResults=None, contentOwnerId=None, startIndex=None, id=None)</a></code></p>
79+
<p class="firstline">Browse the YouTube playlist collection.</p>
80+
<h3>Method Details</h3>
81+
<div class="method">
82+
<code class="details" id="list">list(part, playlistId=None, maxResults=None, contentOwnerId=None, startIndex=None, id=None)</code>
83+
<pre>Browse the YouTube playlist collection.
84+
85+
Args:
86+
part: string, Parts of the playlist resource to be returned. (required)
87+
playlistId: string, Retrieves playlist items from the given playlist id.
88+
maxResults: integer, Maximum number of results to return
89+
contentOwnerId: string, The authenticated user acts on behalf of this content owner.
90+
startIndex: integer, Index of the first element to return (starts at 0)
91+
id: string, YouTube IDs of the playlists to be returned.
92+
93+
Returns:
94+
An object of the form:
95+
96+
{ # JSON template for a PlaylistItemService.List() response.
97+
"playlistItems": { # Map of playlist items matching the request criteria, keyed by id.
98+
"a_key": { # JSON template for a YouTube Playlist item. # An entry in the "playlistItems" map: the key is the video id, the value is the playlist item resource.
99+
"snippet": { # JSON template for the snippet part of a playlist item. # Basic details about the playlist item: title, description, thumbnails.
100+
"playlistId": "A String", # The playlist the item is part of.
101+
"description": "A String", # Description of the playlist item.
102+
"title": "A String", # Title of the playlist item.
103+
"resourceId": { # JSON template for a resource id. # The ID of the resource referenced by the playlist item.
104+
"kind": "A String", # The kind of the referred resource.
105+
"channelId": "A String", # ID of the referred channel. Present only when type is "CHANNEL".
106+
"playlistId": "A String", # ID of the referred playlist. Present only when type is "PLAYLIST".
107+
"videoId": "A String", # ID of the referred video. Present only when type is "VIDEO".
108+
},
109+
"channelId": "A String", # Author of the playlist item.
110+
"publishedAt": "A String", # The date and time the playlist item was created.
111+
"position": 42, # The position of the item within the playlist.
112+
},
113+
"contentDetails": { # JSON template for the content details part of a playlist item. # Content details about the playlist item: start and end clipping time.
114+
"note": "A String", # The user-generated note for this item.
115+
"startAt": "A String", # The time video playback begins.
116+
"endAt": "A String", # The time video playback ends.
117+
"videoId": "A String", # ID of the video.
118+
},
119+
"kind": "youtube#playlistItem", # The type of this API resource.
120+
"etag": "A String", # The eTag of the playlist item.
121+
"id": "A String", # The unique id of the playlist item.
122+
},
123+
},
124+
"kind": "youtube#playlistItemListResponse", # The type of this API response.
125+
"etag": "A String", # The eTag of the response.
126+
}</pre>
127+
</div>
128+
129+
</body></html>
3.21 KB
Loading
3.21 KB
Loading
Lines changed: 188 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,188 @@
1+
<?xml version="1.0" encoding="ascii"?>
2+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3+
"DTD/xhtml1-transitional.dtd">
4+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5+
<head>
6+
<title>oauth2client.file.CredentialsFileSymbolicLinkError</title>
7+
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8+
<script type="text/javascript" src="epydoc.js"></script>
9+
</head>
10+
11+
<body bgcolor="white" text="black" link="blue" vlink="#204080"
12+
alink="#204080">
13+
<!-- ==================== NAVIGATION BAR ==================== -->
14+
<table class="navbar" border="0" width="100%" cellpadding="0"
15+
bgcolor="#a0c0ff" cellspacing="0">
16+
<tr valign="middle">
17+
18+
<!-- Tree link -->
19+
<th>&nbsp;&nbsp;&nbsp;<a
20+
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21+
22+
<!-- Index link -->
23+
<th>&nbsp;&nbsp;&nbsp;<a
24+
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25+
26+
<!-- Help link -->
27+
<th>&nbsp;&nbsp;&nbsp;<a
28+
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29+
30+
<th class="navbar" width="100%"></th>
31+
</tr>
32+
</table>
33+
<table width="100%" cellpadding="0" cellspacing="0">
34+
<tr valign="top">
35+
<td width="100%">
36+
<span class="breadcrumbs">
37+
<a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38+
<a href="oauth2client.file-module.html">Module&nbsp;file</a> ::
39+
Class&nbsp;CredentialsFileSymbolicLinkError
40+
</span>
41+
</td>
42+
<td>
43+
<table cellpadding="0" cellspacing="0">
44+
<!-- hide/show private -->
45+
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
46+
onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
47+
<tr><td align="right"><span class="options"
48+
>[<a href="frames.html" target="_top">frames</a
49+
>]&nbsp;|&nbsp;<a href="oauth2client.file.CredentialsFileSymbolicLinkError-class.html"
50+
target="_top">no&nbsp;frames</a>]</span></td></tr>
51+
</table>
52+
</td>
53+
</tr>
54+
</table>
55+
<!-- ==================== CLASS DESCRIPTION ==================== -->
56+
<h1 class="epydoc">Class CredentialsFileSymbolicLinkError</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.file-pysrc.html#CredentialsFileSymbolicLinkError">source&nbsp;code</a></span></p>
57+
<center>
58+
<center> <map id="class_hierarchy_for_credential_5" name="class_hierarchy_for_credential_5">
59+
<area shape="rect" href="javascript:void(0);" title="exceptions.BaseException" alt="" coords="24,5,200,32"/>
60+
<area shape="rect" href="javascript:void(0);" title="exceptions.Exception" alt="" coords="39,61,185,88"/>
61+
<area shape="rect" href="oauth2client.file.CredentialsFileSymbolicLinkError-class.html" title="CredentialsFileSymbolicLinkError" alt="" coords="5,117,219,144"/>
62+
</map>
63+
<img src="class_hierarchy_for_credential_5.gif" alt='' usemap="#class_hierarchy_for_credential_5" ismap="ismap" class="graph-without-title" />
64+
</center>
65+
</center>
66+
<hr />
67+
<pre class="literalblock">
68+
Credentials files must not be symbolic links.
69+
70+
</pre>
71+
72+
<!-- ==================== INSTANCE METHODS ==================== -->
73+
<a name="section-InstanceMethods"></a>
74+
<table class="summary" border="1" cellpadding="3"
75+
cellspacing="0" width="100%" bgcolor="white">
76+
<tr bgcolor="#70b0f0" class="table-header">
77+
<td colspan="2" class="table-header">
78+
<table border="0" cellpadding="0" cellspacing="0" width="100%">
79+
<tr valign="top">
80+
<td align="left"><span class="table-header">Instance Methods</span></td>
81+
<td align="right" valign="top"
82+
><span class="options">[<a href="#section-InstanceMethods"
83+
class="privatelink" onclick="toggle_private();"
84+
>hide private</a>]</span></td>
85+
</tr>
86+
</table>
87+
</td>
88+
</tr>
89+
<tr>
90+
<td colspan="2" class="summary">
91+
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.Exception</code></b>:
92+
<code>__init__</code>,
93+
<code>__new__</code>
94+
</p>
95+
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.BaseException</code></b>:
96+
<code>__delattr__</code>,
97+
<code>__getattribute__</code>,
98+
<code>__getitem__</code>,
99+
<code>__getslice__</code>,
100+
<code>__reduce__</code>,
101+
<code>__repr__</code>,
102+
<code>__setattr__</code>,
103+
<code>__setstate__</code>,
104+
<code>__str__</code>,
105+
<code>__unicode__</code>
106+
</p>
107+
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
108+
<code>__format__</code>,
109+
<code>__hash__</code>,
110+
<code>__reduce_ex__</code>,
111+
<code>__sizeof__</code>,
112+
<code>__subclasshook__</code>
113+
</p>
114+
</td>
115+
</tr>
116+
</table>
117+
<!-- ==================== PROPERTIES ==================== -->
118+
<a name="section-Properties"></a>
119+
<table class="summary" border="1" cellpadding="3"
120+
cellspacing="0" width="100%" bgcolor="white">
121+
<tr bgcolor="#70b0f0" class="table-header">
122+
<td colspan="2" class="table-header">
123+
<table border="0" cellpadding="0" cellspacing="0" width="100%">
124+
<tr valign="top">
125+
<td align="left"><span class="table-header">Properties</span></td>
126+
<td align="right" valign="top"
127+
><span class="options">[<a href="#section-Properties"
128+
class="privatelink" onclick="toggle_private();"
129+
>hide private</a>]</span></td>
130+
</tr>
131+
</table>
132+
</td>
133+
</tr>
134+
<tr>
135+
<td colspan="2" class="summary">
136+
<p class="indent-wrapped-lines"><b>Inherited from <code>exceptions.BaseException</code></b>:
137+
<code>args</code>,
138+
<code>message</code>
139+
</p>
140+
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
141+
<code>__class__</code>
142+
</p>
143+
</td>
144+
</tr>
145+
</table>
146+
<!-- ==================== NAVIGATION BAR ==================== -->
147+
<table class="navbar" border="0" width="100%" cellpadding="0"
148+
bgcolor="#a0c0ff" cellspacing="0">
149+
<tr valign="middle">
150+
151+
<!-- Tree link -->
152+
<th>&nbsp;&nbsp;&nbsp;<a
153+
href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
154+
155+
<!-- Index link -->
156+
<th>&nbsp;&nbsp;&nbsp;<a
157+
href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
158+
159+
<!-- Help link -->
160+
<th>&nbsp;&nbsp;&nbsp;<a
161+
href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
162+
163+
<th class="navbar" width="100%"></th>
164+
</tr>
165+
</table>
166+
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
167+
<tr>
168+
<td align="left" class="footer">
169+
Generated by Epydoc 3.0.1 on Thu Aug 30 07:12:46 2012
170+
</td>
171+
<td align="right" class="footer">
172+
<a target="mainFrame" href="http://epydoc.sourceforge.net"
173+
>http://epydoc.sourceforge.net</a>
174+
</td>
175+
</tr>
176+
</table>
177+
178+
<script type="text/javascript">
179+
<!--
180+
// Private objects are initially displayed (because if
181+
// javascript is turned off then we want them to be
182+
// visible); but by default, we want to hide them. So hide
183+
// them unless we have a cookie that says to show them.
184+
checkCookie();
185+
// -->
186+
</script>
187+
</body>
188+
</html>

0 commit comments

Comments
 (0)