blob: 4a8e57511b68a470fb47c196827d1bf1486d395b [file] [log] [blame]
Joe Gregorio761c4562011-10-28 14:36:24 -04001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: class Resource</title>
4</head><body bgcolor="#f0f0f8">
5<p>
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
7<tr bgcolor="#ffc8d8">
8<td colspan=3 valign=bottom>&nbsp;<br>
9<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>
10
11<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
12<td colspan=2><tt>A&nbsp;class&nbsp;for&nbsp;interacting&nbsp;with&nbsp;a&nbsp;resource.<br>&nbsp;</tt></td></tr>
13<tr><td>&nbsp;</td>
14<td width="100%">Methods defined here:<br>
15<dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl>
16
17<dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns&nbsp;blob&nbsp;attached&nbsp;to&nbsp;node&nbsp;at&nbsp;specified&nbsp;id&nbsp;as&nbsp;HTML<br>
18&nbsp;<br>
19Args:<br>
Joe Gregorio66212032012-06-14 09:10:14 -040020&nbsp;&nbsp;pp:&nbsp;string,&nbsp;A&nbsp;parameter<br>
21&nbsp;&nbsp;trace:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio761c4562011-10-28 14:36:24 -040022&nbsp;&nbsp;format:&nbsp;string,&nbsp;Sanitizing&nbsp;transformation.<br>
23&nbsp;&nbsp;&nbsp;&nbsp;Allowed&nbsp;values<br>
24&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;html&nbsp;-&nbsp;Return&nbsp;valid,&nbsp;sanitized&nbsp;html.<br>
25&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;plain&nbsp;-&nbsp;Return&nbsp;plain&nbsp;text&nbsp;-&nbsp;strip&nbsp;html&nbsp;tags.<br>
26&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;raw&nbsp;-&nbsp;Return&nbsp;the&nbsp;entire&nbsp;content&nbsp;as-is.<br>
Joe Gregorio66212032012-06-14 09:10:14 -040027&nbsp;&nbsp;strict:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregorio761c4562011-10-28 14:36:24 -040028&nbsp;&nbsp;maxlength:&nbsp;integer,&nbsp;The&nbsp;max&nbsp;number&nbsp;of&nbsp;characters&nbsp;to&nbsp;return.&nbsp;Valid&nbsp;only&nbsp;for&nbsp;'plain'&nbsp;format.<br>
Joe Gregorio66212032012-06-14 09:10:14 -040029&nbsp;&nbsp;userip:&nbsp;string,&nbsp;A&nbsp;parameter<br>
Joe Gregoriob417caf2011-12-08 12:04:24 -050030&nbsp;&nbsp;id:&nbsp;string,&nbsp;The&nbsp;id&nbsp;of&nbsp;the&nbsp;item&nbsp;that&nbsp;you&nbsp;want&nbsp;data&nbsp;about&nbsp;(required)&nbsp;(repeated)<br>
31&nbsp;<br>
32Returns:<br>
33&nbsp;&nbsp;An&nbsp;object&nbsp;of&nbsp;the&nbsp;form<br>
34&nbsp;<br>
35&nbsp;&nbsp;&nbsp;&nbsp;{<br>
36&nbsp;&nbsp;&nbsp;&nbsp;"result":&nbsp;"A&nbsp;String",&nbsp;#&nbsp;The&nbsp;text&nbsp;requested.<br>
37&nbsp;&nbsp;}</tt></dd></dl>
Joe Gregorio761c4562011-10-28 14:36:24 -040038
39<hr>
40Data descriptors defined here:<br>
41<dl><dt><strong>__dict__</strong></dt>
42<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
43</dl>
44<dl><dt><strong>__weakref__</strong></dt>
45<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
46</dl>
47</td></tr></table>
48</body></html>