Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e912d185eef03392f095881d407c0c78f7633d5e / . / docs / dyn / latitude_v1.currentLocation.html
blob: 51edf9898d0c4fe94c9050d6a49425a2d34cd85b [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="latitude_v1.html">Google Latitude API</a> . <a href="latitude_v1.currentLocation.html">currentLocation</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete()</a></code></p>
79<p class="firstline">Deletes the authenticated user's current location.</p>
80<p class="toc_element">
81 <code><a href="#get">get(granularity=None)</a></code></p>
82<p class="firstline">Returns the authenticated user's current location.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(body)</a></code></p>
85<p class="firstline">Updates or creates the user's current location.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="delete">delete()</code>
89 <pre>Deletes the authenticated user's current location.
90
91Args:
92</pre>
93</div>
94
95<div class="method">
96 <code class="details" id="get">get(granularity=None)</code>
97 <pre>Returns the authenticated user's current location.
98
99Args:
100 granularity: string, Granularity of the requested location.
101 Allowed values
102 best - Request best available granularity.
103 city - Request city-level granularty.
104
105Returns:
106 An object of the form:
107
108 { # 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.
109 "kind": "latitude#location", # Kind of this item.
110 "altitude": "", # Altitude of the location, in meters. Optional.
111 "longitude": "", # Longitude of the location, in decimal degrees.
112 "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
113 "latitude": "", # Latitude of the location, in decimal degrees.
114 "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
115 "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
116 "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
117 "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
118 "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
119 }</pre>
120</div>
121
122<div class="method">
123 <code class="details" id="insert">insert(body)</code>
124 <pre>Updates or creates the user's current location.
125
126Args:
127 body: object, The request body. (required)
128 The object takes the form of:
129
130{ # 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.
131 "kind": "latitude#location", # Kind of this item.
132 "altitude": "", # Altitude of the location, in meters. Optional.
133 "longitude": "", # Longitude of the location, in decimal degrees.
134 "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
135 "latitude": "", # Latitude of the location, in decimal degrees.
136 "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
137 "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
138 "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
139 "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
140 "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
141 }
142
143
144Returns:
145 An object of the form:
146
147 { # 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.
148 "kind": "latitude#location", # Kind of this item.
149 "altitude": "", # Altitude of the location, in meters. Optional.
150 "longitude": "", # Longitude of the location, in decimal degrees.
151 "activityId": "", # Unique ID of the Buzz message that corresponds to the check-in associated with this location. Available only for check-in locations. Optional.
152 "latitude": "", # Latitude of the location, in decimal degrees.
153 "altitudeAccuracy": "", # Accuracy of the altitude value, in meters. Optional.
154 "timestampMs": "", # Timestamp of the Location Resource, in milliseconds since the epoch (UTC). This is also the Location Resource's unique id.
155 "speed": "", # Ground speed of the user at the time this location was recorded, in meters per second. Non-negative. Optional.
156 "heading": "", # Direction of travel of the user when this location was recorded. In degrees, clockwise relative to true north. Optional.
157 "accuracy": "", # Accuracy of the latitude and longitude coordinates, in non-negative meters. Optional.
158 }</pre>
159</div>
160
161</body></html>