Disruptive/docs/index.html at master · vegather/Disruptive

570 lines (512 loc) · 18.8 KB
<!DOCTYPE html>
<html lang="en">
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Disruptive - Disruptive</title>
    <link rel="stylesheet" type="text/css" href="https://vegather.github.io/Disruptive/all.css" media="all" />
    <header>
        <a href="https://vegather.github.io/Disruptive/">
            <strong>
                Disruptive
            </strong>
            <span>Documentation</span>
        </a>
    </header>
    <form class="search">
        <input type="search" placeholder="Search" />
    </form>
        <div class="wrapper">
            <h2>On This Page</h2>
            <ol><li><a href="#classes">Classes</a></li><li><a href="#structures">Structures</a></li><li><a href="#enumerations">Enumerations</a></li><li><a href="#protocols">Protocols</a></li><li><a href="#functions">Functions</a></li></ol>
        </div>
        <article>
                <section id="classes">
        <h2>Classes</h2>
        <dl>
            <dt class="class">
    <a href="https://vegather.github.io/Disruptive/BasicAuthAuthenticator" title="class - BasicAuthAuthenticator">
        Basic​Auth​Authenticator
    <p>An <code>Authenticator</code> that logs in a service account using basic auth.</p>
<dt class="class">
    <a href="https://vegather.github.io/Disruptive/OAuth2Authenticator" title="class - OAuth2Authenticator">
        OAuth2Authenticator
    <p>An <code>Authenticator</code> that logs in a service account using OAuth2 with a JWT Bearer Token as an authorization grant.
This is a more secure flow than the basic auth counter-part, and is the recommended way to authenticate
a service account in a production environment.</p>
<dt class="class">
    <a href="https://vegather.github.io/Disruptive/DeviceEventStream" title="class - DeviceEventStream">
        Device​Event​Stream
    <p>Represent an event stream for a device, and is implemented using <a href="https://html.spec.whatwg.org/multipage/server-sent-events.html">Server-Sent Events</a>.</p>
        </dl>
    </section>
    <section id="structures">
        <h2>Structures</h2>
        <dl>
            <dt class="structure">
    <a href="https://vegather.github.io/Disruptive/Disruptive" title="structure - Disruptive">
        Disruptive
    <p>This is the core of the <code>Disruptive</code> Swift API, and implements the majority of the Disruptive Technologies REST API endpoints.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/ServiceAccountCredentials" title="structure - ServiceAccountCredentials">
        Service​Account​Credentials
    <p>A set of <code>ServiceAccountCredentials</code> is used to authenticate against the Disruptive Technologies API.
It can be created in <a href="https://studio.disruptive-technologies.com">DT Studio</a> by clicking
the <code>Service Account</code> tab under <code>API Integrations</code> in the side menu, and creating a new key.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/Auth" title="structure - Auth">
        Auth
    <p>Encapsulates authentication details like access token and expiration date.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/TouchEvent" title="structure - TouchEvent">
        Touch​Event
    <p>An event that is sent whenever a device is touched. This event is sent for almost all the
available device types (except a few like the counting sensors).</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/TemperatureEvent" title="structure - TemperatureEvent">
        Temperature​Event
    <p>A temperature event that is sent for temperature sensors every heartbeat, and whenever the sensor is touched.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/TemperatureEvent_TemperatureSample" title="structure - TemperatureEvent.TemperatureSample">
        Temperature​Event.​Temperature​Sample
    <p>Represents a temperature value sampled within a single heartbeat.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/ObjectPresentEvent" title="structure - ObjectPresentEvent">
        Object​Present​Event
    <p>An event that is sent whenever an object is close to a proximity sensor or not.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/HumidityEvent" title="structure - HumidityEvent">
        Humidity​Event
    <p>A humidity event that is sent for humidity sensors every heartbeat, and whenever the
sensor is touched. This event contains both the measured temperature as well as the relative humidity.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/ObjectPresentCountEvent" title="structure - ObjectPresentCountEvent">
        Object​Present​Count​Event
    <p>An event that includes the accumulated count of proximity state changes for a
Counting Proximity sensor. These events are sent every heartbeat, and <em>not</em> when
the sensor is touched or when the state is switched (to save battery life).</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/TouchCountEvent" title="structure - TouchCountEvent">
        Touch​Count​Event
    <p>An event that includes the accumulated count of touches for a Counting Touch sensor.
