docs/dyn/buzz.v1.photos.html - platform/external/python/google-api-python-client - Gitiles


 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><title>Python: class Resource</title>
 </head><body bgcolor="#f0f0f8">
 <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ffc8d8">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</td>
 <td width="100%">Methods defined here:<br>
 <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

 <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete&nbsp;a&nbsp;photo<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;photoId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;photo&nbsp;to&nbsp;delete.&nbsp;(required)<br>
 &nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;to&nbsp;which&nbsp;to&nbsp;photo&nbsp;belongs.&nbsp;(required)<br>
 &nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
 &nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
 &nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>

 <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;photo&nbsp;metadata<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;photoId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;photo&nbsp;for&nbsp;which&nbsp;to&nbsp;get&nbsp;metadata.&nbsp;(required)<br>
 &nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;containing&nbsp;the&nbsp;photo.&nbsp;(required)<br>
 &nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
 &nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
 &nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>

 <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Upload&nbsp;a&nbsp;photo&nbsp;to&nbsp;an&nbsp;album<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
 &nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;to&nbsp;which&nbsp;to&nbsp;upload.&nbsp;(required)<br>
 &nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
 &nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
 &nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>

 <dl><dt><a name="Resource-insert2"><strong>insert2</strong></a> = method(self, **kwargs)</dt><dd><tt>Upload&nbsp;a&nbsp;photo&nbsp;to&nbsp;an&nbsp;album<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;body:&nbsp;object,&nbsp;The&nbsp;request&nbsp;body.&nbsp;(required)<br>
 &nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;to&nbsp;which&nbsp;to&nbsp;upload.&nbsp;(required)<br>
 &nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
 &nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
 &nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>

 <dl><dt><a name="Resource-listByAlbum"><strong>listByAlbum</strong></a> = method(self, **kwargs)</dt><dd><tt>List&nbsp;photos&nbsp;in&nbsp;an&nbsp;album<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;c:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
 &nbsp;&nbsp;albumId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;album&nbsp;for&nbsp;which&nbsp;to&nbsp;list&nbsp;photos.&nbsp;(required)<br>
 &nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
 &nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
 &nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
 &nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>

 <dl><dt><a name="Resource-listByScope"><strong>listByScope</strong></a> = method(self, **kwargs)</dt><dd><tt>Get&nbsp;a&nbsp;user's&nbsp;photos<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;c:&nbsp;string,&nbsp;A&nbsp;continuation&nbsp;token&nbsp;that&nbsp;allows&nbsp;pagination.<br>
 &nbsp;&nbsp;userId:&nbsp;string,&nbsp;ID&nbsp;of&nbsp;the&nbsp;user&nbsp;being&nbsp;referenced.&nbsp;(required)<br>
 &nbsp;&nbsp;max_results:&nbsp;integer,&nbsp;Maximum&nbsp;number&nbsp;of&nbsp;results&nbsp;to&nbsp;include.<br>
 &nbsp;&nbsp;hl:&nbsp;string,&nbsp;Language&nbsp;code&nbsp;to&nbsp;limit&nbsp;language&nbsp;results.<br>
 &nbsp;&nbsp;scope:&nbsp;string,&nbsp;The&nbsp;collection&nbsp;of&nbsp;photos&nbsp;to&nbsp;list.&nbsp;(required)<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;@recent&nbsp;-&nbsp;Recent&nbsp;photos&nbsp;uploaded&nbsp;by&nbsp;the&nbsp;user.<br>
 &nbsp;&nbsp;alt:&nbsp;string,&nbsp;Specifies&nbsp;an&nbsp;alternative&nbsp;representation&nbsp;type.<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;atom&nbsp;-&nbsp;Use&nbsp;Atom&nbsp;XML&nbsp;format<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;json&nbsp;-&nbsp;Use&nbsp;JSON&nbsp;format</tt></dd></dl>

 <hr>
 Data descriptors defined here:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 </td></tr></table>
 </body></html>

	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html><head><title>Python: class Resource</title>
	</head><body bgcolor="#f0f0f8">
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ffc8d8">
	<td colspan=3 valign=bottom> <br>
	<font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

	<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>
	<td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr>
	<tr><td> </td>
	<td width="100%">Methods defined here:<br>
	<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>

	<dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete a photo<br>
	<br>
	Args:<br>
	photoId: string, ID of the photo to delete. (required)<br>
	albumId: string, ID of the album to which to photo belongs. (required)<br>
	userId: string, ID of the user being referenced. (required)<br>
	hl: string, Language code to limit language results.<br>
	alt: string, Specifies an alternative representation type.<br>
	Allowed values<br>
	atom - Use Atom XML format<br>
	json - Use JSON format</tt></dd></dl>

	<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get photo metadata<br>
	<br>
	Args:<br>
	photoId: string, ID of the photo for which to get metadata. (required)<br>
	albumId: string, ID of the album containing the photo. (required)<br>
	userId: string, ID of the user being referenced. (required)<br>
	hl: string, Language code to limit language results.<br>
	alt: string, Specifies an alternative representation type.<br>
	Allowed values<br>
	atom - Use Atom XML format<br>
	json - Use JSON format</tt></dd></dl>

	<dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Upload a photo to an album<br>
	<br>
	Args:<br>
	body: object, The request body. (required)<br>
	albumId: string, ID of the album to which to upload. (required)<br>
	userId: string, ID of the user being referenced. (required)<br>
	hl: string, Language code to limit language results.<br>
	alt: string, Specifies an alternative representation type.<br>
	Allowed values<br>
	atom - Use Atom XML format<br>
	json - Use JSON format</tt></dd></dl>

	<dl><dt><a name="Resource-insert2"><strong>insert2</strong></a> = method(self, **kwargs)</dt><dd><tt>Upload a photo to an album<br>
	<br>
	Args:<br>
	body: object, The request body. (required)<br>
	albumId: string, ID of the album to which to upload. (required)<br>
	userId: string, ID of the user being referenced. (required)<br>
	hl: string, Language code to limit language results.<br>
	alt: string, Specifies an alternative representation type.<br>
	Allowed values<br>
	atom - Use Atom XML format<br>
	json - Use JSON format</tt></dd></dl>

	<dl><dt><a name="Resource-listByAlbum"><strong>listByAlbum</strong></a> = method(self, **kwargs)</dt><dd><tt>List photos in an album<br>
	<br>
	Args:<br>
	c: string, A continuation token that allows pagination.<br>
	albumId: string, ID of the album for which to list photos. (required)<br>
	userId: string, ID of the user being referenced. (required)<br>
	max_results: integer, Maximum number of results to include.<br>
	hl: string, Language code to limit language results.<br>
	alt: string, Specifies an alternative representation type.<br>
	Allowed values<br>
	atom - Use Atom XML format<br>
	json - Use JSON format</tt></dd></dl>

	<dl><dt><a name="Resource-listByScope"><strong>listByScope</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a user's photos<br>
	<br>
	Args:<br>
	c: string, A continuation token that allows pagination.<br>
	userId: string, ID of the user being referenced. (required)<br>
	max_results: integer, Maximum number of results to include.<br>
	hl: string, Language code to limit language results.<br>
	scope: string, The collection of photos to list. (required)<br>
	Allowed values<br>
	@recent - Recent photos uploaded by the user.<br>
	alt: string, Specifies an alternative representation type.<br>
	Allowed values<br>
	atom - Use Atom XML format<br>
	json - Use JSON format</tt></dd></dl>

	<hr>
	Data descriptors defined here:<br>
	<dl><dt><strong>__dict__</strong></dt>
	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>__weakref__</strong></dt>
	<dd><tt>list of weak references to the object (if defined)</tt></dd>
	</dl>
	</td></tr></table>
	</body></html>