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