Skip to content

Commit

Permalink
Fix addGeotag() comment in docs (#103)
Browse files Browse the repository at this point in the history
  • Loading branch information
pavel-kuznetsov-hypertrack authored Apr 24, 2024
1 parent 25a7407 commit dd46c4e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/classes/HyperTrack.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,12 @@
<a href="HyperTrack.html#subscribeToIsAvailable" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>subscribe<wbr/>To<wbr/>Is<wbr/>Available</span></a>
<a href="HyperTrack.html#subscribeToIsTracking" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>subscribe<wbr/>To<wbr/>Is<wbr/>Tracking</span></a>
<a href="HyperTrack.html#subscribeToLocation" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>subscribe<wbr/>To<wbr/>Location</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_HyperTrack" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Hyper<wbr/>Track</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="HyperTrack.html" class="tsd-signature-type tsd-kind-class">HyperTrack</a><a href="#constructor.new_HyperTrack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="HyperTrack.html" class="tsd-signature-type tsd-kind-class">HyperTrack</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="locateSubscription" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>locate<wbr/>Subscription</span><a href="#locateSubscription" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">locate<wbr/>Subscription</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">EmitterSubscription</span></div></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addGeotag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>add<wbr/>Geotag</span><a href="#addGeotag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addGeotag.addGeotag-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Geotag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">orderHandle</span>, <span class="tsd-kind-parameter">orderStatus</span>, <span class="tsd-kind-parameter">data</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">&lt;</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/Location.html" class="tsd-signature-type tsd-kind-type-alias">Location</a><span class="tsd-signature-symbol">, </span><a href="../types/LocationError.html" class="tsd-signature-type tsd-kind-type-alias">LocationError</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#addGeotag.addGeotag-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new geotag</p>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_HyperTrack" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>Hyper<wbr/>Track</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="HyperTrack.html" class="tsd-signature-type tsd-kind-class">HyperTrack</a><a href="#constructor.new_HyperTrack" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="HyperTrack.html" class="tsd-signature-type tsd-kind-class">HyperTrack</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member tsd-is-private"><a id="locateSubscription" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <code class="tsd-tag ts-flagPrivate">Private</code> <span>locate<wbr/>Subscription</span><a href="#locateSubscription" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">locate<wbr/>Subscription</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">EmitterSubscription</span></div></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="addGeotag" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>add<wbr/>Geotag</span><a href="#addGeotag" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="addGeotag.addGeotag-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Geotag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">orderHandle</span>, <span class="tsd-kind-parameter">orderStatus</span>, <span class="tsd-kind-parameter">data</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">&lt;</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/Location.html" class="tsd-signature-type tsd-kind-type-alias">Location</a><span class="tsd-signature-symbol">, </span><a href="../types/LocationError.html" class="tsd-signature-type tsd-kind-type-alias">LocationError</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#addGeotag.addGeotag-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new geotag. Check <a href="https://hypertrack.com/docs/shift-tracking">Shift tracking</a> and <a href="https://hypertrack.com/docs/clock-inout-tracking">Clock In/Out tagging</a> docs to learn how to use Order handle and Order status params.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">orderHandle</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Order handle</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">orderStatus</span>: <a href="../types/OrderStatus.html" class="tsd-signature-type tsd-kind-type-alias">OrderStatus</a></h5><div class="tsd-comment tsd-typography"><p>Order status</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type ">Object</span></h5><div class="tsd-comment tsd-typography"><p>Geotag data JSON</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/Location.html" class="tsd-signature-type tsd-kind-type-alias">Location</a><span class="tsd-signature-symbol">, </span><a href="../types/LocationError.html" class="tsd-signature-type tsd-kind-type-alias">LocationError</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><p>current location if success or LocationError if failure</p>
<div class="tsd-comment tsd-typography"></div></li><li class="tsd-signature tsd-anchor-link"><a id="addGeotag.addGeotag-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Geotag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">orderHandle</span>, <span class="tsd-kind-parameter">orderStatus</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">expectedLocation</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">&lt;</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/LocationWithDeviation.html" class="tsd-signature-type tsd-kind-type-alias">LocationWithDeviation</a><span class="tsd-signature-symbol">, </span><a href="../types/LocationError.html" class="tsd-signature-type tsd-kind-type-alias">LocationError</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#addGeotag.addGeotag-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new geotag with expected location</p>
<div class="tsd-comment tsd-typography"></div></li><li class="tsd-signature tsd-anchor-link"><a id="addGeotag.addGeotag-2" class="tsd-anchor"></a><span class="tsd-kind-call-signature">add<wbr/>Geotag</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">orderHandle</span>, <span class="tsd-kind-parameter">orderStatus</span>, <span class="tsd-kind-parameter">data</span>, <span class="tsd-kind-parameter">expectedLocation</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">&lt;</span><a href="../types/Result.html" class="tsd-signature-type tsd-kind-type-alias">Result</a><span class="tsd-signature-symbol">&lt;</span><a href="../types/LocationWithDeviation.html" class="tsd-signature-type tsd-kind-type-alias">LocationWithDeviation</a><span class="tsd-signature-symbol">, </span><a href="../types/LocationError.html" class="tsd-signature-type tsd-kind-type-alias">LocationError</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#addGeotag.addGeotag-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Adds a new geotag with expected location. Check <a href="https://hypertrack.com/docs/shift-tracking">Shift tracking</a> and <a href="https://hypertrack.com/docs/clock-inout-tracking">Clock In/Out tagging</a> docs to learn how to use Order handle and Order status params.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">orderHandle</span>: <span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Order handle</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">orderStatus</span>: <a href="../types/OrderStatus.html" class="tsd-signature-type tsd-kind-type-alias">OrderStatus</a></h5><div class="tsd-comment tsd-typography"><p>Order status</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><h5><span class="tsd-kind-parameter">data</span>: <span class="tsd-signature-type ">Object</span></h5><div class="tsd-comment tsd-typography"><p>Geotag data JSON</p>
Expand Down

0 comments on commit dd46c4e

Please sign in to comment.