Skip to content

Commit

Permalink
updates to documentation, espcially high level API's.
Browse files Browse the repository at this point in the history
  • Loading branch information
@johnpcarter
johnpcarter committed Oct 14, 2020
1 parent bb582df commit 28f79e3
Show file tree
Hide file tree
Showing 251 changed files with 10,153 additions and 3,662 deletions.
3 changes: 1 addition & 2 deletions docs/include/docs/Quick Use Guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,7 @@ let conn: C8yCumulocityConnection = C8yCumulocityConnection(tenant: "<mytenant>"
```

The above first verifies the connection and uses the `C8yManagedObjectsService` class to fetch a page of `C8yManagedObject` objects. The connection object does not carry state and
the connect method is only useful to verify the credentials and also gather information about the user `C8yUserProfile`. Each call via the Service classes reconnects via the connection
credentials and stateless.
the connect method is only useful to verify the credentials and also gather information about the user `C8yUserProfile`. Each call via the Service classes reconnects via the connection credentials and is stateless.

Refer to the official [c8y Documentation](https://cumulocity.com/guides/about-doc/intro-documentation/) to better grips to the IoT and c8y concepts.

Expand Down
17 changes: 10 additions & 7 deletions docs/out/API Tools.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,15 @@
<li class="nav-group-task">
<a href="Structs/C8yGroup.html">C8yGroup</a>
</li>
<li class="nav-group-task">
<a href="Structs/C8yGroup/Info.html">– Info</a>
</li>
<li class="nav-group-task">
<a href="Structs/C8yDevice.html">C8yDevice</a>
</li>
<li class="nav-group-task">
<a href="Structs/C8yDevice/DeviceCategory.html">– DeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="Classes/C8yMutableDevice.html">C8yMutableDevice</a>
</li>
Expand All @@ -68,6 +74,9 @@
<li class="nav-group-task">
<a href="Classes/C8yMutableDevice/Measurement.html">– Measurement</a>
</li>
<li class="nav-group-task">
<a href="Classes/C8yMutableDevice/CommError.html">– CommError</a>
</li>
<li class="nav-group-task">
<a href="Classes/C8yEditableDevice.html">C8yEditableDevice</a>
</li>
Expand All @@ -83,9 +92,6 @@
<li class="nav-group-task">
<a href="Protocols/C8yObject.html">C8yObject</a>
</li>
<li class="nav-group-task">
<a href="Structs/C8yGroupInfo.html">C8yGroupInfo</a>
</li>
<li class="nav-group-task">
<a href="Classes/C8yNetworks.html">C8yNetworks</a>
</li>
Expand Down Expand Up @@ -423,9 +429,6 @@
<li class="nav-group-name">
<a href="Other%20Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/C8yDeviceCategory.html">C8yDeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="Enums/C8yGroupCategory.html">C8yGroupCategory</a>
</li>
Expand Down Expand Up @@ -656,7 +659,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-12)</p>
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-14)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
17 changes: 10 additions & 7 deletions docs/out/About.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,15 @@
<li class="nav-group-task">
<a href="Structs/C8yGroup.html">C8yGroup</a>
</li>
<li class="nav-group-task">
<a href="Structs/C8yGroup/Info.html">– Info</a>
</li>
<li class="nav-group-task">
<a href="Structs/C8yDevice.html">C8yDevice</a>
</li>
<li class="nav-group-task">
<a href="Structs/C8yDevice/DeviceCategory.html">– DeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="Classes/C8yMutableDevice.html">C8yMutableDevice</a>
</li>
Expand All @@ -68,6 +74,9 @@
<li class="nav-group-task">
<a href="Classes/C8yMutableDevice/Measurement.html">– Measurement</a>
</li>
<li class="nav-group-task">
<a href="Classes/C8yMutableDevice/CommError.html">– CommError</a>
</li>
<li class="nav-group-task">
<a href="Classes/C8yEditableDevice.html">C8yEditableDevice</a>
</li>
Expand All @@ -83,9 +92,6 @@
<li class="nav-group-task">
<a href="Protocols/C8yObject.html">C8yObject</a>
</li>
<li class="nav-group-task">
<a href="Structs/C8yGroupInfo.html">C8yGroupInfo</a>
</li>
<li class="nav-group-task">
<a href="Classes/C8yNetworks.html">C8yNetworks</a>
</li>
Expand Down Expand Up @@ -423,9 +429,6 @@
<li class="nav-group-name">
<a href="Other%20Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="Enums/C8yDeviceCategory.html">C8yDeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="Enums/C8yGroupCategory.html">C8yGroupCategory</a>
</li>
Expand Down Expand Up @@ -504,7 +507,7 @@ <h1>About</h1>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-12)</p>
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-14)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
17 changes: 10 additions & 7 deletions docs/out/Access/Update Objects.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,15 @@
<li class="nav-group-task">
<a href="../Structs/C8yGroup.html">C8yGroup</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yGroup/Info.html">– Info</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yDevice.html">C8yDevice</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yDevice/DeviceCategory.html">– DeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice.html">C8yMutableDevice</a>
</li>
Expand All @@ -68,6 +74,9 @@
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice/Measurement.html">– Measurement</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice/CommError.html">– CommError</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yEditableDevice.html">C8yEditableDevice</a>
</li>
Expand All @@ -83,9 +92,6 @@
<li class="nav-group-task">
<a href="../Protocols/C8yObject.html">C8yObject</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yGroupInfo.html">C8yGroupInfo</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yNetworks.html">C8yNetworks</a>
</li>
Expand Down Expand Up @@ -423,9 +429,6 @@
<li class="nav-group-name">
<a href="../Other%20Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/C8yDeviceCategory.html">C8yDeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="../Enums/C8yGroupCategory.html">C8yGroupCategory</a>
</li>
Expand Down Expand Up @@ -720,7 +723,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-12)</p>
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-14)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
17 changes: 10 additions & 7 deletions docs/out/Classes/C8yAlarmsService.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,15 @@
<li class="nav-group-task">
<a href="../Structs/C8yGroup.html">C8yGroup</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yGroup/Info.html">– Info</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yDevice.html">C8yDevice</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yDevice/DeviceCategory.html">– DeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice.html">C8yMutableDevice</a>
</li>
Expand All @@ -68,6 +74,9 @@
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice/Measurement.html">– Measurement</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice/CommError.html">– CommError</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yEditableDevice.html">C8yEditableDevice</a>
</li>
Expand All @@ -83,9 +92,6 @@
<li class="nav-group-task">
<a href="../Protocols/C8yObject.html">C8yObject</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yGroupInfo.html">C8yGroupInfo</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yNetworks.html">C8yNetworks</a>
</li>
Expand Down Expand Up @@ -423,9 +429,6 @@
<li class="nav-group-name">
<a href="../Other%20Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/C8yDeviceCategory.html">C8yDeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="../Enums/C8yGroupCategory.html">C8yGroupCategory</a>
</li>
Expand Down Expand Up @@ -662,7 +665,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-12)</p>
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-14)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
19 changes: 11 additions & 8 deletions docs/out/Classes/C8yAssetCollection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,15 @@
<li class="nav-group-task">
<a href="../Structs/C8yGroup.html">C8yGroup</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yGroup/Info.html">– Info</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yDevice.html">C8yDevice</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yDevice/DeviceCategory.html">– DeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice.html">C8yMutableDevice</a>
</li>
Expand All @@ -68,6 +74,9 @@
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice/Measurement.html">– Measurement</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice/CommError.html">– CommError</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yEditableDevice.html">C8yEditableDevice</a>
</li>
Expand All @@ -83,9 +92,6 @@
<li class="nav-group-task">
<a href="../Protocols/C8yObject.html">C8yObject</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yGroupInfo.html">C8yGroupInfo</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yNetworks.html">C8yNetworks</a>
</li>
Expand Down Expand Up @@ -423,9 +429,6 @@
<li class="nav-group-name">
<a href="../Other%20Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/C8yDeviceCategory.html">C8yDeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="../Enums/C8yGroupCategory.html">C8yGroupCategory</a>
</li>
Expand Down Expand Up @@ -588,7 +591,7 @@ <h4>Declaration</h4>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The connection reference that was last used to load the collection via <code>load(:c8yReferencesToLoad:includeSubGroups)</code></p>
<p>The connection reference that was last used to load the collection via <code><a href="../Classes/C8yAssetCollection.html#/s:25Cumulocity_Client_Library18C8yAssetCollectionC4load_19c8yReferencesToLoad16includeSubGroups7Combine12AnyPublisherVySayAA0pD6ObjectVGAA19JcConnectionRequestC8APIErrorVyAA0daT0C_GGARSg_SaySSGSbtKF">load(_:c8yReferencesToLoad:includeSubGroups:)</a></code></p>

</div>
<div class="declaration">
Expand Down Expand Up @@ -2204,7 +2207,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-12)</p>
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-14)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
17 changes: 10 additions & 7 deletions docs/out/Classes/C8yBinariesService.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,15 @@
<li class="nav-group-task">
<a href="../Structs/C8yGroup.html">C8yGroup</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yGroup/Info.html">– Info</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yDevice.html">C8yDevice</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yDevice/DeviceCategory.html">– DeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice.html">C8yMutableDevice</a>
</li>
Expand All @@ -68,6 +74,9 @@
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice/Measurement.html">– Measurement</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yMutableDevice/CommError.html">– CommError</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yEditableDevice.html">C8yEditableDevice</a>
</li>
Expand All @@ -83,9 +92,6 @@
<li class="nav-group-task">
<a href="../Protocols/C8yObject.html">C8yObject</a>
</li>
<li class="nav-group-task">
<a href="../Structs/C8yGroupInfo.html">C8yGroupInfo</a>
</li>
<li class="nav-group-task">
<a href="../Classes/C8yNetworks.html">C8yNetworks</a>
</li>
Expand Down Expand Up @@ -423,9 +429,6 @@
<li class="nav-group-name">
<a href="../Other%20Enums.html">Other Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/C8yDeviceCategory.html">C8yDeviceCategory</a>
</li>
<li class="nav-group-task">
<a href="../Enums/C8yGroupCategory.html">C8yGroupCategory</a>
</li>
Expand Down Expand Up @@ -518,7 +521,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-12)</p>
<p>&copy; 2020 <a class="link" href="http://johncarter.eu" target="_blank" rel="external">John Carter (john.carter@softwareag.com)</a>. All rights reserved. (Last updated: 2020-10-14)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.5</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit 28f79e3

Please sign in to comment.