These events are sent every heartbeat, and <em>not</em> when the sensor is touched (to save battery life).</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/WaterPresentEvent" title="structure - WaterPresentEvent">
        Water​Present​Event
    <p>An event that indicates whether or not water is present to a Water Detector sensor.
This event is sent every heartbeat, and when the sensor is touched.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/NetworkStatusEvent" title="structure - NetworkStatusEvent">
        Network​Status​Event
    <p>A network status event describes which Cloud Connectors a sensor is connected to, and how strong
that connection is. A network status event is sent on every heartbeat, as well as when a sensor is touched.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/NetworkStatusEvent_CloudConnector" title="structure - NetworkStatusEvent.CloudConnector">
        Network​Status​Event.​Cloud​Connector
    <p>A Cloud Connector that picked a network status event for a sensor.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/BatteryStatusEvent" title="structure - BatteryStatusEvent">
        Battery​Status​Event
    <p>A battery status event is sent quite rarely since the battery life of the sensors lasts up to 15 years. It indicates how much battery life is left in the sensor.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/LabelsChangedEvent" title="structure - LabelsChangedEvent">
        Labels​Changed​Event
    <p>Labels changed events are sent when the labels for a device are changed (added, deleted, or modified).</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/ConnectionStatusEvent" title="structure - ConnectionStatusEvent">
        Connection​Status​Event
    <p>Indicates the current connectivity of a Cloud Connector. This is sent when there is a
change in the connectivity of a Cloud Connector.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/EthernetStatusEvent" title="structure - EthernetStatusEvent">
        Ethernet​Status​Event
    <p>Details about the current ethernet connection status of a Cloud Connector.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/EthernetStatusEvent_ErrorMessage" title="structure - EthernetStatusEvent.ErrorMessage">
        Ethernet​Status​Event.​Error​Message
    <p>Indicates an error related to connecting to the local network.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/CellularStatusEvent" title="structure - CellularStatusEvent">
        Cellular​Status​Event
    <p>Details about the current cellular connection status of a Cloud Connector.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/CellularStatusEvent_ErrorMessage" title="structure - CellularStatusEvent.ErrorMessage">
        Cellular​Status​Event.​Error​Message
    <p>Indicates an error related to connecting to the cellular network.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/DataConnector" title="structure - DataConnector">
        Data​Connector
    <p>A Data Connector is a mechanism to send device events in real-time from Disruptive Technologies' backend
to an external service. It can be set up to send specific types of events to a configurable endpoint through an
HTTP POST request.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/DataConnector_Metrics" title="structure - DataConnector.Metrics">
        Data​Connector.​Metrics
    <p>Represents the metrics such as success-rate and latency for the past 3 hours of a Data Connector.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/Device" title="structure - Device">
        Device
    <p>Represents a Sensor or Cloud Connector from Disruptive Technologies.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/Device_ReportedEvents" title="structure - Device.ReportedEvents">
        Device.​Reported​Events
    <p>Represents the latest known reported values for a <code>Device</code>. Any of the event types that is not available for that particular device type, or that have not yet received an event, will be <code>nil</code>.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/Events" title="structure - Events">
        Events
    <p>Contains an array of events for each type of event for a specific <code>Device</code>.  Detailed documentation for each event type can be found on Disruptive Technologies' <a href="https://developer.disruptive-technologies.com/docs/concepts/events">developer website</a>.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/Member" title="structure - Member">
        Member
    <p>A <code>Member</code> assigns a specific role to an account within a project
or an organization. The account can be either a user or a service account.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/Organization" title="structure - Organization">
        Organization
    <p>Represents an organization registered with Disruptive Technologies.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/Project" title="structure - Project">
        Project
    <p>Represents a project within an <code>Organization</code>.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/Role" title="structure - Role">
        Role
    <p>Represents a role that a user can have within a project or an organization.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/ServiceAccount" title="structure - ServiceAccount">
        Service​Account
    <p>All programmatic interaction with the Disruptive Technologies API is done via a logged-in Service Account.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/ServiceAccount_Key" title="structure - ServiceAccount.Key">
        Service​Account.​Key
    <p>A key that can be used to authenticate a Service Account.</p>
<dt class="structure">
    <a href="https://vegather.github.io/Disruptive/ServiceAccount_KeySecret" title="structure - ServiceAccount.KeySecret">
        Service​Account.​Key​Secret
    <p>A secret along with the corresponding key used to authenticate a Service Account.
