diff options
Diffstat (limited to 'docs/Classes/SDLLifecycleConfiguration.html')
| -rw-r--r-- | docs/Classes/SDLLifecycleConfiguration.html | 96 |
1 files changed, 38 insertions, 58 deletions
diff --git a/docs/Classes/SDLLifecycleConfiguration.html b/docs/Classes/SDLLifecycleConfiguration.html index dd5713f27..85fe3b465 100644 --- a/docs/Classes/SDLLifecycleConfiguration.html +++ b/docs/Classes/SDLLifecycleConfiguration.html @@ -20,8 +20,6 @@ <li><a href="#section-shortAppName">shortAppName</a></li> <li><a href="#section-ttsName">ttsName</a></li> <li><a href="#section-voiceRecognitionCommandNames">voiceRecognitionCommandNames</a></li> - <li><a href="#section-securityManagers">securityManagers</a></li> - <li><a href="#section-logFlags">logFlags</a></li> </ul> <h3>Overview</h3> @@ -60,23 +58,20 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">defaultConfiguration</span><span class="p">(</span><span class="n">withAppName</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLLifecycleConfiguration</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> <h4>Parameters</h4> <dl> <dt>appName</dt> - <dd><p>The name of the app.</p> -</dd> + <dd><p>The name of the app.</p></dd> <dt>appId</dt> - <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p> -</dd> + <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p></dd> </dl> <div> <h4>Return Value</h4> <p>The lifecycle configuration</p> - </div> <h3 id="section-+debugConfigurationWithAppName:appId:ipAddress:port:"> @@ -96,29 +91,24 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">debugConfiguration</span><span class="p">(</span><span class="n">withAppName</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">ipAddress</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLLifecycleConfiguration</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">ipAddress</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">)</span></code></pre> <h4>Parameters</h4> <dl> <dt>appName</dt> - <dd><p>The name of the app.</p> -</dd> + <dd><p>The name of the app.</p></dd> <dt>appId</dt> - <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p> -</dd> + <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p></dd> <dt>ipAddress</dt> - <dd><p>The ip address of the server to connect to</p> -</dd> + <dd><p>The ip address of the server to connect to</p></dd> <dt>port</dt> - <dd><p>The port of the server to connect to</p> -</dd> + <dd><p>The port of the server to connect to</p></dd> </dl> <div> <h4>Return Value</h4> <p>The lifecycle configuration</p> - </div> <h3 id="section-tcpDebugMode"> @@ -134,7 +124,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugMode</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugMode</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -152,6 +142,9 @@ <span class="n">NSString</span> <span class="o">*</span><span class="n">tcpDebugIPAddress</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugIPAddress</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -168,7 +161,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugPort</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugPort</span><span class="p">:</span> <span class="kt">UInt16</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -185,6 +178,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appName</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -200,6 +196,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appId</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -215,6 +214,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">resumeHash</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">resumeHash</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -231,7 +233,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">isMedia</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isMedia</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -245,11 +247,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">null_resettable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAppHMIType.html">SDLAppHMIType</a></span> <span class="o">*</span><span class="n">appType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">null_resettable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span> <span class="n">appType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">appType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAppHMIType.html">SDLAppHMIType</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">appType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -263,11 +265,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">language</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">_Nonnull</span> <span class="n">language</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -282,9 +284,12 @@ <h4>Objective-C</h4> <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> - <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">languagesSupported</span><span class="p">;</span></code></pre> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">languagesSupported</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">languagesSupported</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -318,6 +323,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">shortAppName</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">shortAppName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -333,6 +341,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">ttsName</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ttsName</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -349,39 +360,8 @@ <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">voiceRecognitionCommandNames</span><span class="p">;</span></code></pre> - - - - <h3 id="section-securityManagers"> - securityManagers - </h3> - - <p>Set security managers which could be used. This is primarily used with video streaming applications to authenticate and perhaps encrypt traffic data.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> - <span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">>></span> <span class="o">*</span><span class="n">securityManagers</span><span class="p">;</span></code></pre> - - - - - - <h3 id="section-logFlags"> - logFlags - </h3> - - <p>Which logging capabilities are currently enabled. The default is Console logging only.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogOutput.html">SDLLogOutput</a></span> <span class="n">logFlags</span><span class="p">;</span></code></pre> - - <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">logFlags</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">voiceRecognitionCommandNames</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> |