diff options
Diffstat (limited to 'docs/Classes/SDLAppHMIType.html')
| -rw-r--r-- | docs/Classes/SDLAppHMIType.html | 302 |
1 files changed, 302 insertions, 0 deletions
diff --git a/docs/Classes/SDLAppHMIType.html b/docs/Classes/SDLAppHMIType.html new file mode 100644 index 000000000..36206fd86 --- /dev/null +++ b/docs/Classes/SDLAppHMIType.html @@ -0,0 +1,302 @@ +<h1>SDLAppHMIType Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-+valueOf:">+valueOf:</a></li> + <li><a href="#section-+values">+values</a></li> + <li><a href="#section-+DEFAULT">+DEFAULT</a></li> + <li><a href="#section-+COMMUNICATION">+COMMUNICATION</a></li> + <li><a href="#section-+MEDIA">+MEDIA</a></li> + <li><a href="#section-+MESSAGING">+MESSAGING</a></li> + <li><a href="#section-+NAVIGATION">+NAVIGATION</a></li> + <li><a href="#section-+INFORMATION">+INFORMATION</a></li> + <li><a href="#section-+SOCIAL">+SOCIAL</a></li> + <li><a href="#section-+BACKGROUND_PROCESS">+BACKGROUND_PROCESS</a></li> + <li><a href="#section-+TESTING">+TESTING</a></li> + <li><a href="#section-+SYSTEM">+SYSTEM</a></li> +</ul> + +<h3>Overview</h3> + +<p>Enumeration listing possible app hmi types.</p> + +<p>@since SDL 2.0</p> + + +<section class="section task-group-section"> + <h3> + +valueOf: + </h3> + + <p>@abstract Convert String to AppHMIType</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">valueOf</span><span class="p">(</span><span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>value</dt> + <dd><p>The value of the string to get an object for</p> +</dd> + </dl> + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType</p> + + </div> + + <h3> + +values + </h3> + + <p>@abstract Store the enumeration of all possible SDLAppHMIType</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">AnyObject</span><span class="p">]</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>an array that store all possible SDLAppHMIType</p> + + </div> + + <h3> + +DEFAULT + </h3> + + <p>@abstract The App will have default rights.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">DEFAULT</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">DEFAULT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>DEFAULT</em></p> + + </div> + + <h3> + +COMMUNICATION + </h3> + + <p>@abstract Communication type of App</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">COMMUNICATION</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">COMMUNICATION</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>COMMUNICATION</em></p> + + </div> + + <h3> + +MEDIA + </h3> + + <p>@abstract App dealing with Media</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">MEDIA</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">MEDIA</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>MEDIA</em></p> + + </div> + + <h3> + +MESSAGING + </h3> + + <p>@abstract Messaging App</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">MESSAGING</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">MESSAGING</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>MESSAGING</em></p> + + </div> + + <h3> + +NAVIGATION + </h3> + + <p>@abstract Navigation App</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">NAVIGATION</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">NAVIGATION</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>NAVIGATION</em></p> + + </div> + + <h3> + +INFORMATION + </h3> + + <p>@abstract Information App</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">INFORMATION</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">INFORMATION</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>INFORMATION</em></p> + + </div> + + <h3> + +SOCIAL + </h3> + + <p>@abstract App dealing with social media</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">SOCIAL</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">SOCIAL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>SOCIAL</em></p> + + </div> + + <h3> + +BACKGROUND_PROCESS + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAppHMIType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + + + + + + <h3> + +TESTING + </h3> + + <p>@abstract App only for Testing purposes</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">TESTING</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">TESTING</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>TESTING</em></p> + + </div> + + <h3> + +SYSTEM + </h3> + + <p>@abstract System App</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">SYSTEM</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="kt">SYSTEM</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>SYSTEM</em></p> + + </div> + +</section> |