Skip to content

Commit

Permalink
Updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewGerber committed Jan 24, 2019
1 parent 8f31286 commit ecb0215
Show file tree
Hide file tree
Showing 19 changed files with 1,122 additions and 448 deletions.
16 changes: 13 additions & 3 deletions DocFX/api/.manifest
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@
"Sensus.Android.AndroidSensusService.#ctor": "Sensus.Android.AndroidSensusService.yml",
"Sensus.Android.AndroidSensusService.FOREGROUND_SERVICE_NOTIFICATION_ID": "Sensus.Android.AndroidSensusService.yml",
"Sensus.Android.AndroidSensusService.FROM_ON_BOOT_KEY": "Sensus.Android.AndroidSensusService.yml",
"Sensus.Android.AndroidSensusService.NOTIFICATION_ACTION_PAUSE": "Sensus.Android.AndroidSensusService.yml",
"Sensus.Android.AndroidSensusService.NOTIFICATION_ACTION_RESUME": "Sensus.Android.AndroidSensusService.yml",
"Sensus.Android.AndroidSensusService.OnBind(Android.Content.Intent)": "Sensus.Android.AndroidSensusService.yml",
"Sensus.Android.AndroidSensusService.OnCreate": "Sensus.Android.AndroidSensusService.yml",
"Sensus.Android.AndroidSensusService.OnDestroy": "Sensus.Android.AndroidSensusService.yml",
Expand Down Expand Up @@ -163,6 +165,9 @@
"Sensus.Android.Context.AndroidSensusContext.Platform": "Sensus.Android.Context.AndroidSensusContext.yml",
"Sensus.Android.Context.AndroidSensusContext.PowerConnectionChangeListener": "Sensus.Android.Context.AndroidSensusContext.yml",
"Sensus.Android.Context.AndroidSensusContext.SymmetricEncryption": "Sensus.Android.Context.AndroidSensusContext.yml",
"Sensus.Android.ForegroundServiceNotificationActionReceiver": "Sensus.Android.ForegroundServiceNotificationActionReceiver.yml",
"Sensus.Android.ForegroundServiceNotificationActionReceiver.#ctor": "Sensus.Android.ForegroundServiceNotificationActionReceiver.yml",
"Sensus.Android.ForegroundServiceNotificationActionReceiver.OnReceive(Android.Content.Context,Android.Content.Intent)": "Sensus.Android.ForegroundServiceNotificationActionReceiver.yml",
"Sensus.Android.Notifications": "Sensus.Android.Notifications.yml",
"Sensus.Android.Notifications.AndroidNotifier": "Sensus.Android.Notifications.AndroidNotifier.yml",
"Sensus.Android.Notifications.AndroidNotifier.#ctor(Sensus.Android.AndroidSensusService)": "Sensus.Android.Notifications.AndroidNotifier.yml",
Expand Down Expand Up @@ -3504,6 +3509,8 @@
"Sensus.Extensions.UriExtensions": "Sensus.Extensions.UriExtensions.yml",
"Sensus.Extensions.UriExtensions.DownloadBytes(System.Uri)": "Sensus.Extensions.UriExtensions.yml",
"Sensus.Extensions.UriExtensions.DownloadString(System.Uri)": "Sensus.Extensions.UriExtensions.yml",
"Sensus.Extensions.WebRequestExtensions": "Sensus.Extensions.WebRequestExtensions.yml",
"Sensus.Extensions.WebRequestExtensions.GetResponseAsync(System.Net.WebRequest,System.Nullable{System.TimeSpan})": "Sensus.Extensions.WebRequestExtensions.yml",
"Sensus.HealthTestResult": "Sensus.HealthTestResult.yml",
"Sensus.HealthTestResult.Okay": "Sensus.HealthTestResult.yml",
"Sensus.HealthTestResult.Restart": "Sensus.HealthTestResult.yml",
Expand Down Expand Up @@ -4345,12 +4352,12 @@
"Sensus.Probes.Location.EstimoteBeaconProbe.DisplayName": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.EstimoteCloudAppId": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.EstimoteCloudAppToken": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.GetBeaconTagsFromCloud": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.GetBeaconTagsFromCloudAsync(System.Nullable{System.TimeSpan})": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.GetChartDataPointFromDatum(Sensus.Datum)": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.GetChartPrimaryAxis": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.GetChartSecondaryAxis": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.GetChartSeries": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.GetLocationsFromCloud": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.GetLocationsFromCloudAsync(System.Nullable{System.TimeSpan})": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.IndoorLocationUpdateIntervalMS": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.InitializeAsync": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
"Sensus.Probes.Location.EstimoteBeaconProbe.Location": "Sensus.Probes.Location.EstimoteBeaconProbe.yml",
Expand Down Expand Up @@ -5361,6 +5368,7 @@
"Sensus.Protocol.AllowLocalDataShare": "Sensus.Protocol.yml",
"Sensus.Protocol.AllowParticipantIdReset": "Sensus.Protocol.yml",
"Sensus.Protocol.AllowParticipationScanning": "Sensus.Protocol.yml",
"Sensus.Protocol.AllowPause": "Sensus.Protocol.yml",
"Sensus.Protocol.AllowSubmitData": "Sensus.Protocol.yml",
"Sensus.Protocol.AllowTagging": "Sensus.Protocol.yml",
"Sensus.Protocol.AllowViewData": "Sensus.Protocol.yml",
Expand Down Expand Up @@ -5407,13 +5415,15 @@
"Sensus.Protocol.Participation": "Sensus.Protocol.yml",
"Sensus.Protocol.ParticipationHorizon": "Sensus.Protocol.yml",
"Sensus.Protocol.ParticipationHorizonDays": "Sensus.Protocol.yml",
"Sensus.Protocol.PauseAsync": "Sensus.Protocol.yml",
"Sensus.Protocol.PointsOfInterest": "Sensus.Protocol.yml",
"Sensus.Protocol.Probes": "Sensus.Protocol.yml",
"Sensus.Protocol.PropertyChanged": "Sensus.Protocol.yml",
"Sensus.Protocol.PushNotificationsHub": "Sensus.Protocol.yml",
"Sensus.Protocol.PushNotificationsSharedAccessSignature": "Sensus.Protocol.yml",
"Sensus.Protocol.RandomTimeAnchor": "Sensus.Protocol.yml",
"Sensus.Protocol.RemoteDataStore": "Sensus.Protocol.yml",
"Sensus.Protocol.ResumeAsync": "Sensus.Protocol.yml",
"Sensus.Protocol.RewardThreshold": "Sensus.Protocol.yml",
"Sensus.Protocol.RunUiTestingProtocolAsync(System.IO.Stream)": "Sensus.Protocol.yml",
"Sensus.Protocol.Save(System.String)": "Sensus.Protocol.yml",
Expand Down Expand Up @@ -5457,6 +5467,7 @@
"Sensus.ProtocolStartConfirmationMode.RandomDigits": "Sensus.ProtocolStartConfirmationMode.yml",
"Sensus.ProtocolStartConfirmationMode.value__": "Sensus.ProtocolStartConfirmationMode.yml",
"Sensus.ProtocolState": "Sensus.ProtocolState.yml",
"Sensus.ProtocolState.Paused": "Sensus.ProtocolState.yml",
"Sensus.ProtocolState.Running": "Sensus.ProtocolState.yml",
"Sensus.ProtocolState.Starting": "Sensus.ProtocolState.yml",
"Sensus.ProtocolState.Stopped": "Sensus.ProtocolState.yml",
Expand Down Expand Up @@ -5523,7 +5534,6 @@
"Sensus.SensusServiceHelper.PromptForInputsAsync(System.String,System.Collections.Generic.IEnumerable{Sensus.UI.Inputs.Input},System.Nullable{System.Threading.CancellationToken},System.Boolean,System.String,System.String,System.String,System.String,System.Boolean)": "Sensus.SensusServiceHelper.yml",
"Sensus.SensusServiceHelper.ProtectedFlashNotificationAsync(System.String)": "Sensus.SensusServiceHelper.yml",
"Sensus.SensusServiceHelper.PROTOCOL_UPDATED_NOTIFICATION_ID": "Sensus.SensusServiceHelper.yml",
"Sensus.SensusServiceHelper.ProtocolShouldBeRunning(Sensus.Protocol)": "Sensus.SensusServiceHelper.yml",
"Sensus.SensusServiceHelper.PushNotificationToken": "Sensus.SensusServiceHelper.yml",
"Sensus.SensusServiceHelper.ReadAllBytes(System.String)": "Sensus.SensusServiceHelper.yml",
"Sensus.SensusServiceHelper.RegisteredProtocols": "Sensus.SensusServiceHelper.yml",
Expand Down
22 changes: 20 additions & 2 deletions DocFX/articles/privacy-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,30 @@ uid: privacy_policy

