summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLRegisterAppInterface.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Classes/SDLRegisterAppInterface.html')
-rw-r--r--docs/Classes/SDLRegisterAppInterface.html123
1 files changed, 0 insertions, 123 deletions
diff --git a/docs/Classes/SDLRegisterAppInterface.html b/docs/Classes/SDLRegisterAppInterface.html
index f3cc6a9d7..f2edd0f2d 100644
--- a/docs/Classes/SDLRegisterAppInterface.html
+++ b/docs/Classes/SDLRegisterAppInterface.html
@@ -5,10 +5,7 @@
<ul>
<li><a href="#section--initWithLifecycleConfiguration:">-initWithLifecycleConfiguration:</a></li>
<li><a href="#section--initWithAppName:appId:languageDesired:">-initWithAppName:appId:languageDesired:</a></li>
- <li><a href="#section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:">-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:</a></li>
- <li><a href="#section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:">-initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:</a></li>
<li><a href="#section--initWithAppName:appId:fullAppId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:dayColorScheme:nightColorScheme:">-initWithAppName:appId:fullAppId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:dayColorScheme:nightColorScheme:</a></li>
- <li><a href="#section-syncMsgVersion">syncMsgVersion</a></li>
<li><a href="#section-sdlMsgVersion">sdlMsgVersion</a></li>
<li><a href="#section-appName">appName</a></li>
<li><a href="#section-ttsName">ttsName</a></li>
@@ -103,104 +100,6 @@
<p>A SDLRegisterAppInterface object</p>
</div>
- <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:">
- -initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:
- </h3>
-
- <p>Convenience init for registering the application with an app name, app id, desired language, whether or not the app is a media app, app types, and the short app name.</p>
-
-
-
- <h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appName</span>
- <span class="nf">appId</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span>
- <span class="nf">languageDesired</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">)</span><span class="nv">languageDesired</span>
- <span class="nf">isMediaApp</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">isMediaApp</span>
- <span class="nf">appTypes</span><span class="p">:</span>
- <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Type%20Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">appTypes</span>
- <span class="nf">shortAppName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">shortAppName</span><span class="p">;</span></code></pre>
-
-
- <h4>Swift</h4>
- <pre class="highlight swift"><code><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">languageDesired</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">,</span> <span class="nv">isMediaApp</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">appTypes</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type%20Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="p">],</span> <span class="nv">shortAppName</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 mobile application&rsquo;s name</p></dd>
- <dt>appId</dt>
- <dd><p>An appId used to validate app with policy table entries</p></dd>
- <dt>languageDesired</dt>
- <dd><p>The language the application intends to use for user interaction</p></dd>
- <dt>isMediaApp</dt>
- <dd><p>Indicates if the application is a media or a non-media application</p></dd>
- <dt>appTypes</dt>
- <dd><p>A list of all applicable app types stating which classifications to be given to the app</p></dd>
- <dt>shortAppName</dt>
- <dd><p>An abbreviated version of the mobile application&rsquo;s name</p></dd>
- </dl>
- <div>
- <h4>Return Value</h4>
- <p>A SDLRegisterAppInterface object</p>
- </div>
-
- <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:">
- -initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:
- </h3>
-
- <p>Convenience init for registering the application with an app name, app id, desired language, whether or not the app is a media app, app types, the short app name, tts name, voice recognition synonyms, the hmi display language desired, and the resume hash.</p>
-
-
-
- <h4>Objective-C</h4>
- <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
- <span class="nf">initWithAppName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appName</span>
- <span class="nf">appId</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span>
- <span class="nf">languageDesired</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">)</span><span class="nv">languageDesired</span>
- <span class="nf">isMediaApp</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">isMediaApp</span>
- <span class="nf">appTypes</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Type%20Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">appTypes</span>
- <span class="nf">shortAppName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">shortAppName</span>
- <span class="nf">ttsName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">ttsName</span>
- <span class="nf">vrSynonyms</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n">NSString</span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span><span class="nv">vrSynonyms</span>
- <span class="nf">hmiDisplayLanguageDesired</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">)</span><span class="nv">hmiDisplayLanguageDesired</span>
- <span class="nf">resumeHash</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">resumeHash</span><span class="p">;</span></code></pre>
-
-
- <h4>Swift</h4>
- <pre class="highlight swift"><code><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">languageDesired</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">,</span> <span class="nv">isMediaApp</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">appTypes</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type%20Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="p">],</span> <span class="nv">shortAppName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?,</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="nv">vrSynonyms</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">hmiDisplayLanguageDesired</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">,</span> <span class="nv">resumeHash</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 mobile application&rsquo;s name</p></dd>
- <dt>appId</dt>
- <dd><p>An appId used to validate app with policy table entries</p></dd>
- <dt>languageDesired</dt>
- <dd><p>The language the application intends to use for user interaction</p></dd>
- <dt>isMediaApp</dt>
- <dd><p>Indicates if the application is a media or a non-media application</p></dd>
- <dt>appTypes</dt>
- <dd><p>A list of all applicable app types stating which classifications to be given to the app</p></dd>
- <dt>shortAppName</dt>
- <dd><p>An abbreviated version of the mobile application&rsquo;s name</p></dd>
- <dt>ttsName</dt>
- <dd><p>TTS string for VR recognition of the mobile application name</p></dd>
- <dt>vrSynonyms</dt>
- <dd><p>Additional voice recognition commands</p></dd>
- <dt>hmiDisplayLanguageDesired</dt>
- <dd><p>Current app&rsquo;s expected VR+TTS language</p></dd>
- <dt>resumeHash</dt>
- <dd><p>ID used to uniquely identify current state of all app data that can persist through connection cycles</p></dd>
- </dl>
- <div>
- <h4>Return Value</h4>
- <p>A SDLRegisterAppInterface object</p>
- </div>
-
<h3 id="section--initWithAppName:appId:fullAppId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:dayColorScheme:nightColorScheme:">
-initWithAppName:appId:fullAppId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:dayColorScheme:nightColorScheme:
</h3>
@@ -266,28 +165,6 @@
<p>A SDLRegisterAppInterface object</p>
</div>
- <h3 id="section-syncMsgVersion">
- syncMsgVersion
- </h3>
-
- <p>Specifies the version number of the SmartDeviceLink protocol that is supported by the mobile application.</p>
-
-<p>SDLSyncMsgVersion, Required</p>
-
-<p>@since SDL 1.0</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">__deprecated_msg</span><span class="p">((</span><span class="s">"Use sdlMsgVersion instead"</span><span class="p">))</span> <span class="n"><a href="../Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span> <span class="o">*</span><span class="n">syncMsgVersion</span><span class="p">;</span></code></pre>
-
-
- <h4>Swift</h4>
- <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">syncMsgVersion</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</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-sdlMsgVersion">
sdlMsgVersion
</h3>