|
23 | 23 | <li class="state loading">Preparing search index...</li>
|
24 | 24 | <li class="state failure">The search index is not available</li>
|
25 | 25 | </ul>
|
26 |
| - <a href="../globals.html" class="title">[API Docs] React Native Background Geolocation</a> <span class="tsd-flag ts-flagOptional ts-flagVersion">v 3.2.2</span> |
| 26 | + <a href="../globals.html" class="title">[API Docs] React Native Background Geolocation</a> <span class="tsd-flag ts-flagOptional ts-flagVersion">v 3.3.0</span> |
27 | 27 | </div>
|
28 | 28 | <div class="" id="tsd-widgets">
|
29 | 29 | <a class="github" href="https://github.com/transistorsoft/react-native-background-geolocation">Github</a>
|
@@ -310,8 +310,10 @@ <h3>Methods</h3>
|
310 | 310 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#destroylog" class="tsd-kind-icon">destroy<wbr>Log</a></li>
|
311 | 311 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#emaillog" class="tsd-kind-icon">email<wbr>Log</a></li>
|
312 | 312 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#finish" class="tsd-kind-icon">finish</a></li>
|
| 313 | + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#geofenceexists" class="tsd-kind-icon">geofence<wbr>Exists</a></li> |
313 | 314 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#getcount" class="tsd-kind-icon">get<wbr>Count</a></li>
|
314 | 315 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#getcurrentposition" class="tsd-kind-icon">get<wbr>Current<wbr>Position</a></li>
|
| 316 | + <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#getgeofence" class="tsd-kind-icon">get<wbr>Geofence</a></li> |
315 | 317 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#getgeofences" class="tsd-kind-icon">get<wbr>Geofences</a></li>
|
316 | 318 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#getlocations" class="tsd-kind-icon">get<wbr>Locations</a></li>
|
317 | 319 | <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_react_native_background_geolocation_.backgroundgeolocation.html#getlog" class="tsd-kind-icon">get<wbr>Log</a></li>
|
@@ -1707,6 +1709,62 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
|
1707 | 1709 | </li>
|
1708 | 1710 | </ul>
|
1709 | 1711 | </section>
|
| 1712 | + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> |
| 1713 | + <a name="geofenceexists" class="tsd-anchor"></a> |
| 1714 | + <h3><span class="tsd-flag ts-flagStatic">Static</span> geofence<wbr>Exists</h3> |
| 1715 | + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> |
| 1716 | + <li class="tsd-signature tsd-kind-icon">geofence<wbr>Exists<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, callback<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li> |
| 1717 | + </ul> |
| 1718 | + <ul class="tsd-descriptions"> |
| 1719 | + <li class="tsd-description"> |
| 1720 | + <aside class="tsd-sources"> |
| 1721 | + </aside> |
| 1722 | + <div class="tsd-comment tsd-typography"> |
| 1723 | + <div class="lead"> |
| 1724 | + <p>Determine if a particular geofence exists in the SDK's database.</p> |
| 1725 | + </div> |
| 1726 | + <dl class="tsd-comment-tags"> |
| 1727 | + <dt class="tsd-comment-tag-example">example</dt> |
| 1728 | + <dd><pre><code class="language-javascript"><span class="hljs-keyword">let</span> exists = <span class="hljs-keyword">await</span> BackgroundGeolocation.geofenceExists(<span class="hljs-string">"HOME"</span>); |
| 1729 | +<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'[geofenceExists] '</span>, exists);</code></pre> |
| 1730 | + <h3 id="-see-also-">ℹ️ See also:</h3> |
| 1731 | + <ul> |
| 1732 | + <li>📘 <a href="../interfaces/_react_native_background_geolocation_.geofence.html">Geofence</a> Guide.</li> |
| 1733 | + </ul> |
| 1734 | + </dd> |
| 1735 | + </dl> |
| 1736 | + </div> |
| 1737 | + <h4 class="tsd-parameters-title">Parameters</h4> |
| 1738 | + <ul class="tsd-parameters"> |
| 1739 | + <li> |
| 1740 | + <h5>identifier: <span class="tsd-signature-type">string</span></h5> |
| 1741 | + </li> |
| 1742 | + <li> |
| 1743 | + <h5><span class="tsd-flag ts-flagOptional">Optional</span> callback: <span class="tsd-signature-type">function</span></h5> |
| 1744 | + <ul class="tsd-parameters"> |
| 1745 | + <li class="tsd-parameter-siganture"> |
| 1746 | + <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> |
| 1747 | + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>exists<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> |
| 1748 | + </ul> |
| 1749 | + <ul class="tsd-descriptions"> |
| 1750 | + <li class="tsd-description"> |
| 1751 | + <h4 class="tsd-parameters-title">Parameters</h4> |
| 1752 | + <ul class="tsd-parameters"> |
| 1753 | + <li> |
| 1754 | + <h5>exists: <span class="tsd-signature-type">boolean</span></h5> |
| 1755 | + </li> |
| 1756 | + </ul> |
| 1757 | + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 1758 | + </li> |
| 1759 | + </ul> |
| 1760 | + </li> |
| 1761 | + </ul> |
| 1762 | + </li> |
| 1763 | + </ul> |
| 1764 | + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4> |
| 1765 | + </li> |
| 1766 | + </ul> |
| 1767 | + </section> |
1710 | 1768 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
1711 | 1769 | <a name="getcount" class="tsd-anchor"></a>
|
1712 | 1770 | <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Count</h3>
|
@@ -1852,6 +1910,83 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
|
1852 | 1910 | </li>
|
1853 | 1911 | </ul>
|
1854 | 1912 | </section>
|
| 1913 | + <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"> |
| 1914 | + <a name="getgeofence" class="tsd-anchor"></a> |
| 1915 | + <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Geofence</h3> |
| 1916 | + <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"> |
| 1917 | + <li class="tsd-signature tsd-kind-icon">get<wbr>Geofence<span class="tsd-signature-symbol">(</span>identifier<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, success<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">function</span>, failure<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_react_native_background_geolocation_.geofence.html" class="tsd-signature-type">Geofence</a><span class="tsd-signature-symbol">></span></li> |
| 1918 | + </ul> |
| 1919 | + <ul class="tsd-descriptions"> |
| 1920 | + <li class="tsd-description"> |
| 1921 | + <aside class="tsd-sources"> |
| 1922 | + </aside> |
| 1923 | + <div class="tsd-comment tsd-typography"> |
| 1924 | + <div class="lead"> |
| 1925 | + <p>Fetch a single <a href="../interfaces/_react_native_background_geolocation_.geofence.html">Geofence</a> by identifier from the SDK's database.</p> |
| 1926 | + </div> |
| 1927 | + <dl class="tsd-comment-tags"> |
| 1928 | + <dt class="tsd-comment-tag-example">example</dt> |
| 1929 | + <dd><pre><code class="language-javascript"><span class="hljs-keyword">let</span> geofence = <span class="hljs-keyword">await</span> BackgroundGeolocation.getGeofence(<span class="hljs-string">"HOME"</span>); |
| 1930 | +<span class="hljs-built_in">console</span>.log(<span class="hljs-string">'[getGeofence] '</span>, geofence);</code></pre> |
| 1931 | + <h3 id="-see-also-">ℹ️ See also:</h3> |
| 1932 | + <ul> |
| 1933 | + <li>📘 <a href="../interfaces/_react_native_background_geolocation_.geofence.html">Geofence</a> Guide.</li> |
| 1934 | + </ul> |
| 1935 | + </dd> |
| 1936 | + </dl> |
| 1937 | + </div> |
| 1938 | + <h4 class="tsd-parameters-title">Parameters</h4> |
| 1939 | + <ul class="tsd-parameters"> |
| 1940 | + <li> |
| 1941 | + <h5>identifier: <span class="tsd-signature-type">string</span></h5> |
| 1942 | + </li> |
| 1943 | + <li> |
| 1944 | + <h5><span class="tsd-flag ts-flagOptional">Optional</span> success: <span class="tsd-signature-type">function</span></h5> |
| 1945 | + <ul class="tsd-parameters"> |
| 1946 | + <li class="tsd-parameter-siganture"> |
| 1947 | + <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> |
| 1948 | + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>geofence<span class="tsd-signature-symbol">: </span><a href="../interfaces/_react_native_background_geolocation_.geofence.html" class="tsd-signature-type">Geofence</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> |
| 1949 | + </ul> |
| 1950 | + <ul class="tsd-descriptions"> |
| 1951 | + <li class="tsd-description"> |
| 1952 | + <h4 class="tsd-parameters-title">Parameters</h4> |
| 1953 | + <ul class="tsd-parameters"> |
| 1954 | + <li> |
| 1955 | + <h5>geofence: <a href="../interfaces/_react_native_background_geolocation_.geofence.html" class="tsd-signature-type">Geofence</a></h5> |
| 1956 | + </li> |
| 1957 | + </ul> |
| 1958 | + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 1959 | + </li> |
| 1960 | + </ul> |
| 1961 | + </li> |
| 1962 | + </ul> |
| 1963 | + </li> |
| 1964 | + <li> |
| 1965 | + <h5><span class="tsd-flag ts-flagOptional">Optional</span> failure: <span class="tsd-signature-type">function</span></h5> |
| 1966 | + <ul class="tsd-parameters"> |
| 1967 | + <li class="tsd-parameter-siganture"> |
| 1968 | + <ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported"> |
| 1969 | + <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> |
| 1970 | + </ul> |
| 1971 | + <ul class="tsd-descriptions"> |
| 1972 | + <li class="tsd-description"> |
| 1973 | + <h4 class="tsd-parameters-title">Parameters</h4> |
| 1974 | + <ul class="tsd-parameters"> |
| 1975 | + <li> |
| 1976 | + <h5>error: <span class="tsd-signature-type">string</span></h5> |
| 1977 | + </li> |
| 1978 | + </ul> |
| 1979 | + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> |
| 1980 | + </li> |
| 1981 | + </ul> |
| 1982 | + </li> |
| 1983 | + </ul> |
| 1984 | + </li> |
| 1985 | + </ul> |
| 1986 | + <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_react_native_background_geolocation_.geofence.html" class="tsd-signature-type">Geofence</a><span class="tsd-signature-symbol">></span></h4> |
| 1987 | + </li> |
| 1988 | + </ul> |
| 1989 | + </section> |
1855 | 1990 | <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
1856 | 1991 | <a name="getgeofences" class="tsd-anchor"></a>
|
1857 | 1992 | <h3><span class="tsd-flag ts-flagStatic">Static</span> get<wbr>Geofences</h3>
|
@@ -4242,12 +4377,18 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
|
4242 | 4377 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
4243 | 4378 | <a href="_react_native_background_geolocation_.backgroundgeolocation.html#finish" class="tsd-kind-icon">finish</a>
|
4244 | 4379 | </li>
|
| 4380 | + <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> |
| 4381 | + <a href="_react_native_background_geolocation_.backgroundgeolocation.html#geofenceexists" class="tsd-kind-icon">geofence<wbr>Exists</a> |
| 4382 | + </li> |
4245 | 4383 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
4246 | 4384 | <a href="_react_native_background_geolocation_.backgroundgeolocation.html#getcount" class="tsd-kind-icon">get<wbr>Count</a>
|
4247 | 4385 | </li>
|
4248 | 4386 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
4249 | 4387 | <a href="_react_native_background_geolocation_.backgroundgeolocation.html#getcurrentposition" class="tsd-kind-icon">get<wbr>Current<wbr>Position</a>
|
4250 | 4388 | </li>
|
| 4389 | + <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static"> |
| 4390 | + <a href="_react_native_background_geolocation_.backgroundgeolocation.html#getgeofence" class="tsd-kind-icon">get<wbr>Geofence</a> |
| 4391 | + </li> |
4251 | 4392 | <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
|
4252 | 4393 | <a href="_react_native_background_geolocation_.backgroundgeolocation.html#getgeofences" class="tsd-kind-icon">get<wbr>Geofences</a>
|
4253 | 4394 | </li>
|
@@ -4429,6 +4570,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
|
4429 | 4570 | <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
4430 | 4571 | <a href="../modules/_react_native_background_geolocation_.html#authorizationstatus" class="tsd-kind-icon">Authorization<wbr>Status</a>
|
4431 | 4572 | </li>
|
| 4573 | + <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"> |
| 4574 | + <a href="../modules/_react_native_background_geolocation_.html#extras" class="tsd-kind-icon">Extras</a> |
| 4575 | + </li> |
4432 | 4576 | <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
|
4433 | 4577 | <a href="../modules/_react_native_background_geolocation_.html#httpmethod" class="tsd-kind-icon">Http<wbr>Method</a>
|
4434 | 4578 | </li>
|
|
0 commit comments