# Privacy Policy

Immediately following installation, Sensus will not collect, store, or upload any personal information from the
## Data Collection

Immediately following installation, Sensus will not collect, store, or transmit any personal information from the
device on which it is running. Sensus will upload reports when the app crashes. These reports contain information
about the state of the app when it crashed, and Sensus developers will use these crash reports to improve Sensus.
These reports do not contain any personal information. After you load a study into Sensus, Sensus will begin collecting
data as defined by the study. You will be notified when the study is loaded and is about to start, and you will be
asked to confirm that you wish to start the study. This confirmation will summarize the types of data to be collected.
You may quit a study and/or uninstall Sensus at any time. Be aware that Sensus is publicly available and that anyone
can use Sensus to design a study, which they can then share with others. Studies have the ability to collect personal
information, and you should exercise caution when loading any study that you receive.
information, and you should exercise caution when loading any study that you receive.

## Data Use

Data collected in studies run by the University of Virginia are used according to the policies set forth during the consent
process, which limit use of all data to the specific purposes of the study. All data are used in aggregated analyses to protect
the privacy of participants.

## Data Sharing

Data collected in studies run by the University of Virginia are not shared in any manner whatsoever with any third parties.

## Data Retention and Deletion

Data collected in studies run by the University of Virginia are retained according to the policies set forth during
the consent process, which normally require retention for the duration of the study. You may email the study coordinator
at any time to request deletion of your data. To do this, tap the study within Sensus and select the email option.
48 changes: 48 additions & 0 deletions docs/api/Sensus.Android.AndroidSensusService.html
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,54 @@ <h5 class="fieldValue">Field Value</h5>
</tr>
</tbody>
</table>


