• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="mirror_v1.html">Google Mirror API</a> . <a href="mirror_v1.locations.html">locations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(id)</a></code></p>
79<p class="firstline">Gets a single location by ID.</p>
80<p class="toc_element">
81  <code><a href="#list">list()</a></code></p>
82<p class="firstline">Retrieves a list of locations for the user.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="get">get(id)</code>
86  <pre>Gets a single location by ID.
87
88Args:
89  id: string, The ID of the location or latest for the last known location. (required)
90
91Returns:
92  An object of the form:
93
94    { # A geographic location that can be associated with a timeline item.
95    "kind": "mirror#location", # The type of resource. This is always mirror#location.
96    "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
97    "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
98    "longitude": 3.14, # The longitude, in degrees.
99    "address": "A String", # The full address of the location.
100    "latitude": 3.14, # The latitude, in degrees.
101    "id": "A String", # The ID of the location.
102    "accuracy": 3.14, # The accuracy of the location fix in meters.
103  }</pre>
104</div>
105
106<div class="method">
107    <code class="details" id="list">list()</code>
108  <pre>Retrieves a list of locations for the user.
109
110Args:
111
112Returns:
113  An object of the form:
114
115    { # A list of Locations. This is the response from the server to GET requests on the locations collection.
116    "items": [ # The list of locations.
117      { # A geographic location that can be associated with a timeline item.
118        "kind": "mirror#location", # The type of resource. This is always mirror#location.
119        "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home".
120        "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339.
121        "longitude": 3.14, # The longitude, in degrees.
122        "address": "A String", # The full address of the location.
123        "latitude": 3.14, # The latitude, in degrees.
124        "id": "A String", # The ID of the location.
125        "accuracy": 3.14, # The accuracy of the location fix in meters.
126      },
127    ],
128    "kind": "mirror#locationsList", # The type of resource. This is always mirror#locationsList.
129  }</pre>
130</div>
131
132</body></html>