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> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 20 | url: string, URLs for which to get share counts. (repeated)<br> |
| 21 | hl: string, Language code to limit language results.</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 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> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 26 | userId: string, ID of the user whose post to delete. (required)<br> |
| 27 | hl: string, Language code to limit language results.<br> |
| 28 | scope: string, The collection to which the activity belongs. (required)<br> |
| 29 | Allowed values<br> |
| 30 | @liked - Activities liked by the user.<br> |
| 31 | @muted - Activities muted by the user.<br> |
| 32 | @self - Activities posted by the user.<br> |
| 33 | alt: string, Specifies an alternative representation type.<br> |
| 34 | Allowed values<br> |
| 35 | atom - Use Atom XML format<br> |
| 36 | json - Use JSON format<br> |
| 37 | postId: string, ID of the activity to delete. (required)</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 38 | |
| 39 | <dl><dt><a name="Resource-extractPeopleFromSearch"><strong>extractPeopleFromSearch</strong></a> = method(self, **kwargs)</dt><dd><tt>Search for people by topic<br> |
| 40 | <br> |
| 41 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 42 | c: string, A continuation token that allows pagination.<br> |
| 43 | pid: string, ID of a place to use in a geographic location query.<br> |
| 44 | lon: string, Longitude to use in a geographic location query.<br> |
| 45 | q: string, Full-text search query string.<br> |
| 46 | max_results: integer, Maximum number of results to include.<br> |
| 47 | radius: string, Radius to use in a geographic location query.<br> |
| 48 | bbox: string, Bounding box to use in a geographic location query.<br> |
| 49 | hl: string, Language code to limit language results.<br> |
| 50 | lat: string, Latitude to use in a geographic location query.<br> |
| 51 | alt: string, Specifies an alternative representation type.<br> |
| 52 | Allowed values<br> |
| 53 | atom - Use Atom XML format<br> |
| 54 | json - Use JSON format</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 55 | |
| 56 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Get an activity<br> |
| 57 | <br> |
| 58 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 59 | postId: string, ID of the user to get. (required)<br> |
| 60 | userId: string, ID of the user whose post to get. (required)<br> |
| 61 | truncateAtom: boolean, Truncate the value of the atom:content element.<br> |
| 62 | hl: string, Language code to limit language results.<br> |
| 63 | alt: string, Specifies an alternative representation type.<br> |
| 64 | Allowed values<br> |
| 65 | atom - Use Atom XML format<br> |
| 66 | json - Use JSON format<br> |
| 67 | max_comments: integer, Maximum number of comments to include.<br> |
| 68 | max_liked: integer, Maximum number of likes to include.</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 69 | |
| 70 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Create a new activity<br> |
| 71 | <br> |
| 72 | Args:<br> |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame^] | 73 | body: object, The request body. (required)<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 74 | userId: string, ID of the user being referenced. (required)<br> |
| 75 | hl: string, Language code to limit language results.<br> |
| 76 | alt: string, Specifies an alternative representation type.<br> |
| 77 | Allowed values<br> |
| 78 | atom - Use Atom XML format<br> |
| 79 | json - Use JSON format<br> |
| 80 | preview: boolean, If true, only preview the action.</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 81 | |
| 82 | <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>List activities<br> |
| 83 | <br> |
| 84 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 85 | c: string, A continuation token that allows pagination.<br> |
| 86 | userId: string, ID of the user being referenced. (required)<br> |
| 87 | truncateAtom: boolean, Truncate the value of the atom:content element.<br> |
| 88 | max_results: integer, Maximum number of results to include.<br> |
| 89 | hl: string, Language code to limit language results.<br> |
| 90 | scope: string, The collection of activities to list. (required)<br> |
| 91 | Allowed values<br> |
| 92 | @comments - Limit to activities commented on by the user.<br> |
| 93 | @consumption - Limit to activities to be consumed by the user.<br> |
| 94 | @liked - Limit to activities liked by the user.<br> |
| 95 | @public - Limit to public activities posted by the user.<br> |
| 96 | @self - Limit to activities posted by the user.<br> |
| 97 | alt: string, Specifies an alternative representation type.<br> |
| 98 | Allowed values<br> |
| 99 | atom - Use Atom XML format<br> |
| 100 | json - Use JSON format<br> |
| 101 | max_comments: integer, Maximum number of comments to include.<br> |
| 102 | max_liked: integer, Maximum number of likes to include.</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 103 | |
| 104 | <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> |
| 105 | from the last call, and returns the next set of items<br> |
| 106 | in the collection.<br> |
| 107 | <br> |
| 108 | Returns None if there are no more items in<br> |
| 109 | the collection.</tt></dd></dl> |
| 110 | |
| 111 | <dl><dt><a name="Resource-search"><strong>search</strong></a> = method(self, **kwargs)</dt><dd><tt>Search for activities<br> |
| 112 | <br> |
| 113 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 114 | c: string, A continuation token that allows pagination.<br> |
| 115 | pid: string, ID of a place to use in a geographic location query.<br> |
| 116 | lon: string, Longitude to use in a geographic location query.<br> |
| 117 | q: string, Full-text search query string.<br> |
| 118 | truncateAtom: boolean, Truncate the value of the atom:content element.<br> |
| 119 | max_results: integer, Maximum number of results to include.<br> |
| 120 | radius: string, Radius to use in a geographic location query.<br> |
| 121 | bbox: string, Bounding box to use in a geographic location query.<br> |
| 122 | hl: string, Language code to limit language results.<br> |
| 123 | lat: string, Latitude to use in a geographic location query.<br> |
| 124 | alt: string, Specifies an alternative representation type.<br> |
| 125 | Allowed values<br> |
| 126 | atom - Use Atom XML format<br> |
| 127 | json - Use JSON format</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 128 | |
| 129 | <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> |
| 130 | from the last call, and returns the next set of items<br> |
| 131 | in the collection.<br> |
| 132 | <br> |
| 133 | Returns None if there are no more items in<br> |
| 134 | the collection.</tt></dd></dl> |
| 135 | |
| 136 | <dl><dt><a name="Resource-track"><strong>track</strong></a> = method(self, **kwargs)</dt><dd><tt>Get real-time activity tracking information<br> |
| 137 | <br> |
| 138 | Args:<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 139 | c: string, A continuation token that allows pagination.<br> |
| 140 | pid: string, ID of a place to use in a geographic location query.<br> |
| 141 | lon: string, Longitude to use in a geographic location query.<br> |
| 142 | q: string, Full-text search query string.<br> |
| 143 | max_results: integer, Maximum number of results to include.<br> |
| 144 | radius: string, Radius to use in a geographic location query.<br> |
| 145 | bbox: string, Bounding box to use in a geographic location query.<br> |
| 146 | hl: string, Language code to limit language results.<br> |
| 147 | lat: string, Latitude to use in a geographic location query.<br> |
| 148 | alt: string, Specifies an alternative representation type.<br> |
| 149 | Allowed values<br> |
| 150 | atom - Use Atom XML format<br> |
| 151 | json - Use JSON format</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 152 | |
| 153 | <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Update an activity<br> |
| 154 | <br> |
| 155 | Args:<br> |
Joe Gregorio | 9384170 | 2011-03-02 16:12:05 -0800 | [diff] [blame^] | 156 | body: object, The request body. (required)<br> |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 157 | userId: string, ID of the user whose post to update. (required)<br> |
| 158 | abuseType: string, A parameter<br> |
| 159 | hl: string, Language code to limit language results.<br> |
| 160 | scope: string, The collection to which the activity belongs. (required)<br> |
| 161 | Allowed values<br> |
| 162 | @abuse - Activities reported by the user.<br> |
| 163 | @liked - Activities liked by the user.<br> |
| 164 | @muted - Activities muted by the user.<br> |
| 165 | @self - Activities posted by the user.<br> |
| 166 | alt: string, Specifies an alternative representation type.<br> |
| 167 | Allowed values<br> |
| 168 | atom - Use Atom XML format<br> |
| 169 | json - Use JSON format<br> |
| 170 | postId: string, ID of the activity to update. (required)</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 171 | |
| 172 | <hr> |
| 173 | Data descriptors defined here:<br> |
| 174 | <dl><dt><strong>__dict__</strong></dt> |
| 175 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 176 | </dl> |
| 177 | <dl><dt><strong>__weakref__</strong></dt> |
| 178 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 179 | </dl> |
| 180 | </td></tr></table> |
| 181 | </body></html> |