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 | |
Joe Gregorio | ad258e2 | 2011-02-22 22:53:30 -0500 | [diff] [blame] | 17 | <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes the authenticated user's current location.<br> |
| 18 | <br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 19 | Args:<br> |
| 20 | pp: string, A parameter<br> |
| 21 | trace: string, A parameter<br> |
| 22 | strict: string, A parameter<br> |
| 23 | userip: string, A parameter</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 24 | |
| 25 | <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the authenticated user's current location.<br> |
| 26 | <br> |
| 27 | Args:<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 28 | pp: string, A parameter<br> |
| 29 | trace: string, A parameter<br> |
| 30 | strict: string, A parameter<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 31 | granularity: string, Granularity of the requested location.<br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 32 | Allowed values<br> |
| 33 | best - Request best available granularity.<br> |
| 34 | city - Request city-level granularty.<br> |
| 35 | userip: string, A parameter<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 36 | <br> |
| 37 | Returns:<br> |
| 38 | An object of the form<br> |
| 39 | <br> |
| 40 | { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.<br> |
| 41 | "kind": "latitude#location", # Kind of this item.<br> |
| 42 | "altitude": "", # Altitude of the location, in meters. Optional.<br> |
| 43 | "longitude": "", # Longitude of the location, in decimal degrees.<br> |
| 44 | "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.<br> |
| 45 | "latitude": "", # Latitude of the location, in decimal degrees.<br> |
| 46 | "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.<br> |
| 47 | "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.<br> |
| 48 | "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.<br> |
| 49 | "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.<br> |
| 50 | "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.<br> |
| 51 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 52 | |
| 53 | <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates or creates the user's current location.<br> |
| 54 | <br> |
| 55 | Args:<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 56 | body: object, The request body. (required)<br> |
| 57 | The object takes the form of:<br> |
| 58 | <br> |
| 59 | { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.<br> |
| 60 | "kind": "latitude#location", # Kind of this item.<br> |
| 61 | "altitude": "", # Altitude of the location, in meters. Optional.<br> |
| 62 | "longitude": "", # Longitude of the location, in decimal degrees.<br> |
| 63 | "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.<br> |
| 64 | "latitude": "", # Latitude of the location, in decimal degrees.<br> |
| 65 | "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.<br> |
| 66 | "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.<br> |
| 67 | "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.<br> |
| 68 | "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.<br> |
| 69 | "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.<br> |
| 70 | }<br> |
| 71 | <br> |
Joe Gregorio | 6621203 | 2012-06-14 09:10:14 -0400 | [diff] [blame] | 72 | pp: string, A parameter<br> |
| 73 | trace: string, A parameter<br> |
| 74 | strict: string, A parameter<br> |
| 75 | userip: string, A parameter<br> |
Joe Gregorio | b417caf | 2011-12-08 12:04:24 -0500 | [diff] [blame] | 76 | <br> |
| 77 | Returns:<br> |
| 78 | An object of the form<br> |
| 79 | <br> |
| 80 | { # A Location resource identifies a user's position at a particular time. It may include metadata about the user's position, such as a venue if the location was recorded at the time of a check-in.<br> |
| 81 | "kind": "latitude#location", # Kind of this item.<br> |
| 82 | "altitude": "", # Altitude of the location, in meters. Optional.<br> |
| 83 | "longitude": "", # Longitude of the location, in decimal degrees.<br> |
| 84 | "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.<br> |
| 85 | "latitude": "", # Latitude of the location, in decimal degrees.<br> |
| 86 | "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.<br> |
| 87 | "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.<br> |
| 88 | "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.<br> |
| 89 | "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.<br> |
| 90 | "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.<br> |
| 91 | }</tt></dd></dl> |
Joe Gregorio | afc45f2 | 2011-02-20 16:11:28 -0500 | [diff] [blame] | 92 | |
| 93 | <hr> |
| 94 | Data descriptors defined here:<br> |
| 95 | <dl><dt><strong>__dict__</strong></dt> |
| 96 | <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| 97 | </dl> |
| 98 | <dl><dt><strong>__weakref__</strong></dt> |
| 99 | <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| 100 | </dl> |
| 101 | </td></tr></table> |
| 102 | </body></html> |