StrasbourgParkAPI/docs/Structs.html

309 lines
14 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<title>Structures Reference</title>
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
<meta charset='utf-8'>
<script src="js/jquery.min.js" defer></script>
<script src="js/jazzy.js" defer></script>
<script src="js/lunr.min.js" defer></script>
<script src="js/typeahead.jquery.js" defer></script>
<script src="js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Section/Structures" class="dashAnchor"></a>
<a title="Structures Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">StrasbourgParkAPI Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/yageek/StrasbourgParkAPI"><img src="img/gh.png" alt="GitHub"/>View on GitHub</a></p>
<div class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</div>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="index.html">StrasbourgParkAPI Reference</a>
<img id="carat" src="img/carat.png" alt=""/>
Structures Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Classes/ParkingAPIClient.html">ParkingAPIClient</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums.html#/s:17StrasbourgParkAPI6EitherO">Either</a>
</li>
<li class="nav-group-task">
<a href="Enums/ParkingAPIClientError.html">ParkingAPIClientError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Protocols/CancelableRequest.html">CancelableRequest</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Structs/LocationOpenData.html">LocationOpenData</a>
</li>
<li class="nav-group-task">
<a href="Structs/LocationResponse.html">LocationResponse</a>
</li>
<li class="nav-group-task">
<a href="Structs/ParkingLocation.html">ParkingLocation</a>
</li>
<li class="nav-group-task">
<a href="Structs/ParkingLocation/Manager.html"> Manager</a>
</li>
<li class="nav-group-task">
<a href="Structs/ParkingState.html">ParkingState</a>
</li>
<li class="nav-group-task">
<a href="Structs/ParkingState/Status.html"> Status</a>
</li>
<li class="nav-group-task">
<a href="Structs/StatusOpenData.html">StatusOpenData</a>
</li>
<li class="nav-group-task">
<a href="Structs.html#/s:17StrasbourgParkAPI14StatusResponseV">StatusResponse</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>Structures</h1>
<p>The following structures are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<div class="task-name-container">
<a name="/Location%20Response"></a>
<a name="//apple_ref/swift/Section/Location Response" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Location%20Response"></a>
<h3 class="section-name"><span>Location Response</span>
</h3>
</div>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:17StrasbourgParkAPI16LocationResponseV"></a>
<a name="//apple_ref/swift/Struct/LocationResponse" class="dashAnchor"></a>
<a class="token" href="#/s:17StrasbourgParkAPI16LocationResponseV">LocationResponse</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The response from the API asking for the parkings
location</p>
<a href="Structs/LocationResponse.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">LocationResponse</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Parking%20Location"></a>
<a name="//apple_ref/swift/Section/Parking Location" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Parking%20Location"></a>
<h3 class="section-name"><span>Parking Location</span>
</h3>
</div>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:17StrasbourgParkAPI15ParkingLocationV"></a>
<a name="//apple_ref/swift/Struct/ParkingLocation" class="dashAnchor"></a>
<a class="token" href="#/s:17StrasbourgParkAPI15ParkingLocationV">ParkingLocation</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The description of a parkign location</p>
<a href="Structs/ParkingLocation.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ParkingLocation</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:17StrasbourgParkAPI12ParkingStateV"></a>
<a name="//apple_ref/swift/Struct/ParkingState" class="dashAnchor"></a>
<a class="token" href="#/s:17StrasbourgParkAPI12ParkingStateV">ParkingState</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The state of the parking</p>
<a href="Structs/ParkingState.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">ParkingState</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:17StrasbourgParkAPI14StatusResponseV"></a>
<a name="//apple_ref/swift/Struct/StatusResponse" class="dashAnchor"></a>
<a class="token" href="#/s:17StrasbourgParkAPI14StatusResponseV">StatusResponse</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The status response</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">StatusResponse</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:17StrasbourgParkAPI16LocationOpenDataV"></a>
<a name="//apple_ref/swift/Struct/LocationOpenData" class="dashAnchor"></a>
<a class="token" href="#/s:17StrasbourgParkAPI16LocationOpenDataV">LocationOpenData</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The location of the parking</p>
<a href="Structs/LocationOpenData.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">LocationOpenData</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:17StrasbourgParkAPI14StatusOpenDataV"></a>
<a name="//apple_ref/swift/Struct/StatusOpenData" class="dashAnchor"></a>
<a class="token" href="#/s:17StrasbourgParkAPI14StatusOpenDataV">StatusOpenData</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The status of the parking</p>
<a href="Structs/StatusOpenData.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">StatusOpenData</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>© 2020 <a class="link" href="https://github.com/yageek" target="_blank" rel="external noopener">Yannick Heinrich</a> under <a class="link" href="https://github.com/yageek/siesta/blob/StrasbourgParkAPI/LICENSE" target="_blank" rel="external noopener">open source license</a>.</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.14.2</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</html>