diff options
Diffstat (limited to 'docs/Classes/SDLOnLockScreenStatus.html')
| -rw-r--r-- | docs/Classes/SDLOnLockScreenStatus.html | 98 |
1 files changed, 0 insertions, 98 deletions
diff --git a/docs/Classes/SDLOnLockScreenStatus.html b/docs/Classes/SDLOnLockScreenStatus.html deleted file mode 100644 index 81838fe5b..000000000 --- a/docs/Classes/SDLOnLockScreenStatus.html +++ /dev/null @@ -1,98 +0,0 @@ -<h1>SDLOnLockScreenStatus Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-driverDistractionStatus">driverDistractionStatus</a></li> - <li><a href="#section-userSelected">userSelected</a></li> - <li><a href="#section-lockScreenStatus">lockScreenStatus</a></li> - <li><a href="#section-hmiLevel">hmiLevel</a></li> -</ul> - -<h3>Overview</h3> - -<p>To help prevent driver distraction, any SmartDeviceLink application is required to implement a lockscreen that must be enforced while the application is active on the system while the vehicle is in motion.</p> - -<p>This lockscreen must perform the following:</p> - -<p>Limit all application control usability from the mobile device with a full-screen static image overlay or separate view.</p> - -<p>For simplicity, the <code>OnLockScreenStatus</code> RPC will be provided via the <code>onOnLockScreenNotification</code> call back. The call back will include the LockScreenStatus enum which indicates if the lockscreen is required, optional or not required.</p> - -<p>The call back also includes details regarding the current HMI_Status level, driver distraction status and user selection status of the application.</p> - - -<section class="section task-group-section"> - <h3 id="section-driverDistractionStatus"> - driverDistractionStatus - </h3> - - <p>Get the current driver distraction status(i.e. whether driver distraction rules are in effect, or not)</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">driverDistractionStatus</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">driverDistractionStatus</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-userSelected"> - userSelected - </h3> - - <p>Get user selection status for the application (has the app been selected via hmi or voice command)</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">userSelected</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">userSelected</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-lockScreenStatus"> - lockScreenStatus - </h3> - - <p>Indicates if the lockscreen should be required, optional or off</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLLockScreenStatus.h@T@SDLLockScreenStatus">SDLLockScreenStatus</a></span> <span class="n">_Nonnull</span> <span class="n">lockScreenStatus</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">lockScreenStatus</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLLockScreenStatus.h@T@SDLLockScreenStatus">SDLLockScreenStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-hmiLevel"> - hmiLevel - </h3> - - <p>Get HMILevel in effect for the application</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span> <span class="n">_Nonnull</span> <span class="n">hmiLevel</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">hmiLevel</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - -</section> |