This is the response value for when a new key is created for a Service Account.</p>
        </dl>
    </section>
    <section id="enumerations">
        <h2>Enumerations</h2>
        <dl>
            <dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/LogLevel" title="enumeration - LogLevel">
        Log​Level
    <p>The severity of the log. Might be used to prefix
the log message with a symbol to make it easily
distinguishable.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/DisruptiveError" title="enumeration - DisruptiveError">
        Disruptive​Error
    <p>An enumeration of all the possible errors that could occur by calling one of the endpoints.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/EventType" title="enumeration - EventType">
        Event​Type
    <p>An enumeration of all the possible types of events that a device can emit.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/ObjectPresentEvent_State" title="enumeration - ObjectPresentEvent.State">
        Object​Present​Event.​State
    <p>The proximity state of a sensor.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/WaterPresentEvent_State" title="enumeration - WaterPresentEvent.State">
        Water​Present​Event.​State
    <p>The water presence state of a sensor.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/NetworkStatusEvent_TransmissionMode" title="enumeration - NetworkStatusEvent.TransmissionMode">
        Network​Status​Event.​Transmission​Mode
    <p>The transmission mode the sensor is currently in. The sensor will automatically switch
transmission modes when the sensor has low connectivity to a Cloud Connector.
See the <a href="https://support.disruptive-technologies.com/hc/en-us/articles/360003182914-What-is-Boost-high-power-boost-mode-">Help Center</a> for more details.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/ConnectionStatusEvent_Connection" title="enumeration - ConnectionStatusEvent.Connection">
        Connection​Status​Event.​Connection
    <p>Indicates the current connectivity of a Cloud Connector.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/ConnectionStatusEvent_Available" title="enumeration - ConnectionStatusEvent.Available">
        Connection​Status​Event.​Available
    <p>Indicates a connectivity that is available for a Cloud Connector.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/DataConnector_Status" title="enumeration - DataConnector.Status">
        Data​Connector.​Status
    <p>The current status of a Data Connector. This will indicate whether or
not the Data Connector is currently sending out events.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/DataConnector_PushType" title="enumeration - DataConnector.PushType">
        Data​Connector.​Push​Type
    <p>The mechanism used by a Data Connector to push device events to an external service.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/Device_DeviceType" title="enumeration - Device.DeviceType">
        Device.​Device​Type
    <p>Represents the type of a <code>Device</code>.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/Member_Status" title="enumeration - Member.Status">
        Member.​Status
    <p>Indicates the current status of the membership.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/Member_AccountType" title="enumeration - Member.AccountType">
        Member.​Account​Type
    <p>The type of account the membership represents.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/Permission" title="enumeration - Permission">
        Permission
    <p>A permission is a specific action that an authenticated account is allowed to do within
a specific project or organization.</p>
<dt class="enumeration">
    <a href="https://vegather.github.io/Disruptive/Role_RoleType" title="enumeration - Role.RoleType">
        Role.​Role​Type
    <p>The level of access that is given to a role.</p>
        </dl>
    </section>
    <section id="protocols">
        <h2>Protocols</h2>
        <dl>
            <dt class="protocol">
    <a href="https://vegather.github.io/Disruptive/Authenticator" title="protocol - Authenticator">
        Authenticator
    <p>Defines the interface required to authenticate the <code>Disruptive</code> struct.</p>
<dt class="protocol">
    <a href="https://vegather.github.io/Disruptive/PublishableEvent" title="protocol - PublishableEvent">
        Publishable​Event
    <p>Used by event types (such as <code>TouchEvent</code>) to indicate that
they can be published to the device emulator.</p>
        </dl>
    </section>
    <section id="functions">
        <h2>Functions</h2>
        <dl>
            <dt class="function">
    <a href="https://vegather.github.io/Disruptive/DTLog(__level_filePath_functionName_lineNumber_)" title="function - DTLog(_:level:filePath:functionName:lineNumber:)">
        DTLog(_:​level:​file​Path:​function​Name:​line​Number:​)
    <p>Provides a nicely formatted log output with the file, function, and line number the
log statement came from. Also includes a timestamp with millisecond accuracy.</p>
        </dl>
    </section>
        </article>
    </main>
    <footer>
        <p>
    Generated on <time datetime="2021-08-20T12:27:59+0000">August 20, 2021</time> using <a href="https://github.com/SwiftDocOrg/swift-doc">swift-doc</a> <span class="version">1.0.0-rc.1</span>.
    </footer>
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls
