Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame^] | 1 | |
| 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> <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> </tt></td> |
| 12 | <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| 13 | <tr><td> </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-count"><strong>count</strong></a> = method(self, **kwargs)</dt><dd><tt>Get a count of link shares<br> |
| 18 | <br> |
| 19 | Args:<br> |
| 20 | url: URLs for which to get share counts.<br> |
| 21 | hl: Language code to limit language results.</tt></dd></dl> |
| 22 | |
| 23 | <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Delete an activity<br> |
| 24 | <br> |
| 25 | Args:<br> |
| 26 | scope: The collection to which the activity belongs. (required)<br> |
| 27 | alt: Specifies an alternative representation type.<br> |
| 28 | postId: ID of the activity to delete. (required)<br> |
| 29 | userId: ID of the user whose post to delete. (required)<br> |
| 30 | hl: Language code to limit language results.</tt></dd></dl> |
| 31 | |
| 32 | <dl><dt><a name="Resource-extractPeopleFromSearch"><strong>extractPeopleFromSearch</strong></a> = method(self, **kwargs)</dt><dd><tt>Search for people by topic<br> |
| 33 | <br> |
| 34 | Args:<br> |
| 35 | c: A continuation token that allows pagination.<br> |
| 36 | pid: ID of a place to use in a geographic location query.<br> |
| 37 | lon: Longitude to use in a geographic location query.<br> |
| 38 | q: Full-text search query string.<br> |
| 39 | max_results: Maximum number of results to include.<br> |
| 40 | radius: Radius to use in a geographic location query.<br> |
| 41 | bbox: Bounding box to use in a geographic location query.<br> |
| 42 | hl: Language code to limit language results.<br> |
| 43 | lat: Latitude to use in a geographic location query.<br> |
| 44 | alt: Specifies an alternative representation type.</tt></dd></dl> |
| 45 | |
| 46 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get an activity<br> |
| 47 | <br> |
| 48 | Args:<br> |
| 49 | postId: ID of the user to get. (required)<br> |
| 50 | userId: ID of the user whose post to get. (required)<br> |
| 51 | truncateAtom: Truncate the value of the atom:content element.<br> |
| 52 | hl: Language code to limit language results.<br> |
| 53 | alt: Specifies an alternative representation type.<br> |
| 54 | max_comments: Maximum number of comments to include.<br> |
| 55 | max_liked: Maximum number of likes to include.</tt></dd></dl> |
| 56 | |
| 57 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Create a new activity<br> |
| 58 | <br> |
| 59 | Args:<br> |
| 60 | body: The request body.<br> |
| 61 | alt: Specifies an alternative representation type.<br> |
| 62 | preview: If true, only preview the action.<br> |
| 63 | userId: ID of the user being referenced. (required)<br> |
| 64 | hl: Language code to limit language results.</tt></dd></dl> |
| 65 | |
| 66 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List activities<br> |
| 67 | <br> |
| 68 | Args:<br> |
| 69 | c: A continuation token that allows pagination.<br> |
| 70 | userId: ID of the user being referenced. (required)<br> |
| 71 | truncateAtom: Truncate the value of the atom:content element.<br> |
| 72 | max_results: Maximum number of results to include.<br> |
| 73 | hl: Language code to limit language results.<br> |
| 74 | scope: The collection of activities to list. (required)<br> |
| 75 | alt: Specifies an alternative representation type.<br> |
| 76 | max_comments: Maximum number of comments to include.<br> |
| 77 | max_liked: Maximum number of likes to include.</tt></dd></dl> |
| 78 | |
| 79 | <dl><dt><a name="Resource-list_next"><strong>list_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Takes a single argument, 'body', which is the results<br> |
| 80 | from the last call, and returns the next set of items<br> |
| 81 | in the collection.<br> |
| 82 | <br> |
| 83 | Returns None if there are no more items in<br> |
| 84 | the collection.</tt></dd></dl> |
| 85 | |
| 86 | <dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search for activities<br> |
| 87 | <br> |
| 88 | Args:<br> |
| 89 | c: A continuation token that allows pagination.<br> |
| 90 | pid: ID of a place to use in a geographic location query.<br> |
| 91 | lon: Longitude to use in a geographic location query.<br> |
| 92 | q: Full-text search query string.<br> |
| 93 | truncateAtom: Truncate the value of the atom:content element.<br> |
| 94 | max_results: Maximum number of results to include.<br> |
| 95 | radius: Radius to use in a geographic location query.<br> |
| 96 | bbox: Bounding box to use in a geographic location query.<br> |
| 97 | hl: Language code to limit language results.<br> |
| 98 | lat: Latitude to use in a geographic location query.<br> |
| 99 | alt: Specifies an alternative representation type.</tt></dd></dl> |
| 100 | |
| 101 | <dl><dt><a name="Resource-search_next"><strong>search_next</strong></a> = methodNext(self, previous)</dt><dd><tt>Takes a single argument, 'body', which is the results<br> |
| 102 | from the last call, and returns the next set of items<br> |
| 103 | in the collection.<br> |
| 104 | <br> |
| 105 | Returns None if there are no more items in<br> |
| 106 | the collection.</tt></dd></dl> |
| 107 | |
| 108 | <dl><dt><a name="Resource-track"><strong>track</strong></a> = method(self, **kwargs)</dt><dd><tt>Get real-time activity tracking information<br> |
| 109 | <br> |
| 110 | Args:<br> |
| 111 | c: A continuation token that allows pagination.<br> |
| 112 | pid: ID of a place to use in a geographic location query.<br> |
| 113 | lon: Longitude to use in a geographic location query.<br> |
| 114 | q: Full-text search query string.<br> |
| 115 | max_results: Maximum number of results to include.<br> |
| 116 | radius: Radius to use in a geographic location query.<br> |
| 117 | bbox: Bounding box to use in a geographic location query.<br> |
| 118 | hl: Language code to limit language results.<br> |
| 119 | lat: Latitude to use in a geographic location query.<br> |
| 120 | alt: Specifies an alternative representation type.</tt></dd></dl> |
| 121 | |
| 122 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update an activity<br> |
| 123 | <br> |
| 124 | Args:<br> |
| 125 | body: The request body.<br> |
| 126 | userId: ID of the user whose post to update. (required)<br> |
| 127 | abuseType: A parameter<br> |
| 128 | hl: Language code to limit language results.<br> |
| 129 | scope: The collection to which the activity belongs. (required)<br> |
| 130 | alt: Specifies an alternative representation type.<br> |
| 131 | postId: ID of the activity to update. (required)</tt></dd></dl> |
| 132 | |
| 133 | <hr> |
| 134 | Data descriptors defined here:<br> |
| 135 | <dl><dt><strong>__dict__</strong></dt> |
| 136 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 137 | </dl> |
| 138 | <dl><dt><strong>__weakref__</strong></dt> |
| 139 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 140 | </dl> |
| 141 | </td></tr></table> |
| 142 | </body></html> |