blob: d973b28f68cf074ed64493655963e35affd2f150 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -07001<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="proximitybeacon_v1beta1.html">Google Proximity Beacon API</a> . <a href="proximitybeacon_v1beta1.v1beta1.html">v1beta1</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#getEidparams">getEidparams(x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040079<p class="firstline">Gets the Proximity Beacon API's current public key and associated</p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070080<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="getEidparams">getEidparams(x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040083 <pre>Gets the Proximity Beacon API's current public key and associated
84parameters used to initiate the Diffie-Hellman key exchange required to
85register a beacon that broadcasts the Eddystone-EID format. This key
86changes periodically; clients may cache it and re-use the same public key
87to provision and register multiple beacons. However, clients should be
88prepared to refresh this key when they encounter an error registering an
89Eddystone-EID beacon.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070090
91Args:
92 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040093 Allowed values
94 1 - v1 error format
95 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -070096
97Returns:
98 An object of the form:
99
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400100 { # Information a client needs to provision and register beacons that
101 # broadcast Eddystone-EID format beacon IDs, using Elliptic curve
102 # Diffie-Hellman key exchange. See
103 # [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.
104 "minRotationPeriodExponent": 42, # Indicates the minimum rotation period supported by the service.
105 # See EddystoneEidRegistration.rotation_period_exponent
106 "maxRotationPeriodExponent": 42, # Indicates the maximum rotation period supported by the service.
107 # See EddystoneEidRegistration.rotation_period_exponent
108 "serviceEcdhPublicKey": "A String", # The beacon service's public key for use by a beacon to derive its
109 # Identity Key using Elliptic Curve Diffie-Hellman key exchange.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700110 }</pre>
111</div>
112
113</body></html>