<h4 id="Sensus_Android_AndroidSensusService_NOTIFICATION_ACTION_PAUSE" data-uid="Sensus.Android.AndroidSensusService.NOTIFICATION_ACTION_PAUSE">NOTIFICATION_ACTION_PAUSE</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string NOTIFICATION_ACTION_PAUSE = &quot;NOTIFICATION-ACTION-PAUSE&quot;</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>


<h4 id="Sensus_Android_AndroidSensusService_NOTIFICATION_ACTION_RESUME" data-uid="Sensus.Android.AndroidSensusService.NOTIFICATION_ACTION_RESUME">NOTIFICATION_ACTION_RESUME</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const string NOTIFICATION_ACTION_RESUME = &quot;NOTIFICATION-ACTION-RESUME&quot;</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>

Expand Down
3 changes: 0 additions & 3 deletions docs/api/Sensus.Android.AndroidSensusServiceHelper.html
Original file line number Diff line number Diff line change
Expand Up @@ -154,9 +154,6 @@ <h5>Inherited Members</h5>
<div>
<a class="xref" href="Sensus.SensusServiceHelper.html#Sensus_SensusServiceHelper_RemoveRunningProtocolIdAsync_System_String_">SensusServiceHelper.RemoveRunningProtocolIdAsync(String)</a>
</div>
<div>
<a class="xref" href="Sensus.SensusServiceHelper.html#Sensus_SensusServiceHelper_ProtocolShouldBeRunning_Sensus_Protocol_">SensusServiceHelper.ProtocolShouldBeRunning(Protocol)</a>
</div>
<div>
<a class="xref" href="Sensus.SensusServiceHelper.html#Sensus_SensusServiceHelper_GetRunningProtocols">SensusServiceHelper.GetRunningProtocols()</a>
</div>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,180 @@
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class ForegroundServiceNotificationActionReceiver
| Sensus Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ForegroundServiceNotificationActionReceiver
| Sensus Documentation ">
<meta name="generator" content="docfx 2.38.1.0">

<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">

<meta property="docfx:rel" content="../">

</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>

<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>

<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/group-of-members-users-icon.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>

<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">

<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">

<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Sensus.Android.ForegroundServiceNotificationActionReceiver">


<h1 id="Sensus_Android_ForegroundServiceNotificationActionReceiver" data-uid="Sensus.Android.ForegroundServiceNotificationActionReceiver" class="text-break">Class ForegroundServiceNotificationActionReceiver
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">ForegroundServiceNotificationActionReceiver</span></div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Sensus.Android.html">Sensus.Android</a></h6>
<h6><strong>Assembly</strong>: SensusAndroid.dll</h6>
<h5 id="Sensus_Android_ForegroundServiceNotificationActionReceiver_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ForegroundServiceNotificationActionReceiver : BroadcastReceiver</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>


<a id="Sensus_Android_ForegroundServiceNotificationActionReceiver__ctor_" data-uid="Sensus.Android.ForegroundServiceNotificationActionReceiver.#ctor*"></a>
<h4 id="Sensus_Android_ForegroundServiceNotificationActionReceiver__ctor" data-uid="Sensus.Android.ForegroundServiceNotificationActionReceiver.#ctor">ForegroundServiceNotificationActionReceiver()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ForegroundServiceNotificationActionReceiver()</code></pre>
</div>
<h3 id="methods">Methods
</h3>


<a id="Sensus_Android_ForegroundServiceNotificationActionReceiver_OnReceive_" data-uid="Sensus.Android.ForegroundServiceNotificationActionReceiver.OnReceive*"></a>
<h4 id="Sensus_Android_ForegroundServiceNotificationActionReceiver_OnReceive_Android_Content_Context_Android_Content_Intent_" data-uid="Sensus.Android.ForegroundServiceNotificationActionReceiver.OnReceive(Android.Content.Context,Android.Content.Intent)">OnReceive(Context, Intent)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void OnReceive(Context context, Intent intent)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">Android.Content.Context</span></td>
<td><span class="parametername">context</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Android.Content.Intent</span></td>
<td><span class="parametername">intent</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>

<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>

<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2014-2018 University of Virginia<br>Generated by <strong>DocFX</strong>

</div>
</div>
</footer>
</div>

<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>
Loading

0 comments on commit ecb0215

Please sign in to comment.