diff options
Diffstat (limited to 'docs/Classes')
157 files changed, 2904 insertions, 3235 deletions
diff --git a/docs/Classes/SDLAbstractProtocol.html b/docs/Classes/SDLAbstractProtocol.html deleted file mode 100644 index d5c0904e2..000000000 --- a/docs/Classes/SDLAbstractProtocol.html +++ /dev/null @@ -1,261 +0,0 @@ -<h1>SDLAbstractProtocol Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-debugConsoleGroupName">debugConsoleGroupName</a></li> - <li><a href="#section-transport">transport</a></li> - <li><a href="#section-protocolDelegateTable">protocolDelegateTable</a></li> - <li><a href="#section-securityManager">securityManager</a></li> - <li><a href="#section-appId">appId</a></li> - <li><a href="#section--startServiceWithType:payload:">-startServiceWithType:payload:</a></li> - <li><a href="#section--startSecureServiceWithType:payload:completionHandler:">-startSecureServiceWithType:payload:completionHandler:</a></li> - <li><a href="#section--endServiceWithType:">-endServiceWithType:</a></li> - <li><a href="#section--sendRPC:">-sendRPC:</a></li> - <li><a href="#section--sendRPC:encrypted:error:">-sendRPC:encrypted:error:</a></li> - <li><a href="#section--sendRawData:withServiceType:">-sendRawData:withServiceType:</a></li> - <li><a href="#section--sendEncryptedRawData:onService:">-sendEncryptedRawData:onService:</a></li> - <li><a href="#section--handleBytesFromTransport:">-handleBytesFromTransport:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-debugConsoleGroupName"> - debugConsoleGroupName - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">debugConsoleGroupName</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-transport"> - transport - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="n">transport</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">transport</span><span class="p">:</span> <span class="nf">SDLAbstractTransport</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> - - - - - <h3 id="section-protocolDelegateTable"> - protocolDelegateTable - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSHashTable</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="o">>></span> <span class="o">*</span><span class="n">protocolDelegateTable</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">protocolDelegateTable</span><span class="p">:</span> <span class="kt">NSHashTable</span><span class="o"><</span><span class="kt"><a href="../Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="o">></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> - - - - - <h3 id="section-securityManager"> - securityManager - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">></span> <span class="n">securityManager</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">securityManager</span><span class="p">:</span> <span class="nf">SDLSecurityType</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> - - - - - <h3 id="section-appId"> - appId - </h3> - - <p>Undocumented</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">copy</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appId</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">appId</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section--startServiceWithType:payload:"> - -startServiceWithType:payload: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">startService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">,</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?)</span></code></pre> - - - - - <h3 id="section--startSecureServiceWithType:payload:completionHandler:"> - -startSecureServiceWithType:payload:completionHandler: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startSecureServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">BOOL</span> <span class="n">success</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">error</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">startSecureService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">,</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Bool</span><span class="p">,</span> <span class="kt">Error</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--endServiceWithType:"> - -endServiceWithType: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">endServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">endService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:"> - -sendRPC: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:encrypted:error:"> - -sendRPC:encrypted:error: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span> <span class="nf">encrypted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">encryption</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">,</span> <span class="n">encrypted</span> <span class="nv">encryption</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="k">throws</span></code></pre> - - - - - <h3 id="section--sendRawData:withServiceType:"> - -sendRawData:withServiceType: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">withServiceType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRawData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendEncryptedRawData:onService:"> - -sendEncryptedRawData:onService: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendEncryptedRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">onService</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendEncryptedRawData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">on</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleBytesFromTransport:"> - -handleBytesFromTransport: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleBytesFromTransport</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">handleBytes</span><span class="p">(</span><span class="n">fromTransport</span> <span class="nv">receivedData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLAbstractTransport.html b/docs/Classes/SDLAbstractTransport.html deleted file mode 100644 index f6c8269b5..000000000 --- a/docs/Classes/SDLAbstractTransport.html +++ /dev/null @@ -1,128 +0,0 @@ -<h1>SDLAbstractTransport Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-delegate">delegate</a></li> - <li><a href="#section-debugConsoleGroupName">debugConsoleGroupName</a></li> - <li><a href="#section--connect">-connect</a></li> - <li><a href="#section--disconnect">-disconnect</a></li> - <li><a href="#section--sendData:">-sendData:</a></li> - <li><a href="#section--retryDelay">-retryDelay</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-delegate"> - delegate - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLTransportDelegate.html">SDLTransportDelegate</a></span><span class="o">></span> <span class="n">delegate</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">delegate</span><span class="p">:</span> <span class="nf">SDLTransportDelegate</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> - - - - - <h3 id="section-debugConsoleGroupName"> - debugConsoleGroupName - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">debugConsoleGroupName</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section--connect"> - -connect - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">connect</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">connect</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--disconnect"> - -disconnect - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">disconnect</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">disconnect</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--sendData:"> - -sendData: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">dataToSend</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">dataToSend</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--retryDelay"> - -retryDelay - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">double</span><span class="p">)</span><span class="n">retryDelay</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">retryDelay</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Double</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLAddCommand.html b/docs/Classes/SDLAddCommand.html index a2e120413..85da19ce8 100644 --- a/docs/Classes/SDLAddCommand.html +++ b/docs/Classes/SDLAddCommand.html @@ -154,7 +154,7 @@ cmdID </h3> - <p>@abstract A Unique Command ID that identifies the command</p> + <p>A Unique Command ID that identifies the command</p> <p>@discussion Is returned in an <em>SDLOnCommand</em> notification to identify the command selected by the user</p> @@ -176,7 +176,7 @@ menuParams </h3> - <p>@abstract a <em>SDLMenuParams</em> pointer which will defined the command and how it is added to the Command Menu</p> + <p>a <em>SDLMenuParams</em> pointer which will defined the command and how it is added to the Command Menu</p> <p>@discussion If provided, this will define the command and how it is added to the Command Menu</p> @@ -201,7 +201,7 @@ vrCommands </h3> - <p>@abstract An array of strings to be used as VR synonyms for this command.</p> + <p>An array of strings to be used as VR synonyms for this command.</p> <p>@discussion If provided, defines one or more VR phrases the recognition of any of which triggers the <em>SDLOnCommand</em> notification with this cmdID</p> @@ -226,7 +226,7 @@ cmdIcon </h3> - <p>@abstract Image struct containing a static or dynamic icon</p> + <p>Image struct containing a static or dynamic icon</p> <p>@discussion If provided, defines the image to be be shown along with a command</p> diff --git a/docs/Classes/SDLAddSubMenu.html b/docs/Classes/SDLAddSubMenu.html index abc8da4e4..aca6cbe51 100644 --- a/docs/Classes/SDLAddSubMenu.html +++ b/docs/Classes/SDLAddSubMenu.html @@ -66,7 +66,7 @@ menuID </h3> - <p>@abstract a Menu ID that identifies a sub menu + <p>a Menu ID that identifies a sub menu @discussion This value is used in <i>SDLAddCommand</i> to which SDLSubMenu is the parent of the command being added <p></p> @@ -87,7 +87,7 @@ position </h3> - <p>@abstract a position of menu + <p>a position of menu @discussion An NSNumber pointer representing the position within the items of the top level Command Menu. 0 will insert at the front, 1 will insert after the first existing element, etc. Position of @@ -120,7 +120,7 @@ menuName </h3> - <p>@abstract a menuName which is displayed representing this submenu item + <p>a menuName which is displayed representing this submenu item @discussion NSString which will be displayed representing this submenu item</p> diff --git a/docs/Classes/SDLAirbagStatus.html b/docs/Classes/SDLAirbagStatus.html index 6a1189315..be923f01d 100644 --- a/docs/Classes/SDLAirbagStatus.html +++ b/docs/Classes/SDLAirbagStatus.html @@ -15,7 +15,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data status struct for airbags</p> <section class="section task-group-section"> @@ -23,12 +23,15 @@ driverAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsDrvBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -41,12 +44,15 @@ driverSideAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsDrvSideBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverSideAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverSideAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -59,12 +65,15 @@ driverCurtainAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsDrvCrtnBag_D_Ltchd</q>. See VehicleDataEventStatus</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverCurtainAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverCurtainAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -77,12 +86,15 @@ passengerAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsPasBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -95,12 +107,15 @@ passengerCurtainAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsPasCrtnBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerCurtainAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerCurtainAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -113,12 +128,15 @@ driverKneeAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsKneeDrvBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverKneeAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverKneeAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -131,12 +149,15 @@ passengerSideAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsPasSideBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerSideAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerSideAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -149,12 +170,15 @@ passengerKneeAirbagDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsKneePasBag_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerKneeAirbagDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerKneeAirbagDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLAlert.html b/docs/Classes/SDLAlert.html index feb0f58df..3f8762486 100644 --- a/docs/Classes/SDLAlert.html +++ b/docs/Classes/SDLAlert.html @@ -238,7 +238,7 @@ alertText1 </h3> - <p>@abstract The String to be displayed in the first field of the display during the Alert</p> + <p>The String to be displayed in the first field of the display during the Alert</p> <p>@discussion Length is limited to what is indicated in <em>SDLRegisterAppInterface</em> response</p> @@ -264,7 +264,7 @@ alertText2 </h3> - <p>@abstract The String to be displayed in the second field of the display during the Alert</p> + <p>The String to be displayed in the second field of the display during the Alert</p> <p>@discussion Only permitted if HMI supports a second display line</p> @@ -292,7 +292,7 @@ alertText3 </h3> - <p>@abstract the String to be displayed in the third field of the display during the Alert + <p>the String to be displayed in the third field of the display during the Alert @discussion Only permitted if HMI supports a third display line</p> <p>Length is limited to what is indicated in <em>SDLRegisterAppInterface</em> response</p> @@ -319,7 +319,7 @@ ttsChunks </h3> - <p>@abstract An array which, taken together, specify what is to be spoken to the user</p> + <p>An array which, taken together, specify what is to be spoken to the user</p> <p>Optional, Array of SDLTTSChunk, Array length 1 - 100</p> <div class="aside aside-see"> @@ -345,7 +345,7 @@ duration </h3> - <p>@abstract The duration of the displayed portion of the alert, in milliseconds.</p> + <p>The duration of the displayed portion of the alert, in milliseconds.</p> <p>@discussion After this amount of time has passed, the display fields alertText1 and alertText2 will revert to what was displayed in those fields before the alert began.</p> @@ -371,7 +371,7 @@ playTone </h3> - <p>@abstract Whether the alert tone should be played before the TTS (if any) is spoken.</p> + <p>Whether the alert tone should be played before the TTS (if any) is spoken.</p> <p>@discussion If ommitted, no tone is played</p> @@ -393,7 +393,7 @@ progressIndicator </h3> - <p>@abstract If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.</p> + <p>If supported on the given platform, the alert GUI will include some sort of animation indicating that loading of a feature is progressing. e.g. a spinning wheel or hourglass, etc.</p> <p>Optional, Boolean</p> @@ -416,7 +416,7 @@ softButtons </h3> - <p>@abstract App defined SoftButtons.</p> + <p>App defined SoftButtons.</p> <p>@discussion If omitted on supported displays, the displayed alert shall not have any SoftButtons</p> diff --git a/docs/Classes/SDLAlertManeuver.html b/docs/Classes/SDLAlertManeuver.html index 53d743144..209c77592 100644 --- a/docs/Classes/SDLAlertManeuver.html +++ b/docs/Classes/SDLAlertManeuver.html @@ -11,6 +11,8 @@ <h3>Overview</h3> +<p>Shows a SDLShowConstantTBT message with an optional voice command. This message is shown as an overlay over the display’s base screen.</p> + <p>@since SmartDeviceLink 1.0</p> @@ -55,12 +57,20 @@ ttsChunks </h3> - <p>Undocumented</p> + <p>An array of text chunks.</p> + +<p>Optional, Array of SDLTTSChunk, Array length 1 - 100</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLTTSChunk + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">ttsChunks</span></code></pre> + <pre class="highlight objective_c"><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">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">ttsChunks</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -73,12 +83,20 @@ softButtons </h3> - <p>Undocumented</p> + <p>An arry of soft buttons. If omitted on supported displays, only the system defined <q>Close</q> SoftButton shall be displayed.</p> + +<p>Optional, Array of SDLSoftButton, Array length 0 - 3</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLSoftButton + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLAlertResponse.html b/docs/Classes/SDLAlertResponse.html index ea00bbf22..777d7d9c1 100644 --- a/docs/Classes/SDLAlertResponse.html +++ b/docs/Classes/SDLAlertResponse.html @@ -8,8 +8,9 @@ <h3>Overview</h3> -<p>Sent after SDLAlert has been sent -@since SDL 1.0</p> +<p>Response to SDLAlert</p> + +<p>@since SDL 1.0</p> <section class="section task-group-section"> diff --git a/docs/Classes/SDLAppInfo.html b/docs/Classes/SDLAppInfo.html index 9b7cd92b0..6e6b64c45 100644 --- a/docs/Classes/SDLAppInfo.html +++ b/docs/Classes/SDLAppInfo.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct used in register app interface. Contains detailed information about the registered application.</p> <section class="section task-group-section"> @@ -37,12 +37,14 @@ appDisplayName </h3> - <p>Undocumented</p> + <p>The name displayed for the mobile application on the mobile device (can differ from the app name set in the initial RAI request).</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">appDisplayName</span></code></pre> + <pre class="highlight objective_c"><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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appDisplayName</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -55,12 +57,14 @@ appBundleID </h3> - <p>Undocumented</p> + <p>The AppBundleID of an iOS application or package name of the Android application. This supports App Launch strategies for each platform.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">appBundleID</span></code></pre> + <pre class="highlight objective_c"><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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appBundleID</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -73,12 +77,14 @@ appVersion </h3> - <p>Undocumented</p> + <p>Represents the build version number of this particular mobile app.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">appVersion</span></code></pre> + <pre class="highlight objective_c"><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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLAudioPassThruCapabilities.html b/docs/Classes/SDLAudioPassThruCapabilities.html index 22529dd87..4dffca68a 100644 --- a/docs/Classes/SDLAudioPassThruCapabilities.html +++ b/docs/Classes/SDLAudioPassThruCapabilities.html @@ -10,40 +10,9 @@ <h3>Overview</h3> -<p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM} -<p><b>Parameter List</b></p> - -<table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>samplingRate</td> - <td>SDLSamplingRate </td> - <td>Describes the sampling rate for AudioPassThru - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>bitsPerSample</td> - <td>SDLBitsPerSample </td> - <td>Describes the sample depth in bit for AudioPassThru - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>audioType</td> - <td>SDLAudioType </td> - <td>Describes the audiotype for AudioPassThru - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - </table> - -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}</p> + +<p>Since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -51,7 +20,9 @@ samplingRate </h3> - <p>@abstract The sampling rate for AudioPassThru<br></p> + <p>The sampling rate for AudioPassThru</p> + +<p>Required</p> @@ -69,7 +40,9 @@ bitsPerSample </h3> - <p>@abstract The sample depth in bit for AudioPassThru<br></p> + <p>The sample depth in bit for AudioPassThru</p> + +<p>Required</p> @@ -87,7 +60,9 @@ audioType </h3> - <p>@abstract The audiotype for AudioPassThru<br></p> + <p>The audiotype for AudioPassThru</p> + +<p>Required</p> diff --git a/docs/Classes/SDLAudioStreamManager.html b/docs/Classes/SDLAudioStreamManager.html index b0f128332..61d87aef6 100644 --- a/docs/Classes/SDLAudioStreamManager.html +++ b/docs/Classes/SDLAudioStreamManager.html @@ -23,12 +23,13 @@ delegate </h3> - <p>Undocumented</p> + <p>The delegate describing when files are done playing or any errors that occur</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLAudioStreamManagerDelegate.html">SDLAudioStreamManagerDelegate</a></span><span class="o">></span> <span class="n">delegate</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</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">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLAudioStreamManagerDelegate.html">SDLAudioStreamManagerDelegate</a></span><span class="o">></span> <span class="n">_Nullable</span> <span class="n">delegate</span><span class="p">;</span></code></pre> @@ -38,12 +39,12 @@ playing </h3> - <p>Undocumented</p> + <p>Whether or not we are currently playing audio</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isPlaying</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">playing</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isPlaying</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">playing</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -56,12 +57,12 @@ queue </h3> - <p>Undocumented</p> + <p>The queue of audio files that will be played in sequence</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLAudioFile</span> <span class="o">*></span> <span class="o">*</span><span class="n">queue</span></code></pre> + <pre class="highlight objective_c"><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">NSArray</span><span class="o"><</span><span class="n">SDLAudioFile</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">queue</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -74,31 +75,50 @@ -init </h3> - <p>Undocumented</p> + <p>Init should only occur with dependencies. use <code>initWithManager:</code></p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span></code></pre> + <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="n">init</span><span class="p">;</span></code></pre> + <div> + <h4>Return Value</h4> + <p>A failure</p> + </div> <h3 id="section--initWithManager:"> -initWithManager: </h3> - <p>Undocumented</p> + <p>Create an audio stream manager with a reference to the parent stream manager.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>For internal use</p> + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithManager</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingAudioManagerType.html">SDLStreamingAudioManagerType</a></span><span class="o">></span><span class="p">)</span><span class="nv">streamManager</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span></code></pre> + <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">initWithManager</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingAudioManagerType.html">SDLStreamingAudioManagerType</a></span><span class="o">></span><span class="p">)</span><span class="nv">streamManager</span><span class="p">;</span></code></pre> + <h4>Parameters</h4> + <dl> + <dt>streamManager</dt> + <dd><p>The parent stream manager</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The audio stream manager</p> + </div> <h3 id="section--pushWithFileURL:"> -pushWithFileURL: diff --git a/docs/Classes/SDLBeltStatus.html b/docs/Classes/SDLBeltStatus.html index 7a4204a2d..d08f0d031 100644 --- a/docs/Classes/SDLBeltStatus.html +++ b/docs/Classes/SDLBeltStatus.html @@ -22,7 +22,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Vehicle data struct for the seat belt status</p> <section class="section task-group-section"> @@ -30,12 +30,15 @@ driverBeltDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsDrvBelt_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBeltDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverBeltDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -48,12 +51,15 @@ passengerBeltDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsPasBelt_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerBeltDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerBeltDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -66,12 +72,15 @@ passengerBuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1PasBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerBuckleBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerBuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -84,12 +93,15 @@ driverBuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1DrvBckl_D_Ltchd</q>. See VehicleDataEventStatus</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBuckleBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">driverBuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -102,12 +114,15 @@ leftRow2BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2lBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRow2BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">leftRow2BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -120,12 +135,15 @@ passengerChildDetected </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1PasChld_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerChildDetected</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">passengerChildDetected</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -138,12 +156,15 @@ rightRow2BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2rBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRow2BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">rightRow2BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -156,12 +177,15 @@ middleRow2BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2mBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow2BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">middleRow2BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -174,12 +198,15 @@ middleRow3BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw3mBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow3BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">middleRow3BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -192,12 +219,15 @@ leftRow3BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw3lBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRow3BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">leftRow3BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -210,12 +240,15 @@ rightRow3BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw3rBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRow3BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">rightRow3BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -228,12 +261,15 @@ leftRearInflatableBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2lRib_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRearInflatableBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">leftRearInflatableBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -246,12 +282,15 @@ rightRearInflatableBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw2rRib_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRearInflatableBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">rightRearInflatableBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -264,12 +303,15 @@ middleRow1BeltDeployed </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1mBelt_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow1BeltDeployed</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">middleRow1BeltDeployed</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -282,12 +324,15 @@ middleRow1BuckleBelted </h3> - <p>Undocumented</p> + <p>References signal <q>VedsRw1mBckl_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow1BuckleBelted</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">middleRow1BuckleBelted</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLBodyInformation.html b/docs/Classes/SDLBodyInformation.html index f1ab34626..4fb86ca0d 100644 --- a/docs/Classes/SDLBodyInformation.html +++ b/docs/Classes/SDLBodyInformation.html @@ -22,7 +22,12 @@ parkBrakeActive </h3> - <p>@abstract References signal <q>PrkBrkActv_B_Actl</q>.</p> + +<ul> +<li>References signal <q>PrkBrkActv_B_Actl</q>.</li> +</ul> + +<p>Required</p> @@ -41,7 +46,12 @@ ignitionStableStatus </h3> - <p>@abstract References signal <q>Ignition_Switch_Stable</q>. See IgnitionStableStatus.</p> + +<ul> +<li>References signal <q>Ignition_Switch_Stable</q>. See IgnitionStableStatus.</li> +</ul> + +<p>Required</p> @@ -60,7 +70,12 @@ ignitionStatus </h3> - <p>@abstract References signal <q>Ignition_status</q>. See IgnitionStatus.</p> + +<ul> +<li>References signal <q>Ignition_status</q>. See IgnitionStatus.</li> +</ul> + +<p>Required</p> @@ -79,7 +94,12 @@ driverDoorAjar </h3> - <p>@abstract References signal <q>DrStatDrv_B_Actl</q>.</p> + +<ul> +<li>References signal <q>DrStatDrv_B_Actl</q>.</li> +</ul> + +<p>Optional</p> @@ -98,7 +118,12 @@ passengerDoorAjar </h3> - <p>@abstract References signal <q>DrStatPsngr_B_Actl</q>.</p> + +<ul> +<li>References signal <q>DrStatPsngr_B_Actl</q>.</li> +</ul> + +<p>Optional</p> @@ -117,7 +142,12 @@ rearLeftDoorAjar </h3> - <p>@abstract References signal <q>DrStatRl_B_Actl</q>.</p> + +<ul> +<li>References signal <q>DrStatRl_B_Actl</q>.</li> +</ul> + +<p>Optional</p> @@ -136,7 +166,12 @@ rearRightDoorAjar </h3> - <p>@abstract References signal <q>DrStatRr_B_Actl</q>.</p> + +<ul> +<li>References signal <q>DrStatRr_B_Actl</q>.</li> +</ul> + +<p>Optional</p> diff --git a/docs/Classes/SDLButtonCapabilities.html b/docs/Classes/SDLButtonCapabilities.html index e8840a9f0..823e90188 100644 --- a/docs/Classes/SDLButtonCapabilities.html +++ b/docs/Classes/SDLButtonCapabilities.html @@ -21,7 +21,12 @@ name </h3> - <p>@abstract The name of the SDL HMI button.</p> + +<ul> +<li>The name of the SDL HMI button.</li> +</ul> + +<p>Required</p> @@ -39,7 +44,7 @@ shortPressAvailable </h3> - <p>@abstract A NSNumber value indicates whether the button supports a SHORT press</p> + <p>A NSNumber value indicates whether the button supports a SHORT press</p> <p>Required, Boolean</p> @@ -60,7 +65,7 @@ longPressAvailable </h3> - <p>@abstract A NSNumber value indicates whether the button supports a LONG press</p> + <p>A NSNumber value indicates whether the button supports a LONG press</p> <p>Required, Boolean</p> @@ -81,7 +86,7 @@ upDownAvailable </h3> - <p>@abstract A NSNumber value indicates whether the button supports <q>button down</q> and <q>button up</q></p> + <p>A NSNumber value indicates whether the button supports <q>button down</q> and <q>button up</q></p> <p>Required, Boolean</p> diff --git a/docs/Classes/SDLCarWindowViewController.html b/docs/Classes/SDLCarWindowViewController.html index 368727e6c..83889083a 100644 --- a/docs/Classes/SDLCarWindowViewController.html +++ b/docs/Classes/SDLCarWindowViewController.html @@ -16,12 +16,13 @@ supportedOrientation </h3> - <p>Undocumented</p> + <p>The supported interface orientation you wish to use. Defaults to MaskPortrait.</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">assign</span><span class="p">)</span> <span class="n">UIInterfaceOrientation</span> <span class="n">supportedOrientation</span></code></pre> + <pre class="highlight objective_c"><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">UIInterfaceOrientation</span> <span class="n">supportedOrientation</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLChangeRegistration.html b/docs/Classes/SDLChangeRegistration.html index f5ba41f2b..cce9dcba1 100644 --- a/docs/Classes/SDLChangeRegistration.html +++ b/docs/Classes/SDLChangeRegistration.html @@ -63,7 +63,7 @@ language </h3> - <p>@abstract The language the app wants to change to</p> + <p>The language the app wants to change to</p> @@ -81,7 +81,7 @@ hmiDisplayLanguage </h3> - <p>@abstract HMI display language</p> + <p>HMI display language</p> diff --git a/docs/Classes/SDLChoice.html b/docs/Classes/SDLChoice.html index 2aa519b81..c5531d291 100644 --- a/docs/Classes/SDLChoice.html +++ b/docs/Classes/SDLChoice.html @@ -16,48 +16,9 @@ <h3>Overview</h3> -<p>A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction. - <p><b> Parameter List</b> - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>choiceID</td> - <td>NSNumber * </td> - <td>Application-scoped identifier that uniquely identifies this choice. - <br/>Min: 0 - <br/>Max: 65535 - </td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>menuName</td> - <td>NSString * </td> - <td>Text which appears in menu, representing this choice. - <br/>Min: 1 - <br/>Max: 100 - </td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>vrCommands</td> - <td>NSArray *</td> - <td>An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element</td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>image</td> - <td>SDLImage * </td> - <td>Either a static hex icon value or a binary image file name identifier (sent by PutFile).</td> - <td>SmartDeviceLink 2.0</td> - </tr> - </table></p> - -<p>Since <b>SmartDeviceLink 1.0</b><br></p> +<p>A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.</p> + +<p>Since SmartDeviceLink 1.0</p> <section class="section task-group-section"> @@ -101,7 +62,7 @@ choiceID </h3> - <p>@abstract the application-scoped identifier that uniquely identifies this choice</p> + <p>The application-scoped identifier that uniquely identifies this choice</p> <p>Required, Integer 0 - 65535</p> @@ -121,7 +82,7 @@ menuName </h3> - <p>@abstract Text which appears in menu, representing this choice</p> + <p>Text which appears in menu, representing this choice</p> <p>Required, Max string length 500 chars</p> @@ -141,7 +102,7 @@ vrCommands </h3> - <p>@abstract VR synonyms for this choice</p> + <p>VR synonyms for this choice</p> <p>Required, Array of Strings, Array length 1 - 100, Max String length 99 chars</p> @@ -162,7 +123,7 @@ image </h3> - <p>@abstract The image of the choice</p> + <p>The image of the choice</p> <p>Optional</p> @@ -182,7 +143,7 @@ secondaryText </h3> - <p>@abstract Optional secondary text to display; e.g. address of POI in a search result entry</p> + <p>Secondary text to display; e.g. address of POI in a search result entry</p> <p>Optional, Max String length 500 chars</p> @@ -202,7 +163,7 @@ tertiaryText </h3> - <p>@abstract Optional tertiary text to display; e.g. distance to POI for a search result entry</p> + <p>Tertiary text to display; e.g. distance to POI for a search result entry</p> <p>Optional, Max String length 500 chars</p> @@ -222,7 +183,7 @@ secondaryImage </h3> - <p>@abstract Optional secondary image for choice</p> + <p>Secondary image for choice</p> <p>Optional</p> diff --git a/docs/Classes/SDLClimateControlCapabilities.html b/docs/Classes/SDLClimateControlCapabilities.html index 8cf27d57c..db9386147 100644 --- a/docs/Classes/SDLClimateControlCapabilities.html +++ b/docs/Classes/SDLClimateControlCapabilities.html @@ -46,10 +46,15 @@ moduleName </h3> - <p>@abstract The short friendly name of the climate control module. - It should not be used to identify a module by mobile application.</p> + +<ul> +<li>The short friendly name of the climate control module.</li> +<li>It should not be used to identify a module by mobile application. +*</li> +<li>Max string length 100 chars</li> +</ul> -<p>Max string length 100 chars</p> +<p>Required</p> @@ -67,7 +72,7 @@ fanSpeedAvailable </h3> - <p>@abstract Availability of the control of fan speed. + <p>Availability of the control of fan speed. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -89,7 +94,7 @@ desiredTemperatureAvailable </h3> - <p>@abstract Availability of the control of desired temperature. + <p>Availability of the control of desired temperature. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -111,7 +116,7 @@ acEnableAvailable </h3> - <p>@abstract Availability of the control of turn on/off AC. + <p>Availability of the control of turn on/off AC. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -133,7 +138,7 @@ acMaxEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable air conditioning is ON on the maximum level. + <p>Availability of the control of enable/disable air conditioning is ON on the maximum level. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -155,7 +160,7 @@ circulateAirEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable circulate Air mode. + <p>Availability of the control of enable/disable circulate Air mode. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -177,7 +182,7 @@ autoModeEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable auto mode. + <p>Availability of the control of enable/disable auto mode. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -199,7 +204,7 @@ dualModeEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable dual mode. + <p>Availability of the control of enable/disable dual mode. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -221,7 +226,7 @@ defrostZoneAvailable </h3> - <p>@abstract Availability of the control of defrost zones. + <p>Availability of the control of defrost zones. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -243,7 +248,7 @@ defrostZone </h3> - <p>@abstract A set of all defrost zones that are controllable.</p> + <p>A set of all defrost zones that are controllable.</p> <p>Optional, NSArray of type SDLDefrostZone minsize=<q>1</q> maxsize=<q>100</q></p> @@ -264,7 +269,7 @@ ventilationModeAvailable </h3> - <p>@abstract Availability of the control of air ventilation mode. + <p>Availability of the control of air ventilation mode. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -286,7 +291,7 @@ ventilationMode </h3> - <p>@abstract A set of all ventilation modes that are controllable. + <p>A set of all ventilation modes that are controllable. True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, NSArray of type SDLVentilationMode minsize=<q>1</q> maxsize=<q>100</q></p> diff --git a/docs/Classes/SDLClimateControlData.html b/docs/Classes/SDLClimateControlData.html index 8419c8124..78bba58cc 100644 --- a/docs/Classes/SDLClimateControlData.html +++ b/docs/Classes/SDLClimateControlData.html @@ -18,7 +18,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The current information for the Climate Remote Control Module</p> <section class="section task-group-section"> @@ -44,7 +44,7 @@ fanSpeed </h3> - <p>@abstract Speed of Fan in integer</p> + <p>Speed of Fan in integer</p> <p>Optional, MinValue- 0 MaxValue= 100</p> @@ -64,7 +64,7 @@ currentTemperature </h3> - <p>@abstract The Current Temperature in SDLTemperature</p> + <p>The Current Temperature in SDLTemperature</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -90,7 +90,7 @@ desiredTemperature </h3> - <p>@abstract Desired Temperature in SDLTemperature</p> + <p>Desired Temperature in SDLTemperature</p> <p>Optional</p> @@ -111,7 +111,7 @@ acEnable </h3> - <p>@abstract Represents if AC is enabled.</p> + <p>Represents if AC is enabled.</p> <p>Optional, Boolean</p> @@ -131,7 +131,7 @@ circulateAirEnable </h3> - <p>@abstract Represents if circulation of air is enabled.</p> + <p>Represents if circulation of air is enabled.</p> <p>Optional, Boolean</p> @@ -152,7 +152,7 @@ autoModeEnable </h3> - <p>@abstract Represents if auto mode is enabled.</p> + <p>Represents if auto mode is enabled.</p> <p>Optional, Boolean</p> @@ -173,7 +173,7 @@ defrostZone </h3> - <p>@abstract Represents the kind of defrost zone</p> + <p>Represents the kind of defrost zone</p> <p>Optional, SDLDefrostZone</p> @@ -193,7 +193,7 @@ dualModeEnable </h3> - <p>@abstract Represents if dual mode is enabled.</p> + <p>Represents if dual mode is enabled.</p> <p>Optional, Boolean</p> @@ -214,7 +214,7 @@ acMaxEnable </h3> - <p>@abstract Represents if ac max is enabled.</p> + <p>Represents if ac max is enabled.</p> <p>Optional, Boolean</p> @@ -235,7 +235,7 @@ ventilationMode </h3> - <p>@abstract Represents the kind of Ventilation zone</p> + <p>Represents the kind of Ventilation zone</p> <p>Optional, SDLVentilationMode</p> diff --git a/docs/Classes/SDLClusterModeStatus.html b/docs/Classes/SDLClusterModeStatus.html index 6a915a577..53705f5ad 100644 --- a/docs/Classes/SDLClusterModeStatus.html +++ b/docs/Classes/SDLClusterModeStatus.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data struct for the cluster mode and power status</p> <section class="section task-group-section"> @@ -19,12 +19,15 @@ powerModeActive </h3> - <p>Undocumented</p> + <p>References signal <q>PowerMode_UB</q>.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">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">powerModeActive</span></code></pre> + <pre class="highlight objective_c"><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">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">powerModeActive</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +40,15 @@ powerModeQualificationStatus </h3> - <p>Undocumented</p> + <p>References signal <q>PowerModeQF</q>. See PowerModeQualificationStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="n">powerModeQualificationStatus</span></code></pre> + <pre class="highlight objective_c"><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:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="n">_Nonnull</span> <span class="n">powerModeQualificationStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -55,12 +61,14 @@ carModeStatus </h3> - <p>Undocumented</p> + <p>References signal <q>CarMode</q>. See CarMode.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLCarModeStatus.h@T@SDLCarModeStatus">SDLCarModeStatus</a></span> <span class="n">carModeStatus</span></code></pre> + <pre class="highlight objective_c"><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:SDLCarModeStatus.h@T@SDLCarModeStatus">SDLCarModeStatus</a></span> <span class="n">_Nonnull</span> <span class="n">carModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -73,12 +81,15 @@ powerModeStatus </h3> - <p>Undocumented</p> + <p>References signal <q>PowerMode</q>. See PowerMode.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">powerModeStatus</span></code></pre> + <pre class="highlight objective_c"><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:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">_Nonnull</span> <span class="n">powerModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLCreateInteractionChoiceSet.html b/docs/Classes/SDLCreateInteractionChoiceSet.html index 55dc985a3..0d32e0d9f 100644 --- a/docs/Classes/SDLCreateInteractionChoiceSet.html +++ b/docs/Classes/SDLCreateInteractionChoiceSet.html @@ -49,7 +49,7 @@ interactionChoiceSetID </h3> - <p>@abstract A unique ID that identifies the Choice Set</p> + <p>A unique ID that identifies the Choice Set</p> <p>Required, Integer, 0 - 2,000,000,000</p> @@ -70,7 +70,7 @@ choiceSet </h3> - <p>@abstract Array of choices, which the user can select by menu or voice recognition</p> + <p>Array of choices, which the user can select by menu or voice recognition</p> <p>Required, SDLChoice, Array size 1 - 100</p> diff --git a/docs/Classes/SDLDIDResult.html b/docs/Classes/SDLDIDResult.html index 9b684cc57..953cd7e67 100644 --- a/docs/Classes/SDLDIDResult.html +++ b/docs/Classes/SDLDIDResult.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data struct</p> <section class="section task-group-section"> @@ -18,12 +18,15 @@ resultCode </h3> - <p>Undocumented</p> + <p>Individual DID result code.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">resultCode</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">_Nonnull</span> <span class="n">resultCode</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +39,14 @@ didLocation </h3> - <p>Undocumented</p> + <p>Location of raw data from vehicle data DID</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">didLocation</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">didLocation</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +59,14 @@ data </h3> - <p>Undocumented</p> + <p>Raw DID-based data returned for requested element.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">data</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLDateTime.html b/docs/Classes/SDLDateTime.html index 237364aa4..d4a0719bf 100644 --- a/docs/Classes/SDLDateTime.html +++ b/docs/Classes/SDLDateTime.html @@ -20,7 +20,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct referenced in SendLocation for an absolute date</p> <section class="section task-group-section"> @@ -100,7 +100,7 @@ millisecond </h3> - <p>@abstract Milliseconds part of time</p> + <p>Milliseconds part of time</p> <p>Optional, Integer 0 - 999</p> @@ -120,7 +120,7 @@ second </h3> - <p>@abstract Seconds part of time</p> + <p>Seconds part of time</p> <p>Optional, Integer 0 - 59</p> @@ -140,7 +140,7 @@ minute </h3> - <p>@abstract Minutes part of time</p> + <p>Minutes part of time</p> <p>Optional, Integer 0 - 59</p> @@ -160,7 +160,7 @@ hour </h3> - <p>@abstract Hour part of time</p> + <p>Hour part of time</p> <p>Optional, Integer 0 - 23</p> @@ -180,7 +180,7 @@ day </h3> - <p>@abstract Day of the month</p> + <p>Day of the month</p> <p>Optional, Integer 1 - 31</p> @@ -200,7 +200,7 @@ month </h3> - <p>@abstract Month of the year</p> + <p>Month of the year</p> <p>Optional, Integer 1 - 12</p> @@ -220,7 +220,7 @@ year </h3> - <p>@abstract The year in YYYY format</p> + <p>The year in YYYY format</p> <p>Optional, Max Value 4095</p> @@ -240,7 +240,7 @@ timezoneMinuteOffset </h3> - <p>@abstract Time zone offset in Min with regard to UTC</p> + <p>Time zone offset in Min with regard to UTC</p> <p>Optional, Integer 0 - 59</p> @@ -261,7 +261,7 @@ timezoneHourOffset </h3> - <p>@abstract Time zone offset in Hours with regard to UTC</p> + <p>Time zone offset in Hours with regard to UTC</p> <p>Optional, Integer -12 - 14</p> diff --git a/docs/Classes/SDLDeleteCommand.html b/docs/Classes/SDLDeleteCommand.html index 8f84a07f1..f585d3af9 100644 --- a/docs/Classes/SDLDeleteCommand.html +++ b/docs/Classes/SDLDeleteCommand.html @@ -44,7 +44,7 @@ cmdID </h3> - <p>@abstract the Command ID that identifies the Command to be deleted from Command Menu + <p>the Command ID that identifies the Command to be deleted from Command Menu @discussion an NSNumber value representing Command ID <p> <b>Notes: </b>Min Value: 0; Max Value: 2000000000</p> diff --git a/docs/Classes/SDLDeleteFile.html b/docs/Classes/SDLDeleteFile.html index 42ad5d070..bd5b1d1a6 100644 --- a/docs/Classes/SDLDeleteFile.html +++ b/docs/Classes/SDLDeleteFile.html @@ -40,7 +40,7 @@ syncFileName </h3> - <p>@abstract a file reference name + <p>a file reference name @discussion a String value representing a file reference name</p> diff --git a/docs/Classes/SDLDeleteFileResponse.html b/docs/Classes/SDLDeleteFileResponse.html index dd8e485d4..ee00c1e92 100644 --- a/docs/Classes/SDLDeleteFileResponse.html +++ b/docs/Classes/SDLDeleteFileResponse.html @@ -8,9 +8,9 @@ <h3>Overview</h3> -<p>Delete File Response is sent, when DeleteFile has been called</p> +<p>Response to SDLDeleteFile</p> -<p>Since <b>SmartDeviceLink 2.0</b><br></p> +<p>Since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -18,12 +18,13 @@ spaceAvailable </h3> - <p>Undocumented</p> + <p>The remaining available space for your application to store data on the remote system.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">spaceAvailable</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">spaceAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLDeleteInteractionChoiceSet.html b/docs/Classes/SDLDeleteInteractionChoiceSet.html index 954ff7a86..6105b4ae4 100644 --- a/docs/Classes/SDLDeleteInteractionChoiceSet.html +++ b/docs/Classes/SDLDeleteInteractionChoiceSet.html @@ -46,7 +46,7 @@ interactionChoiceSetID </h3> - <p>@abstract a unique ID that identifies the Choice Set + <p>a unique ID that identifies the Choice Set @discussion a unique ID that identifies the Choice Set <p> <b>Notes: </b>Min Value: 0; Max Value: 2000000000</p> diff --git a/docs/Classes/SDLDeleteSubMenu.html b/docs/Classes/SDLDeleteSubMenu.html index 2fcd1c385..8c9cb101c 100644 --- a/docs/Classes/SDLDeleteSubMenu.html +++ b/docs/Classes/SDLDeleteSubMenu.html @@ -44,7 +44,7 @@ menuID </h3> - <p>@abstract the MenuID that identifies the SDLSubMenu to be delete + <p>the MenuID that identifies the SDLSubMenu to be delete @discussion <b>Notes: </b>Min Value: 0; Max Value: 2000000000</p> diff --git a/docs/Classes/SDLDeviceInfo.html b/docs/Classes/SDLDeviceInfo.html index 1869b1127..02d85d7cf 100644 --- a/docs/Classes/SDLDeviceInfo.html +++ b/docs/Classes/SDLDeviceInfo.html @@ -14,7 +14,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Various information about connecting device. Referenced in RegisterAppInterface</p> <section class="section task-group-section"> @@ -40,12 +40,14 @@ hardware </h3> - <p>Undocumented</p> + <p>Device model</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">hardware</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hardware</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -58,12 +60,14 @@ firmwareRev </h3> - <p>Undocumented</p> + <p>Device firmware version</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">firmwareRev</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">firmwareRev</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -76,12 +80,14 @@ os </h3> - <p>Undocumented</p> + <p>Device OS</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">os</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">os</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -94,12 +100,14 @@ osVersion </h3> - <p>Undocumented</p> + <p>Device OS version</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">osVersion</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">osVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -112,12 +120,14 @@ carrier </h3> - <p>Undocumented</p> + <p>Device mobile carrier</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">carrier</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">carrier</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -130,12 +140,17 @@ maxNumberRFCOMMPorts </h3> - <p>Undocumented</p> + <p>Number of bluetooth RFCOMM ports available.</p> + +<p>Omitted if not connected via BT or on iOS</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maxNumberRFCOMMPorts</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maxNumberRFCOMMPorts</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLDeviceStatus.html b/docs/Classes/SDLDeviceStatus.html index a33a022dc..50d33091f 100644 --- a/docs/Classes/SDLDeviceStatus.html +++ b/docs/Classes/SDLDeviceStatus.html @@ -20,93 +20,7 @@ <p>Describes the status related to a connected mobile device or SDL and if or how it is represented in the vehicle.</p> -<p>Parameter List - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>voiceRecOn</td> - <td>NSNumber * </td> - <td>Voice recognition is on - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>btIconOn</td> - <td>NSNumber * </td> - <td>Bluetooth connection established - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>callActive</td> - <td>NSNumber * </td> - <td>A call is being active - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>phoneRoaming</td> - <td>NSNumber * </td> - <td>The phone is in roaming mode - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>textMsgAvailable</td> - <td>NSNumber * </td> - <td>A textmessage is available - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>battLevelStatus</td> - <td>SDLDeviceLevelStatus * </td> - <td>Battery level status - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>stereoAudioOutputMuted</td> - <td>NSNumber * </td> - <td>Status of the stereo audio output channel - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>monoAudioOutputMuted</td> - <td>NSNumber * </td> - <td>Status of the mono audio output channel - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>signalLevelStatus</td> - <td>SDLDeviceLevelStatus * </td> - <td>Signal level status - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>primaryAudioSource</td> - <td>PrimaryAudioSource * </td> - <td>Reflects the current primary audio source of SDL (if selected). - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - <tr> - <td>eCallEventActive</td> - <td>NSNumber * </td> - <td>Reflects, if an eCall event is active - </td> - <td>SmartDeviceLink 2.0</td> - </tr> - </table> - @since SDL 2.0</p> +<p>@since SDL 2.0</p> <section class="section task-group-section"> @@ -114,7 +28,7 @@ voiceRecOn </h3> - <p>@abstract Indicates whether the voice recognition is on or off</p> + <p>Indicates whether the voice recognition is on or off</p> <p>Required, Boolean</p> @@ -134,7 +48,7 @@ btIconOn </h3> - <p>@abstract Indicates whether the bluetooth connection established</p> + <p>Indicates whether the bluetooth connection established</p> <p>Required, Boolean</p> @@ -154,7 +68,7 @@ callActive </h3> - <p>@abstract Indicates whether a call is being active</p> + <p>Indicates whether a call is being active</p> <p>Required, Boolean</p> @@ -174,7 +88,7 @@ phoneRoaming </h3> - <p>@abstract Indicates whether the phone is in roaming mode</p> + <p>Indicates whether the phone is in roaming mode</p> <p>Required, Boolean</p> @@ -195,7 +109,7 @@ textMsgAvailable </h3> - <p>@abstract Indicates whether a textmessage is available</p> + <p>Indicates whether a textmessage is available</p> <p>Required, Boolean</p> @@ -216,7 +130,7 @@ battLevelStatus </h3> - <p>@abstract Battery level status</p> + <p>Battery level status</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeviceLevelStatus @@ -242,7 +156,7 @@ stereoAudioOutputMuted </h3> - <p>@abstract The status of the stereo audio output channel</p> + <p>The status of the stereo audio output channel</p> <p>Required, Boolean</p> @@ -263,7 +177,7 @@ monoAudioOutputMuted </h3> - <p>@abstract The status of the mono audio output channel</p> + <p>The status of the mono audio output channel</p> <p>Required, Boolean</p> @@ -284,7 +198,7 @@ signalLevelStatus </h3> - <p>@abstract Signal level status</p> + <p>Signal level status</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeviceLevelStatus @@ -310,7 +224,7 @@ primaryAudioSource </h3> - <p>@abstract The current primary audio source of SDL (if selected).</p> + <p>The current primary audio source of SDL (if selected).</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLPrimaryAudioSource @@ -336,7 +250,7 @@ eCallEventActive </h3> - <p>@abstract Indicates if an emergency call is active</p> + <p>Indicates if an emergency call is active</p> <p>Required, Boolean</p> diff --git a/docs/Classes/SDLDiagnosticMessageResponse.html b/docs/Classes/SDLDiagnosticMessageResponse.html index ed33c6ce8..f98ea938e 100644 --- a/docs/Classes/SDLDiagnosticMessageResponse.html +++ b/docs/Classes/SDLDiagnosticMessageResponse.html @@ -8,11 +8,9 @@ <h3>Overview</h3> -<p>SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called.</p> +<p>Response to SDLDiagnosticMessage</p> -<ul> -<li>Since<b>SmartDeviceLink 3.0</b></li> -</ul> +<p>Since SmartDeviceLink 3.0</p> <section class="section task-group-section"> @@ -20,12 +18,15 @@ messageDataResult </h3> - <p>Undocumented</p> + <p>Array of bytes comprising CAN message result.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">messageDataResult</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">messageDataResult</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLDisplayCapabilities.html b/docs/Classes/SDLDisplayCapabilities.html index 8fa0d85b7..20a754db4 100644 --- a/docs/Classes/SDLDisplayCapabilities.html +++ b/docs/Classes/SDLDisplayCapabilities.html @@ -25,7 +25,7 @@ displayType </h3> - <p>@abstract The type of display</p> + <p>The type of display</p> <p>Required</p> @@ -45,7 +45,7 @@ textFields </h3> - <p>@abstract An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as <em>SDLShow</em>, <em>SDLSetMediaClockTimer</em>, etc.</p> + <p>An array of SDLTextField structures, each of which describes a field in the HMI which the application can write to using operations such as <em>SDLShow</em>, <em>SDLSetMediaClockTimer</em>, etc.</p> <p>@discussion This array of SDLTextField structures identify all the text fields to which the application can write on the current display (identified by SDLDisplayType).</p> <div class="aside aside-see"> @@ -73,7 +73,7 @@ imageFields </h3> - <p>@abstract An array of SDLImageField elements</p> + <p>An array of SDLImageField elements</p> <p>@discussion A set of all fields that support images.</p> <div class="aside aside-see"> @@ -101,7 +101,7 @@ mediaClockFormats </h3> - <p>@abstract An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</p> + <p>An array of SDLMediaClockFormat elements, defining the valid string formats used in specifying the contents of the media clock field</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLMediaClockFormat @@ -127,7 +127,7 @@ graphicSupported </h3> - <p>@abstract The display’s persistent screen supports.</p> + <p>The display’s persistent screen supports.</p> <p>@since SDL 2.0</p> @@ -150,7 +150,7 @@ templatesAvailable </h3> - <p>@abstract Number of presets the screen supports</p> + <p>Number of presets the screen supports</p> <p>@discussion The number of on-screen custom presets available (if any)</p> @@ -173,7 +173,7 @@ screenParams </h3> - <p>@abstract A set of all parameters related to a prescribed screen area (e.g. for video / touch input)</p> + <p>A set of all parameters related to a prescribed screen area (e.g. for video / touch input)</p> <p>Optional</p> @@ -193,7 +193,7 @@ numCustomPresetsAvailable </h3> - <p>@abstract The number of on-screen custom presets available (if any); otherwise omitted</p> + <p>The number of on-screen custom presets available (if any); otherwise omitted</p> <p>Optional, Integer 1 - 100</p> diff --git a/docs/Classes/SDLECallInfo.html b/docs/Classes/SDLECallInfo.html index fe130f951..f0ddf627e 100644 --- a/docs/Classes/SDLECallInfo.html +++ b/docs/Classes/SDLECallInfo.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data struct for emergency call information</p> <section class="section task-group-section"> @@ -18,12 +18,15 @@ eCallNotificationStatus </h3> - <p>Undocumented</p> + <p>References signal <q>eCallNotification_4A</q>. See VehicleDataNotificationStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">eCallNotificationStatus</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">_Nonnull</span> <span class="n">eCallNotificationStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +39,15 @@ auxECallNotificationStatus </h3> - <p>Undocumented</p> + <p>References signal <q>eCallNotification</q>. See VehicleDataNotificationStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">auxECallNotificationStatus</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">_Nonnull</span> <span class="n">auxECallNotificationStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +60,15 @@ eCallConfirmationStatus </h3> - <p>Undocumented</p> + <p>References signal <q>eCallConfirmation</q>. See ECallConfirmationStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLECallConfirmationStatus.h@T@SDLECallConfirmationStatus">SDLECallConfirmationStatus</a></span> <span class="n">eCallConfirmationStatus</span></code></pre> + <pre class="highlight objective_c"><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:SDLECallConfirmationStatus.h@T@SDLECallConfirmationStatus">SDLECallConfirmationStatus</a></span> <span class="n">_Nonnull</span> <span class="n">eCallConfirmationStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLEmergencyEvent.html b/docs/Classes/SDLEmergencyEvent.html index ca40c11e5..f38eef306 100644 --- a/docs/Classes/SDLEmergencyEvent.html +++ b/docs/Classes/SDLEmergencyEvent.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A vehicle data struct for an emergency event</p> <section class="section task-group-section"> @@ -20,12 +20,15 @@ emergencyEventType </h3> - <p>Undocumented</p> + <p>References signal <q>VedsEvntType_D_Ltchd</q>. See EmergencyEventType.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLEmergencyEventType.h@T@SDLEmergencyEventType">SDLEmergencyEventType</a></span> <span class="n">emergencyEventType</span></code></pre> + <pre class="highlight objective_c"><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:SDLEmergencyEventType.h@T@SDLEmergencyEventType">SDLEmergencyEventType</a></span> <span class="n">_Nonnull</span> <span class="n">emergencyEventType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -38,12 +41,15 @@ fuelCutoffStatus </h3> - <p>Undocumented</p> + <p>References signal <q>RCM_FuelCutoff</q>. See FuelCutoffStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLFuelCutoffStatus.h@T@SDLFuelCutoffStatus">SDLFuelCutoffStatus</a></span> <span class="n">fuelCutoffStatus</span></code></pre> + <pre class="highlight objective_c"><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:SDLFuelCutoffStatus.h@T@SDLFuelCutoffStatus">SDLFuelCutoffStatus</a></span> <span class="n">_Nonnull</span> <span class="n">fuelCutoffStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -56,12 +62,15 @@ rolloverEvent </h3> - <p>Undocumented</p> + <p>References signal <q>VedsEvntRoll_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rolloverEvent</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">rolloverEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -74,12 +83,20 @@ maximumChangeVelocity </h3> - <p>Undocumented</p> + <p>References signal <q>VedsMaxDeltaV_D_Ltchd</q>. Change in velocity in KPH.</p> + +<p>Additional reserved values: +0x00 No event, +0xFE Not supported, +0xFF Fault</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maximumChangeVelocity</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">maximumChangeVelocity</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -92,12 +109,15 @@ multipleEvents </h3> - <p>Undocumented</p> + <p>References signal <q>VedsMultiEvnt_D_Ltchd</q>. See VehicleDataEventStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">multipleEvents</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">_Nonnull</span> <span class="n">multipleEvents</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLEncodedSyncPData.html b/docs/Classes/SDLEncodedSyncPData.html index 8fb5f3281..26bbbfc0b 100644 --- a/docs/Classes/SDLEncodedSyncPData.html +++ b/docs/Classes/SDLEncodedSyncPData.html @@ -16,12 +16,19 @@ data </h3> - <p>Undocumented</p> + <p>Contains base64 encoded string of SyncP packets.</p> + +<p>Required, Array length 1 - 100, String length 1 - 1,000,000</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLTTSChunk + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">data</span></code></pre> + <pre class="highlight objective_c"><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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">data</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGPSData.html b/docs/Classes/SDLGPSData.html index 7f591c678..8460386af 100644 --- a/docs/Classes/SDLGPSData.html +++ b/docs/Classes/SDLGPSData.html @@ -35,7 +35,7 @@ longitudeDegrees </h3> - <p>@abstract longitude degrees</p> + <p>longitude degrees</p> <p>Required, Float, -180 - 180</p> @@ -56,7 +56,7 @@ latitudeDegrees </h3> - <p>@abstract latitude degrees</p> + <p>latitude degrees</p> <p>Required, Float, -90 - 90</p> @@ -77,7 +77,7 @@ utcYear </h3> - <p>@abstract utc year</p> + <p>utc year</p> <p>Required, Integer, 2010 - 2100</p> @@ -97,7 +97,7 @@ utcMonth </h3> - <p>@abstract utc month</p> + <p>utc month</p> <p>Required, Integer, 1 - 12</p> @@ -117,7 +117,7 @@ utcDay </h3> - <p>@abstract utc day</p> + <p>utc day</p> <p>Required, Integer, 1 - 31</p> @@ -137,7 +137,7 @@ utcHours </h3> - <p>@abstract utc hours</p> + <p>utc hours</p> <p>Required, Integer, 0 - 23</p> @@ -157,7 +157,7 @@ utcMinutes </h3> - <p>@abstract utc minutes</p> + <p>utc minutes</p> <p>Required, Integer, 0 - 59</p> @@ -177,7 +177,7 @@ utcSeconds </h3> - <p>@abstract utc seconds</p> + <p>utc seconds</p> <p>Required, Integer, 0 - 59</p> @@ -216,7 +216,7 @@ pdop </h3> - <p>@abstract The 3D positional dilution of precision.</p> + <p>The 3D positional dilution of precision.</p> <p>@discussion If undefined or unavailable, then value shall be set to 0</p> @@ -238,7 +238,7 @@ hdop </h3> - <p>@abstract The horizontal dilution of precision</p> + <p>The horizontal dilution of precision</p> <p>@discussion If undefined or unavailable, then value shall be set to 0</p> @@ -260,7 +260,7 @@ vdop </h3> - <p>@abstract the vertical dilution of precision</p> + <p>the vertical dilution of precision</p> <p>@discussion If undefined or unavailable, then value shall be set to 0</p> @@ -282,7 +282,7 @@ actual </h3> - <p>@abstract What the coordinates are based on</p> + <p>What the coordinates are based on</p> <p>@discussion YES, if coordinates are based on satellites. NO, if based on dead reckoning.</p> @@ -304,7 +304,7 @@ satellites </h3> - <p>@abstract The number of satellites in view</p> + <p>The number of satellites in view</p> <p>Required, Integer, 0 - 31</p> @@ -344,7 +344,7 @@ altitude </h3> - <p>@abstract altitude in meters</p> + <p>Altitude in meters</p> <p>Required, Float, -10000.0 - 10000.0</p> @@ -364,7 +364,7 @@ heading </h3> - <p>@abstract Heading based on the GPS data.</p> + <p>Heading based on the GPS data.</p> <p>@discussion North is 0, East is 90, etc. Resolution is 0.01</p> @@ -386,7 +386,7 @@ speed </h3> - <p>@abstract speed in KPH</p> + <p>Speed in KPH</p> <p>Required, Float, 0.0 - 500.0</p> diff --git a/docs/Classes/SDLGetDTCs.html b/docs/Classes/SDLGetDTCs.html index c7d658558..e18072071 100644 --- a/docs/Classes/SDLGetDTCs.html +++ b/docs/Classes/SDLGetDTCs.html @@ -61,7 +61,7 @@ Function Group: ProprietaryData ecuName </h3> - <p>@abstract a name of the module to receive the DTC form + <p>a name of the module to receive the DTC form @discussion an NSNumber value representing a name of the module to receive the DTC form <p> @@ -83,7 +83,7 @@ Function Group: ProprietaryData dtcMask </h3> - <p>@abstract DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255</p> + <p>DTC Mask Byte to be sent in diagnostic request to module. NSNumber* dtcMask Minvalue:0; Maxvalue:255</p> diff --git a/docs/Classes/SDLGetDTCsResponse.html b/docs/Classes/SDLGetDTCsResponse.html index e7e181c75..2491d6a14 100644 --- a/docs/Classes/SDLGetDTCsResponse.html +++ b/docs/Classes/SDLGetDTCsResponse.html @@ -9,9 +9,9 @@ <h3>Overview</h3> -<p>SDLGetDTCsResponse is sent, when SDLGetDTCs has been called</p> +<p>Response to SDLGetDTCs</p> -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -19,12 +19,12 @@ ecuHeader </h3> - <p>Undocumented</p> + <p>2 byte ECU Header for DTC response (as defined in VHR_Layout_Specification_DTCs.pdf)</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">ecuHeader</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">ecuHeader</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +37,12 @@ dtc </h3> - <p>Undocumented</p> + <p>Array of all reported DTCs on module (ecuHeader contains information if list is truncated). Each DTC is represented by 4 bytes (3 bytes of data and 1 byte status as defined in VHR_Layout_Specification_DTCs.pdf).</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">dtc</span></code></pre> + <pre class="highlight objective_c"><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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">dtc</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGetInteriorVehicleDataResponse.html b/docs/Classes/SDLGetInteriorVehicleDataResponse.html index 059fd586b..00d53fcfb 100644 --- a/docs/Classes/SDLGetInteriorVehicleDataResponse.html +++ b/docs/Classes/SDLGetInteriorVehicleDataResponse.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A response to SDLGetInteriorVehicleData</p> <section class="section task-group-section"> @@ -17,12 +17,12 @@ moduleData </h3> - <p>Undocumented</p> + <p>The requested data</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">moduleData</span></code></pre> + <pre class="highlight objective_c"><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/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleData</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,9 +35,11 @@ isSubscribed </h3> - <p>@abstract It is a conditional-mandatory parameter: must be returned in case <q>subscribe</q> parameter was present in the related request. - if <q>true</q> - the <q>moduleType</q> from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. - if <q>false</q> - the <q>moduleType</q> from request is either unsubscribed or failed to subscribe.</p> + <p>It is a conditional-mandatory parameter: must be returned in case <q>subscribe</q> parameter was present in the related request.</p> + +<p>If <q>true</q> - the <q>moduleType</q> from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType.</p> + +<p>If <q>false</q> - the <q>moduleType</q> from request is either unsubscribed or failed to subscribe.</p> <p>Optional, Boolean</p> diff --git a/docs/Classes/SDLGetSystemCapabilityResponse.html b/docs/Classes/SDLGetSystemCapabilityResponse.html index 946baedd5..a866983cb 100644 --- a/docs/Classes/SDLGetSystemCapabilityResponse.html +++ b/docs/Classes/SDLGetSystemCapabilityResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Response to SDLGetSystemCapability</p> <section class="section task-group-section"> @@ -16,12 +16,13 @@ systemCapability </h3> - <p>Undocumented</p> + <p>The requested system capability, of the type that was sent in the request</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLSystemCapability.html">SDLSystemCapability</a></span> <span class="o">*</span><span class="n">systemCapability</span></code></pre> + <pre class="highlight objective_c"><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/SDLSystemCapability.html">SDLSystemCapability</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">systemCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGetVehicleData.html b/docs/Classes/SDLGetVehicleData.html index c9b872143..db3f43127 100644 --- a/docs/Classes/SDLGetVehicleData.html +++ b/docs/Classes/SDLGetVehicleData.html @@ -67,7 +67,7 @@ gps </h3> - <p>@abstract A boolean value. If true, requests Gps data</p> + <p>A boolean value. If true, requests Gps data</p> @@ -85,7 +85,7 @@ speed </h3> - <p>@abstract A boolean value. If true, requests speed data</p> + <p>A boolean value. If true, requests speed data</p> @@ -103,7 +103,7 @@ rpm </h3> - <p>@abstract A boolean value. If true, requests rpm data</p> + <p>A boolean value. If true, requests rpm data</p> @@ -121,7 +121,7 @@ fuelLevel </h3> - <p>@abstract A boolean value. If true, requests FuelLevel data</p> + <p>A boolean value. If true, requests FuelLevel data</p> @@ -139,7 +139,7 @@ fuelLevel_State </h3> - <p>@abstract A boolean value. If true, requests fuelLevel_State data</p> + <p>A boolean value. If true, requests fuelLevel_State data</p> @@ -158,7 +158,7 @@ instantFuelConsumption </h3> - <p>@abstract A boolean value. If true, requests instantFuelConsumption data</p> + <p>A boolean value. If true, requests instantFuelConsumption data</p> @@ -177,7 +177,7 @@ externalTemperature </h3> - <p>@abstract A boolean value. If true, requests externalTemperature data</p> + <p>A boolean value. If true, requests externalTemperature data</p> @@ -196,7 +196,7 @@ vin </h3> - <p>@abstract A boolean value. If true, requests Vehicle Identification Number</p> + <p>A boolean value. If true, requests Vehicle Identification Number</p> @@ -214,7 +214,7 @@ prndl </h3> - <p>@abstract A boolean value. If true, requests Currently selected gear data</p> + <p>A boolean value. If true, requests Currently selected gear data</p> @@ -232,7 +232,7 @@ tirePressure </h3> - <p>@abstract A boolean value. If true, requests tire pressure status data</p> + <p>A boolean value. If true, requests tire pressure status data</p> @@ -251,7 +251,7 @@ odometer </h3> - <p>@abstract A boolean value. If true, requests odometer data</p> + <p>A boolean value. If true, requests odometer data</p> @@ -269,7 +269,7 @@ beltStatus </h3> - <p>@abstract A boolean value. If true, requests belt Status data</p> + <p>A boolean value. If true, requests belt Status data</p> @@ -287,7 +287,7 @@ bodyInformation </h3> - <p>@abstract A boolean value. If true, requests body Information data</p> + <p>A boolean value. If true, requests body Information data</p> @@ -306,7 +306,7 @@ deviceStatus </h3> - <p>@abstract A boolean value. If true, requests device Status data</p> + <p>A boolean value. If true, requests device Status data</p> @@ -325,7 +325,7 @@ driverBraking </h3> - <p>@abstract A boolean value. If true, requests driver Braking data</p> + <p>A boolean value. If true, requests driver Braking data</p> @@ -344,7 +344,7 @@ wiperStatus </h3> - <p>@abstract A boolean value. If true, requests wiper Status data</p> + <p>A boolean value. If true, requests wiper Status data</p> @@ -363,7 +363,7 @@ headLampStatus </h3> - <p>@abstract A boolean value. If true, requests Head Lamp Status data</p> + <p>A boolean value. If true, requests Head Lamp Status data</p> @@ -382,7 +382,7 @@ engineTorque </h3> - <p>@abstract A boolean value. If true, requests Engine Torque data</p> + <p>A boolean value. If true, requests Engine Torque data</p> @@ -401,7 +401,7 @@ accPedalPosition </h3> - <p>@abstract A boolean value. If true, means the accPedalPosition data has been + <p>A boolean value. If true, means the accPedalPosition data has been subscribed.</p> @@ -421,7 +421,7 @@ subscribed.</p> steeringWheelAngle </h3> - <p>@abstract A boolean value. If true, means the steeringWheelAngle data has been + <p>A boolean value. If true, means the steeringWheelAngle data has been subscribed.</p> @@ -441,12 +441,12 @@ subscribed.</p> eCallInfo </h3> - <p>Undocumented</p> + <p>If true, the Emergency Call notification and confirmation data has been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">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">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -459,12 +459,13 @@ subscribed.</p> airbagStatus </h3> - <p>Undocumented</p> + <p>If true, the status of the air bags has been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">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">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -477,12 +478,13 @@ subscribed.</p> emergencyEvent </h3> - <p>Undocumented</p> + <p>If true, information related to an emergency event (and if it occurred) has been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">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">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -495,12 +497,13 @@ subscribed.</p> clusterModeStatus </h3> - <p>Undocumented</p> + <p>If true, the status modes of the cluster have been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">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">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -513,12 +516,12 @@ subscribed.</p> myKey </h3> - <p>Undocumented</p> + <p>If true, information related to the MyKey feature has been subscribed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">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">myKey</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGetVehicleDataResponse.html b/docs/Classes/SDLGetVehicleDataResponse.html index d7b1fda8f..a6ad7d218 100644 --- a/docs/Classes/SDLGetVehicleDataResponse.html +++ b/docs/Classes/SDLGetVehicleDataResponse.html @@ -32,7 +32,7 @@ <h3>Overview</h3> -<p>Get Vehicle Data Response is sent, when SDLGetVehicleData has been called</p> +<p>Response to SDLGetVehicleData</p> <p>Since SmartDeviceLink 2.0</p> @@ -42,7 +42,7 @@ gps </h3> - <p>@abstract A SDLGPSData* value. See GPSData.</p> + <p>The car current GPS coordinates</p> @@ -60,7 +60,7 @@ speed </h3> - <p>@abstract The vehicle speed in kilometers per hour.</p> + <p>The vehicle speed in kilometers per hour</p> @@ -78,7 +78,7 @@ rpm </h3> - <p>@abstract The number of revolutions per minute of the engine.</p> + <p>The number of revolutions per minute of the engine.</p> @@ -96,7 +96,7 @@ fuelLevel </h3> - <p>@abstract The fuel level in the tank (percentage)</p> + <p>The fuel level in the tank (percentage)</p> @@ -114,7 +114,7 @@ fuelLevel_State </h3> - <p>@abstract A SDLComponentVolumeStatus* value. The fuel level state.</p> + <p>The fuel level state</p> @@ -133,7 +133,7 @@ instantFuelConsumption </h3> - <p>@abstract The instantaneous fuel consumption in microlitres.</p> + <p>The instantaneous fuel consumption in microlitres</p> @@ -152,7 +152,7 @@ externalTemperature </h3> - <p>@abstract The external temperature in degrees celsius.</p> + <p>The external temperature in degrees celsius.</p> @@ -171,7 +171,7 @@ vin </h3> - <p>@abstract The Vehicle Identification Number</p> + <p>The Vehicle Identification Number</p> @@ -189,7 +189,7 @@ prndl </h3> - <p>@abstract See PRNDL.</p> + <p>The current gear shift state of the user’s vehicle</p> @@ -207,7 +207,7 @@ tirePressure </h3> - <p>@abstract A SDLTireStatus* value. See TireStatus.</p> + <p>The current pressure warnings for the user’s vehicle</p> @@ -225,7 +225,7 @@ odometer </h3> - <p>@abstract Odometer reading in km.</p> + <p>Odometer reading in km</p> @@ -243,7 +243,7 @@ beltStatus </h3> - <p>@abstract A SDLBeltStatus* value. The status of the seat belts.</p> + <p>The status of the seat belts</p> @@ -261,7 +261,7 @@ bodyInformation </h3> - <p>@abstract A SDLBodyInformation* value. The body information including power modes.</p> + <p>The body information including power modes</p> @@ -280,7 +280,7 @@ deviceStatus </h3> - <p>@abstract A SDLDeviceStatus* value. The device status including signal and battery strength.</p> + <p>The IVI system status including signal and battery strength</p> @@ -298,7 +298,7 @@ driverBraking </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p> + <p>The status of the brake pedal</p> @@ -317,7 +317,7 @@ wiperStatus </h3> - <p>@abstract A SDLWiperStatus* value. The status of the wipers.</p> + <p>The status of the wipers</p> @@ -335,7 +335,7 @@ headLampStatus </h3> - <p>@abstract A SDLHeadLampStatus* value. Status of the head lamps.</p> + <p>Status of the head lamps</p> @@ -354,7 +354,7 @@ engineTorque </h3> - <p>@abstract Torque value for engine (in Nm) on non-diesel variants.</p> + <p>Torque value for engine (in Nm) on non-diesel variants</p> @@ -373,7 +373,7 @@ accPedalPosition </h3> - <p>@abstract Accelerator pedal position (percentage depressed)</p> + <p>Accelerator pedal position (percentage depressed)</p> @@ -392,7 +392,7 @@ steeringWheelAngle </h3> - <p>@abstract Current angle of the steering wheel (in deg)</p> + <p>Current angle of the steering wheel (in deg)</p> @@ -411,12 +411,12 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>Emergency Call notification and confirmation data</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLECallInfo.html">SDLECallInfo</a></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLECallInfo.html">SDLECallInfo</a></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -429,12 +429,12 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>The status of the air bags</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLAirbagStatus.html">SDLAirbagStatus</a></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAirbagStatus.html">SDLAirbagStatus</a></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -447,12 +447,13 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>Information related to an emergency event (and if it occurred)</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLEmergencyEvent.html">SDLEmergencyEvent</a></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLEmergencyEvent.html">SDLEmergencyEvent</a></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -465,12 +466,13 @@ clusterModeStatus </h3> - <p>Undocumented</p> + <p>The status modes of the cluster</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLClusterModeStatus.html">SDLClusterModeStatus</a></span> <span class="o">*</span><span class="n">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLClusterModeStatus.html">SDLClusterModeStatus</a></span> <span class="o">*</span><span class="n">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -483,12 +485,12 @@ myKey </h3> - <p>Undocumented</p> + <p>Information related to the MyKey feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLMyKey.html">SDLMyKey</a></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMyKey.html">SDLMyKey</a></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLGetWaypointsResponse.html b/docs/Classes/SDLGetWaypointsResponse.html index c3d20da9f..a6bfee66d 100644 --- a/docs/Classes/SDLGetWaypointsResponse.html +++ b/docs/Classes/SDLGetWaypointsResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Response to SDLGetWayPoints</p> <section class="section task-group-section"> @@ -16,12 +16,7 @@ waypoints </h3> - <p>@abstract Array of waypoints</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLLocationDetails - -</div> + <p>Provides additional human readable info regarding the result.</p> <p>Optional, Array size 1 - 10</p> diff --git a/docs/Classes/SDLHMIPermissions.html b/docs/Classes/SDLHMIPermissions.html index 6a5daef7b..7bdee41b4 100644 --- a/docs/Classes/SDLHMIPermissions.html +++ b/docs/Classes/SDLHMIPermissions.html @@ -19,7 +19,7 @@ allowed </h3> - <p>@abstract a set of all HMI levels that are permitted for this given RPC</p> + <p>A set of all HMI levels that are permitted for this given RPC</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLHMILevel @@ -44,7 +44,7 @@ userDisallowed </h3> - <p>@abstract a set of all HMI levels that are prohibited for this given RPC</p> + <p>A set of all HMI levels that are prohibited for this given RPC</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLHMILevel diff --git a/docs/Classes/SDLHapticRect.html b/docs/Classes/SDLHapticRect.html index 191161ea5..b5f4b0015 100644 --- a/docs/Classes/SDLHapticRect.html +++ b/docs/Classes/SDLHapticRect.html @@ -36,8 +36,9 @@ id </h3> - <p>A user control spatial identifier -Required, Integer, 0 - 2,000,000,000</p> + <p>A user control spatial identifier</p> + +<p>Required, Integer, 0 - 2,000,000,000</p> @@ -55,12 +56,14 @@ Required, Integer, 0 - 2,000,000,000</p> rect </h3> - <p>Undocumented</p> + <p>The position of the haptic rectangle to be highlighted. The center of this rectangle will be <q>touched</q> when a press occurs.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLRectangle.html">SDLRectangle</a></span> <span class="o">*</span><span class="n">rect</span></code></pre> + <pre class="highlight objective_c"><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/SDLRectangle.html">SDLRectangle</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rect</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLHeadLampStatus.html b/docs/Classes/SDLHeadLampStatus.html index db7f3878a..1f84c166a 100644 --- a/docs/Classes/SDLHeadLampStatus.html +++ b/docs/Classes/SDLHeadLampStatus.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Status of the head lamps</p> +<p>Vehicle data struct for status of head lamps</p> <section class="section task-group-section"> @@ -18,7 +18,9 @@ lowBeamsOn </h3> - <p>@abstract A boolean value. Status of the low beam lamps.</p> + <p>Low beams are on or off.</p> + +<p>Required, boolean</p> @@ -36,7 +38,9 @@ highBeamsOn </h3> - <p>@abstract A boolean value. Status of the high beam lamps.</p> + <p>High beams are on or off</p> + +<p>Required, boolean</p> @@ -54,12 +58,15 @@ ambientLightSensorStatus </h3> - <p>Undocumented</p> + <p>Status of the ambient light senser</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">ambientLightSensorStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLAmbientLightStatus.h@T@SDLAmbientLightStatus">SDLAmbientLightStatus</a></span> <span class="n">ambientLightSensorStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLIAPTransport.html b/docs/Classes/SDLIAPTransport.html deleted file mode 100644 index c5ad7a1e4..000000000 --- a/docs/Classes/SDLIAPTransport.html +++ /dev/null @@ -1,52 +0,0 @@ -<h1>SDLIAPTransport Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-controlSession">controlSession</a></li> - <li><a href="#section-session">session</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-controlSession"> - controlSession - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">SDLIAPSession</span> <span class="o">*</span><span class="n">controlSession</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">controlSession</span><span class="p">:</span> <span class="nf">SDLIAPSession</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> - - - - - <h3 id="section-session"> - session - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">SDLIAPSession</span> <span class="o">*</span><span class="n">session</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">session</span><span class="p">:</span> <span class="nf">SDLIAPSession</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> - - - - -</section> diff --git a/docs/Classes/SDLImage.html b/docs/Classes/SDLImage.html index 030f10ff3..e534c9216 100644 --- a/docs/Classes/SDLImage.html +++ b/docs/Classes/SDLImage.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Specifies, which image shall be used, e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.</p> +<p>Specifies which image shall be used e.g. in SDLAlerts or on SDLSoftbuttons provided the display supports it.</p> <p>@since SDL 2.0</p> @@ -76,7 +76,7 @@ value </h3> - <p>@abstract The static hex icon value or the binary image file name identifier (sent by SDLPutFile)</p> + <p>The static hex icon value or the binary image file name identifier (sent by SDLPutFile)</p> <p>Required, max length = 65535</p> @@ -96,7 +96,7 @@ imageType </h3> - <p>@abstract Describes whether the image is static or dynamic</p> + <p>Describes whether the image is static or dynamic</p> <p>Required</p> diff --git a/docs/Classes/SDLImageField.html b/docs/Classes/SDLImageField.html index 7c1919ad6..588056e5f 100644 --- a/docs/Classes/SDLImageField.html +++ b/docs/Classes/SDLImageField.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct used in DisplayCapabilities describing the capability of an image field</p> <section class="section task-group-section"> @@ -18,12 +18,14 @@ name </h3> - <p>Undocumented</p> + <p>The name that identifies the field.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span> <span class="n">name</span></code></pre> + <pre class="highlight objective_c"><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:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span> <span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +38,15 @@ imageTypeSupported </h3> - <p>Undocumented</p> + <p>The image types that are supported in this field.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="o">></span> <span class="o">*</span><span class="n">imageTypeSupported</span></code></pre> + <pre class="highlight objective_c"><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="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">imageTypeSupported</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +59,15 @@ imageResolution </h3> - <p>Undocumented</p> + <p>The image resolution of this field</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">imageResolution</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">imageResolution</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLImageResolution.html b/docs/Classes/SDLImageResolution.html index e2bcf79d7..60ea5e1f5 100644 --- a/docs/Classes/SDLImageResolution.html +++ b/docs/Classes/SDLImageResolution.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The resolution of an image</p> <section class="section task-group-section"> @@ -18,12 +18,15 @@ resolutionWidth </h3> - <p>Undocumented</p> + <p>Resolution width</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">resolutionWidth</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">resolutionWidth</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +39,15 @@ resolutionHeight </h3> - <p>Undocumented</p> + <p>Resolution height</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">resolutionHeight</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">resolutionHeight</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLKeyboardProperties.html b/docs/Classes/SDLKeyboardProperties.html index f7e843a89..0ee8c8dfd 100644 --- a/docs/Classes/SDLKeyboardProperties.html +++ b/docs/Classes/SDLKeyboardProperties.html @@ -13,7 +13,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Configuration of on-screen keyboard (if available)</p> <section class="section task-group-section"> @@ -39,12 +39,14 @@ language </h3> - <p>Undocumented</p> + <p>The keyboard language</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">language</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">language</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -57,12 +59,15 @@ keyboardLayout </h3> - <p>Undocumented</p> + <p>Desired keyboard layout</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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:SDLKeyboardLayout.h@T@SDLKeyboardLayout">SDLKeyboardLayout</a></span> <span class="n">keyboardLayout</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLKeyboardLayout.h@T@SDLKeyboardLayout">SDLKeyboardLayout</a></span> <span class="n">keyboardLayout</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -75,12 +80,16 @@ keypressMode </h3> - <p>Undocumented</p> + <p>Desired keypress mode.</p> + +<p>If omitted, this value will be set to RESEND_CURRENT_ENTRY.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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:SDLKeypressMode.h@T@SDLKeypressMode">SDLKeypressMode</a></span> <span class="n">keypressMode</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLKeypressMode.h@T@SDLKeypressMode">SDLKeypressMode</a></span> <span class="n">keypressMode</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -93,12 +102,15 @@ limitedCharacterList </h3> - <p>Undocumented</p> + <p>Array of keyboard characters to enable. All omitted characters will be greyed out (disabled) on the keyboard. If omitted, the entire keyboard will be enabled.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">limitedCharacterList</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <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">limitedCharacterList</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -111,12 +123,14 @@ autoCompleteText </h3> - <p>Undocumented</p> + <p>Allows an app to prepopulate the text field with a suggested or completed entry as the user types</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">autoCompleteText</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">autoCompleteText</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLListFilesResponse.html b/docs/Classes/SDLListFilesResponse.html index 5459a4339..4e7f1bc7f 100644 --- a/docs/Classes/SDLListFilesResponse.html +++ b/docs/Classes/SDLListFilesResponse.html @@ -9,9 +9,9 @@ <h3>Overview</h3> -<p>SDLListFilesResponse is sent, when SDLListFiles has been called</p> +<p>Response to SDLListFiles</p> -<p>Since <b>SmartDeviceLink 2.0</b></p> +<p>Since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -19,12 +19,13 @@ filenames </h3> - <p>Undocumented</p> + <p>An array of all filenames resident on the module for the given registered app. If omitted, then no files currently reside on the system.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">filenames</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <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">filenames</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +38,13 @@ spaceAvailable </h3> - <p>Undocumented</p> + <p>Provides the total local space available on the module for the registered app.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">spaceAvailable</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">spaceAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLLocationCoordinate.html b/docs/Classes/SDLLocationCoordinate.html index 3f6a09437..38d00de2a 100644 --- a/docs/Classes/SDLLocationCoordinate.html +++ b/docs/Classes/SDLLocationCoordinate.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Describes a coordinate on earth</p> <section class="section task-group-section"> @@ -17,7 +17,7 @@ latitudeDegrees </h3> - <p>@abstract Latitude of the location</p> + <p>Latitude of the location</p> <p>Required, Double -90 - 90</p> @@ -38,7 +38,7 @@ longitudeDegrees </h3> - <p>@abstract Longitude of the location</p> + <p>Longitude of the location</p> <p>Required, Double -180 - 180</p> diff --git a/docs/Classes/SDLLocationDetails.html b/docs/Classes/SDLLocationDetails.html index e7e33cc37..bbd44b70b 100644 --- a/docs/Classes/SDLLocationDetails.html +++ b/docs/Classes/SDLLocationDetails.html @@ -14,7 +14,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Describes a location, including its coordinate, name, etc. Used in WayPoints.</p> <section class="section task-group-section"> @@ -22,7 +22,7 @@ coordinate </h3> - <p>@abstract Latitude/Longitude of the location</p> + <p>Latitude/Longitude of the location</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLLocationCoordinate @@ -48,7 +48,7 @@ locationName </h3> - <p>@abstract Name of location.</p> + <p>Name of location.</p> <p>Optional, Max length 500 chars</p> @@ -68,7 +68,7 @@ addressLines </h3> - <p>@abstract Location address for display purposes only.</p> + <p>Location address for display purposes only.</p> <p>Optional, Array of Strings, Array length 0 - 4, Max String length 500</p> @@ -89,7 +89,7 @@ locationDescription </h3> - <p>@abstract Description intended location / establishment.</p> + <p>Description intended location / establishment.</p> <p>Optional, Max length 500 chars</p> @@ -109,7 +109,7 @@ phoneNumber </h3> - <p>@abstract Phone number of location / establishment.</p> + <p>Phone number of location / establishment.</p> <p>Optional, Max length 500 chars</p> @@ -129,7 +129,7 @@ locationImage </h3> - <p>@abstract Image / icon of intended location.</p> + <p>Image / icon of intended location.</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLImage @@ -154,7 +154,7 @@ searchAddress </h3> - <p>@abstract Address to be used by navigation engines for search.</p> + <p>Address to be used by navigation engines for search.</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLOASISAddress diff --git a/docs/Classes/SDLLogManager.html b/docs/Classes/SDLLogManager.html index 5badd84a3..408a74e5c 100644 --- a/docs/Classes/SDLLogManager.html +++ b/docs/Classes/SDLLogManager.html @@ -33,12 +33,13 @@ modules </h3> - <p>Undocumented</p> + <p>Active log modules</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFileModule.html">SDLLogFileModule</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">modules</span></code></pre> + <pre class="highlight objective_c"><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">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFileModule.html">SDLLogFileModule</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">modules</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -51,12 +52,12 @@ targets </h3> - <p>Undocumented</p> + <p>Active log targets</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLLogTarget.html">SDLLogTarget</a></span><span class="o">>></span> <span class="o">*</span><span class="n">targets</span></code></pre> + <pre class="highlight objective_c"><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">NSSet</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLLogTarget.html">SDLLogTarget</a></span><span class="o">>></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">targets</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -69,12 +70,12 @@ filters </h3> - <p>Undocumented</p> + <p>Active log filters</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFilter.html">SDLLogFilter</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">filters</span></code></pre> + <pre class="highlight objective_c"><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">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFilter.html">SDLLogFilter</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">filters</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -105,12 +106,12 @@ formatType </h3> - <p>Undocumented</p> + <p>Active log format</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogFormatType.html">SDLLogFormatType</a></span> <span class="n">formatType</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogFormatType.html">SDLLogFormatType</a></span> <span class="n">formatType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -123,12 +124,14 @@ asynchronous </h3> - <p>Undocumented</p> + <p>Whether or not verbose, debug, and warning logs are logged asynchronously. If logs are performed async, then some may be missed in the event of a terminating signal such as an exception, but performance is improved and your code will not be slowed by logging.</p> + +<p>Defaults to TRUE</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isAsynchronous</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">asynchronous</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isAsynchronous</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">asynchronous</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -141,12 +144,15 @@ errorsAsynchronous </h3> - <p>Undocumented</p> + <p>Whether or not error logs are logged asynchronously. If logs are performed async, then some may be missed in the event of a terminating signal such as an exception, but performance is improved and your code will not be slowed by logging.</p> + +<p>Defaults to FALSE</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">areErrorsAsynchronous</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">errorsAsynchronous</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">areErrorsAsynchronous</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">errorsAsynchronous</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -159,12 +165,13 @@ dateFormatter </h3> - <p>Undocumented</p> + <p>Active date formatter</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">class</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">readonly</span><span class="p">)</span> <span class="n">NSDateFormatter</span> <span class="o">*</span><span class="n">dateFormatter</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">class</span><span class="p">)</span> + <span class="n">NSDateFormatter</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">dateFormatter</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -177,12 +184,13 @@ logQueue </h3> - <p>Undocumented</p> + <p>The queue asynchronously logged logs are logged on. Say that 10 times fast.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">class</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">dispatch_queue_t</span> <span class="n">logQueue</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">class</span><span class="p">)</span> + <span class="n">dispatch_queue_t</span> <span class="n">_Nonnull</span> <span class="n">logQueue</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -195,12 +203,12 @@ +sharedManager </h3> - <p>Undocumented</p> + <p>The singleton object</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLogManager</span> <span class="o">*</span><span class="p">)</span><span class="n">sharedManager</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogManager</span> <span class="o">*</span><span class="p">)</span><span class="n">sharedManager</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -208,6 +216,10 @@ + <div> + <h4>Return Value</h4> + <p>The singleton object</p> + </div> <h3 id="section-+setConfiguration:"> +setConfiguration: diff --git a/docs/Classes/SDLManager.html b/docs/Classes/SDLManager.html index 717618604..43dc749d6 100644 --- a/docs/Classes/SDLManager.html +++ b/docs/Classes/SDLManager.html @@ -11,6 +11,7 @@ <li><a href="#section-permissionManager">permissionManager</a></li> <li><a href="#section-streamManager">streamManager</a></li> <li><a href="#section-screenManager">screenManager</a></li> + <li><a href="#section-systemCapabilityManager">systemCapabilityManager</a></li> <li><a href="#section-registerResponse">registerResponse</a></li> <li><a href="#section-delegate">delegate</a></li> <li><a href="#section-pendingRPCTransactions">pendingRPCTransactions</a></li> @@ -163,12 +164,12 @@ screenManager </h3> - <p>Undocumented</p> + <p>The screen manager for sending UI related RPCs.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLScreenManager.html">SDLScreenManager</a></span> <span class="o">*</span><span class="n">screenManager</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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/SDLScreenManager.html">SDLScreenManager</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">screenManager</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -177,6 +178,25 @@ + <h3 id="section-systemCapabilityManager"> + systemCapabilityManager + </h3> + + <p>Centralized manager for retrieving all system capabilities.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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/SDLSystemCapabilityManager.html">SDLSystemCapabilityManager</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">systemCapabilityManager</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">systemCapabilityManager</span><span class="p">:</span> <span class="nf">SDLSystemCapabilityManager</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + <h3 id="section-registerResponse"> registerResponse </h3> @@ -239,7 +259,7 @@ <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="n">proxy</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">SDLProxy</span> <span class="o">*</span><span class="n">proxy</span></code></pre> <h4>Swift</h4> @@ -379,13 +399,13 @@ <h4>Objective-C</h4> <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRequests</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">requests</span> <span class="nf">progressHandler</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> <span class="nf">completionHandler</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> @@ -411,13 +431,13 @@ <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span> <span class="nf">sendSequentialRequests</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">requests</span> <span class="nf">progressHandler</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> <span class="nf">completionHandler</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendSequential</span><span class="p">(</span><span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLManager.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendSequential</span><span class="p">(</span><span class="nv">requests</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> diff --git a/docs/Classes/SDLMenuCell.html b/docs/Classes/SDLMenuCell.html new file mode 100644 index 000000000..11941f009 --- /dev/null +++ b/docs/Classes/SDLMenuCell.html @@ -0,0 +1,149 @@ +<h1>SDLMenuCell Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-title">title</a></li> + <li><a href="#section-icon">icon</a></li> + <li><a href="#section-voiceCommands">voiceCommands</a></li> + <li><a href="#section-handler">handler</a></li> + <li><a href="#section-subCells">subCells</a></li> + <li><a href="#section--initWithTitle:icon:voiceCommands:handler:">-initWithTitle:icon:voiceCommands:handler:</a></li> + <li><a href="#section--initWithTitle:subCells:">-initWithTitle:subCells:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-title"> + title + </h3> + + <p>The cell’s text to be displayed</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">title</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">title</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-icon"> + icon + </h3> + + <p>The cell’s icon to be displayed</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">icon</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">icon</span><span class="p">:</span> <span class="nf">SDLArtwork</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-voiceCommands"> + voiceCommands + </h3> + + <p>The strings the user can say to activate this 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">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">nullable</span><span class="p">)</span> + <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">voiceCommands</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">voiceCommands</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="p">}</span></code></pre> + + + + + <h3 id="section-handler"> + handler + </h3> + + <p>The handler that will be called when the command is activated</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">handler</span><span class="p">:</span> <span class="nf">SDLMenuCellSelectionHandler</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-subCells"> + subCells + </h3> + + <p>If this is non-nil, this cell will be a sub-menu button, displaying the subcells in a menu when pressed.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLMenuCell</span> <span class="o">*></span> <span class="o">*</span><span class="n">subCells</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">subCells</span><span class="p">:</span> <span class="p">[</span><span class="kt">SDLMenuCell</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--initWithTitle:icon:voiceCommands:handler:"> + -initWithTitle:icon:voiceCommands:handler: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">voiceCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</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">title</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">icon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span><span class="p">?,</span> <span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?,</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span><span class="p">)</span></code></pre> + + + + + <h3 id="section--initWithTitle:subCells:"> + -initWithTitle:subCells: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">subCells</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLMenuCell</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">subCells</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">title</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">subCells</span><span class="p">:</span> <span class="p">[</span><span class="kt">SDLMenuCell</span><span class="p">])</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLMenuParams.html b/docs/Classes/SDLMenuParams.html index 351edb322..f74fd7399 100644 --- a/docs/Classes/SDLMenuParams.html +++ b/docs/Classes/SDLMenuParams.html @@ -58,8 +58,9 @@ parentID </h3> - <p>@abstract the unique ID of an existing submenu to which a command will be added - @discussion If this element is not provided, the command will be added to the top level of the Command Menu.</p> + <p>The unique ID of an existing submenu to which a command will be added</p> + +<p>If this element is not provided, the command will be added to the top level of the Command Menu.</p> <p>Optional, Integer, 0 - 2,000,000,000</p> @@ -79,15 +80,15 @@ position </h3> - <p>@abstract The position within the items of the parent Command Menu - @discussion 0 will insert at the front, 1 will insert after the first existing element, etc.</p> + <p>The position within the items of the parent Command Menu</p> + +<p>0 will insert at the front, 1 will insert after the first existing element, etc.</p> <p>Position of any submenu will always be located before the return and exit options.</p> -<ul> -<li><p>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</p></li> -<li><p>If this element is omitted, the entry will be added at the end of the parent menu.</p></li> -</ul> +<p>If position is greater or equal than the number of items in the parent Command Menu, the sub menu will be appended to the end of that Command Menu.</p> + +<p>If this element is omitted, the entry will be added at the end of the parent menu.</p> <p>Optional, Integer, 0 - 1000</p> @@ -107,7 +108,7 @@ menuName </h3> - <p>@abstract the menu name which appears in menu, representing this command</p> + <p>The menu name which appears in menu, representing this command</p> <p>Required, max length 500 characters</p> diff --git a/docs/Classes/SDLMetadataTags.html b/docs/Classes/SDLMetadataTags.html index 8119443da..15adc0a78 100644 --- a/docs/Classes/SDLMetadataTags.html +++ b/docs/Classes/SDLMetadataTags.html @@ -21,7 +21,7 @@ -initWithTextFieldTypes:mainField2: </h3> - <p>@abstract Constructs a newly allocated SDLMetadataType object with NSArrays</p> + <p>Constructs a newly allocated SDLMetadataType object with NSArrays</p> @@ -59,11 +59,11 @@ mainField1 </h3> - <p>@abstract The type of data contained in the <q>mainField1</q> text field, Optional.</p> + <p>The type of data contained in the <q>mainField1</q> text field.</p> -<p>minsize= 0</p> +<p>minsize= 0, maxsize= 5</p> -<p>maxsize= 5</p> +<p>Optional</p> @@ -82,11 +82,11 @@ mainField2 </h3> - <p>@abstract The type of data contained in the <q>mainField2</q> text field, Optional.</p> + <p>The type of data contained in the <q>mainField2</q> text field.</p> -<p>minsize= 0</p> +<p>minsize= 0, maxsize= 5</p> -<p>maxsize= 5</p> +<p>Optional</p> @@ -105,11 +105,11 @@ mainField3 </h3> - <p>@abstract The type of data contained in the <q>mainField3</q> text field, Optional.</p> + <p>The type of data contained in the <q>mainField3</q> text field.</p> -<p>minsize= 0</p> +<p>minsize= 0, maxsize= 5</p> -<p>maxsize= 5</p> +<p>Optional</p> @@ -128,11 +128,11 @@ mainField4 </h3> - <p>@abstract The type of data contained in the <q>mainField4</q> text field, Optional.</p> + <p>The type of data contained in the <q>mainField4</q> text field.</p> -<p>minsize= 0</p> +<p>minsize= 0, maxsize= 5</p> -<p>maxsize= 5</p> +<p>Optional</p> diff --git a/docs/Classes/SDLModuleData.html b/docs/Classes/SDLModuleData.html index be0761582..7f971cd74 100644 --- a/docs/Classes/SDLModuleData.html +++ b/docs/Classes/SDLModuleData.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Describes a remote control module’s data</p> <section class="section task-group-section"> @@ -56,9 +56,11 @@ moduleType </h3> - <p>The moduleType indicates which type of data should be changed -and identifies which data object exists in this struct. -For example, if the moduleType is CLIMATE then a <q>climateControlData</q> should exist</p> + <p>The moduleType indicates which type of data should be changed and identifies which data object exists in this struct.</p> + +<p>For example, if the moduleType is CLIMATE then a <q>climateControlData</q> should exist</p> + +<p>Required</p> @@ -76,12 +78,15 @@ For example, if the moduleType is CLIMATE then a <q>climateControlData</q> shoul radioControlData </h3> - <p>Undocumented</p> + <p>The radio control data</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLRadioControlData.html">SDLRadioControlData</a></span> <span class="o">*</span><span class="n">radioControlData</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLRadioControlData.html">SDLRadioControlData</a></span> <span class="o">*</span><span class="n">radioControlData</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -94,12 +99,15 @@ For example, if the moduleType is CLIMATE then a <q>climateControlData</q> shoul climateControlData </h3> - <p>Undocumented</p> + <p>The climate control data</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLClimateControlData.html">SDLClimateControlData</a></span> <span class="o">*</span><span class="n">climateControlData</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLClimateControlData.html">SDLClimateControlData</a></span> <span class="o">*</span><span class="n">climateControlData</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLMyKey.html b/docs/Classes/SDLMyKey.html index 1b2d260dc..bb987d40c 100644 --- a/docs/Classes/SDLMyKey.html +++ b/docs/Classes/SDLMyKey.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Vehicle Data struct</p> <section class="section task-group-section"> @@ -16,12 +16,13 @@ e911Override </h3> - <p>Undocumented</p> + <p>Indicates whether e911 override is on. References signal <q>MyKey_e911Override_St</q>. See VehicleDataStatus.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataStatus.h@T@SDLVehicleDataStatus">SDLVehicleDataStatus</a></span> <span class="n">e911Override</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataStatus.h@T@SDLVehicleDataStatus">SDLVehicleDataStatus</a></span> <span class="n">_Nonnull</span> <span class="n">e911Override</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLNavigationCapability.html b/docs/Classes/SDLNavigationCapability.html index 12f45c4aa..42f5cf642 100644 --- a/docs/Classes/SDLNavigationCapability.html +++ b/docs/Classes/SDLNavigationCapability.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Extended capabilities for an onboard navigation system</p> <section class="section task-group-section"> @@ -36,8 +36,9 @@ sendLocationEnabled </h3> - <p>Whether or not the SendLocation RPC is enabled. -Boolean, optional</p> + <p>Whether or not the SendLocation RPC is enabled.</p> + +<p>Boolean, optional</p> @@ -55,8 +56,9 @@ Boolean, optional</p> getWayPointsEnabled </h3> - <p>Whether or not Waypoint related RPCs are enabled. -Boolean, optional</p> + <p>Whether or not Waypoint related RPCs are enabled.</p> + +<p>Boolean, optional</p> diff --git a/docs/Classes/SDLNotificationConstants.html b/docs/Classes/SDLNotificationConstants.html index 7939d4a6d..3fa328e05 100644 --- a/docs/Classes/SDLNotificationConstants.html +++ b/docs/Classes/SDLNotificationConstants.html @@ -17,12 +17,12 @@ +allResponseNames </h3> - <p>Undocumented</p> + <p>All of the possible SDL RPC Response notification names</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allResponseNames</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allResponseNames</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -30,17 +30,21 @@ + <div> + <h4>Return Value</h4> + <p>The names</p> + </div> <h3 id="section-+allButtonEventNotifications"> +allButtonEventNotifications </h3> - <p>Undocumented</p> + <p>All of the possible SDL Button event notification names</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allButtonEventNotifications</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allButtonEventNotifications</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -48,5 +52,9 @@ + <div> + <h4>Return Value</h4> + <p>The names</p> + </div> </section> diff --git a/docs/Classes/SDLOasisAddress.html b/docs/Classes/SDLOasisAddress.html index a4ec8e2f5..a97c62af8 100644 --- a/docs/Classes/SDLOasisAddress.html +++ b/docs/Classes/SDLOasisAddress.html @@ -18,7 +18,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Struct used in SendLocation describing an address</p> <section class="section task-group-section"> @@ -62,7 +62,7 @@ countryName </h3> - <p>@abstract Name of the country (localized)</p> + <p>Name of the country (localized)</p> <p>Optional, max length = 200</p> @@ -82,7 +82,7 @@ countryCode </h3> - <p>@abstract countryCode of the country(ISO 3166-2)</p> + <p>countryCode of the country(ISO 3166-2)</p> <p>Optional, max length = 200</p> @@ -102,7 +102,7 @@ postalCode </h3> - <p>@abstract postalCode of location (PLZ, ZIP, PIN, CAP etc.)</p> + <p>postalCode of location (PLZ, ZIP, PIN, CAP etc.)</p> <p>Optional, max length = 200</p> @@ -122,7 +122,7 @@ administrativeArea </h3> - <p>@abstract Portion of country (e.g. state)</p> + <p>Portion of country (e.g. state)</p> <p>Optional, max length = 200</p> @@ -142,7 +142,7 @@ subAdministrativeArea </h3> - <p>@abstract Portion of administrativeArea (e.g. county)</p> + <p>Portion of administrativeArea (e.g. county)</p> <p>Optional, max length = 200</p> @@ -162,7 +162,7 @@ locality </h3> - <p>@abstract Hypernym for city/village</p> + <p>Hypernym for city/village</p> <p>Optional, max length = 200</p> @@ -182,7 +182,7 @@ subLocality </h3> - <p>@abstract Hypernym for district</p> + <p>Hypernym for district</p> <p>Optional, max length = 200</p> @@ -202,7 +202,7 @@ thoroughfare </h3> - <p>@abstract Hypernym for street, road etc.</p> + <p>Hypernym for street, road etc.</p> <p>Optional, max length = 200</p> @@ -222,7 +222,7 @@ subThoroughfare </h3> - <p>@abstract Portion of thoroughfare (e.g. house number)</p> + <p>Portion of thoroughfare (e.g. house number)</p> <p>Optional, max length = 200</p> diff --git a/docs/Classes/SDLOnAppInterfaceUnregistered.html b/docs/Classes/SDLOnAppInterfaceUnregistered.html index b66fd98e9..c73b4850b 100644 --- a/docs/Classes/SDLOnAppInterfaceUnregistered.html +++ b/docs/Classes/SDLOnAppInterfaceUnregistered.html @@ -25,7 +25,7 @@ reason </h3> - <p>@abstract The reason application’s interface was terminated</p> + <p>The reason application’s interface was terminated</p> diff --git a/docs/Classes/SDLOnButtonEvent.html b/docs/Classes/SDLOnButtonEvent.html index e995d80bb..b1bad9689 100644 --- a/docs/Classes/SDLOnButtonEvent.html +++ b/docs/Classes/SDLOnButtonEvent.html @@ -11,39 +11,33 @@ <h3>Overview</h3> <p>Notifies application that user has depressed or released a button to which - the application has subscribed.</p> - -<p>Further information about button events - and button-presses can be found at SDLSubscribeButton. - <p> - </p> - <b>HMI Status Requirements:</b> - <ul> - HMILevel: - <ul> - <li>The application will receive <i>SDLOnButtonEvent</i> notifications for all - subscribed buttons when HMILevel is FULL.</li> - <li>The application will receive <i>SDLOnButtonEvent</i> notifications for subscribed - media buttons when HMILevel is LIMITED.</li> - <li>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and - PRESET_0-PRESET_9.</li> - <li>The application will not receive <i>SDLOnButtonEvent</i> notification when HMILevel - is BACKGROUND.</li> - </ul> - AudioStreamingState: - <ul> - <li> Any </li> - </ul> - SystemContext: - <ul> - <li>MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable - button will cancel VR.</li> - </ul> - </ul> - <p></p> +the application has subscribed.</p> + +<p>Further information about button events and button-presses can be found at SDLSubscribeButton.</p> + +<p>HMI Status Requirements:</p> + +<p>HMILevel:</p> + +<ul> +<li><p>The application will receive <i>SDLOnButtonEvent</i> notifications for all subscribed buttons when HMILevel is FULL.</p></li> +<li><p>The application will receive <i>SDLOnButtonEvent</i> notifications for subscribed media buttons when HMILevel is LIMITED.</p></li> +<li><p>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.</p></li> +<li><p>The application will not receive <i>SDLOnButtonEvent</i> notification when HMILevel is BACKGROUND.</p></li> +</ul> + +<p>AudioStreamingState:</p> + +<ul> +<li>Any</li> +</ul> + +<p>SystemContext:</p> +<li><p>MAIN, VR. In MENU, only PRESET buttons.</p></li> +<li><p>In VR, pressing any subscribable button will cancel VR.</p></li> <div class="aside aside-see"> <p class="aside-title">See</p> - SDLSubscribeButton + <p>SDLSubscribeButton</p> </div> @@ -55,7 +49,7 @@ buttonName </h3> - <p>@abstract The name of the button</p> + <p>The name of the button</p> @@ -73,7 +67,7 @@ buttonEventMode </h3> - <p>@abstract Indicates whether this is an UP or DOWN event</p> + <p>Indicates whether this is an UP or DOWN event</p> @@ -92,7 +86,7 @@ customButtonID </h3> - <p>@abstract If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p> + <p>If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p> <p>@since SDL 2.0</p> diff --git a/docs/Classes/SDLOnButtonPress.html b/docs/Classes/SDLOnButtonPress.html index 97c08a049..8b7802436 100644 --- a/docs/Classes/SDLOnButtonPress.html +++ b/docs/Classes/SDLOnButtonPress.html @@ -10,51 +10,25 @@ <h3>Overview</h3> -<p>Notifies application of button press events for buttons to which the - application is subscribed. SDL supports two button press events defined as - follows:</p> - -<p><ul> - <li>SHORT - Occurs when a button is depressed, then released within two - seconds. The event is considered to occur immediately after the button is - released.</li> - <li>LONG - Occurs when a button is depressed and held for two seconds or - more. The event is considered to occur immediately after the two second - threshold has been crossed, before the button is released</li> - </ul> - <b>HMI Status Requirements:</b> - <ul> - HMILevel: - <ul> - <li>The application will receive OnButtonPress notifications for all - subscribed buttons when HMILevel is FULL.</li> - <li>The application will receive OnButtonPress notifications for subscribed - media buttons when HMILevel is LIMITED.</li> - <li>Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and - PRESET_0-PRESET_9.</li> - <li>The application will not receive OnButtonPress notification when HMILevel - is BACKGROUND or NONE.</li> - </ul> - AudioStreamingState: - <ul> - <li> Any </li> - </ul> - SystemContext: - <ul> - <li>MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable - button will cancel VR.</li> - </ul> - </ul></p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLSubscribeButton - -</div> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLUnsubscribeButton - -</div> +<p>Notifies application of button press events for buttons to which the application is subscribed. SDL supports two button press events defined as follows:</p> + +<p>SHORT - Occurs when a button is depressed, then released within two seconds. The event is considered to occur immediately after the button is released.</p> + +<p>LONG - Occurs when a button is depressed and held for two seconds or more. The event is considered to occur immediately after the two second threshold has been crossed, before the button is released.</p> + +<p>HMI Status Requirements:</p> + +<p>HMILevel:</p> + +<p>The application will receive OnButtonPress notifications for all subscribed buttons when HMILevel is FULL.</p> + +<p>The application will receive OnButtonPress notifications for subscribed media buttons when HMILevel is LIMITED. Media buttons include SEEKLEFT, SEEKRIGHT, TUNEUP, TUNEDOWN, and PRESET_0-PRESET_9.</p> + +<p>The application will not receive OnButtonPress notification when HMILevel is BACKGROUND or NONE.</p> + +<p>AudioStreamingState: Any</p> + +<p>SystemContext: MAIN, VR. In MENU, only PRESET buttons. In VR, pressing any subscribable button will cancel VR.</p> <p>@since SDL 1.0</p> @@ -64,12 +38,7 @@ buttonName </h3> - <p>@abstract the button’s name</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLButtonName - -</div> + <p>The button’s name</p> <p>Required</p> @@ -89,12 +58,7 @@ buttonPressMode </h3> - <p>@abstract Indicates whether this is a LONG or SHORT button press event</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLButtonPressMode - -</div> + <p>Indicates whether this is a LONG or SHORT button press event</p> <p>Required</p> @@ -115,7 +79,7 @@ customButtonID </h3> - <p>@abstract If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p> + <p>If ButtonName is <q>CUSTOM_BUTTON</q>, this references the integer ID passed by a custom button. (e.g. softButton ID)</p> <p>@since SDL 2.0</p> diff --git a/docs/Classes/SDLOnCommand.html b/docs/Classes/SDLOnCommand.html index 007174052..65e865153 100644 --- a/docs/Classes/SDLOnCommand.html +++ b/docs/Classes/SDLOnCommand.html @@ -9,10 +9,9 @@ <h3>Overview</h3> -<p>This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after - pressing the MENU button.</p> +<p>This is called when a command was selected via VR after pressing the PTT button, or selected from the menu after pressing the MENU button.</p> -<p><b>Note:</b> The sequence of <em>SDLOnHMIStatus</em> and <em>SDLOnCommand</em> notifications for user-initiated interactions is indeterminate.</p> +<p>Note: The sequence of <em>SDLOnHMIStatus</em> and <em>SDLOnCommand</em> notifications for user-initiated interactions is indeterminate.</p> <p>@since SDL 1.0</p> <div class="aside aside-see"> @@ -27,7 +26,7 @@ cmdID </h3> - <p>@abstract The command ID of the command the user selected. This is the command ID value provided by the application in the <i>SDLAddCommand</i> operation that created the command.</p> + <p>The command ID of the command the user selected. This is the command ID value provided by the application in the SDLAddCommand operation that created the command.</p> @@ -45,7 +44,7 @@ triggerSource </h3> - <p>@abstract Indicates whether command was selected via voice or via a menu selection (using the OK button).</p> + <p>Indicates whether command was selected via voice or via a menu selection (using the OK button).</p> diff --git a/docs/Classes/SDLOnDriverDistraction.html b/docs/Classes/SDLOnDriverDistraction.html index 54eab4e5c..451bfa197 100644 --- a/docs/Classes/SDLOnDriverDistraction.html +++ b/docs/Classes/SDLOnDriverDistraction.html @@ -8,19 +8,15 @@ <h3>Overview</h3> -<p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or - not).</p> +<p>Notifies the application of the current driver distraction state (whether driver distraction rules are in effect, or not).</p> <p>HMI Status Requirements:</p> -<p><ul> - HMILevel: - <ul><li>Can be sent with FULL, LIMITED or BACKGROUND</li></ul> - AudioStreamingState: - <ul><li>Any</li></ul> - SystemContext: - <ul><li>Any</li></ul> - </ul></p> +<p>HMILevel: Can be sent with FULL, LIMITED or BACKGROUND</p> + +<p>AudioStreamingState: Any</p> + +<p>SystemContext: Any</p> <p>@since SDL 1.0</p> @@ -30,7 +26,7 @@ state </h3> - <p>@abstract The driver distraction state (i.e. whether driver distraction rules are in effect, or not)</p> + <p>The driver distraction state (i.e. whether driver distraction rules are in effect, or not)</p> diff --git a/docs/Classes/SDLOnEncodedSyncPData.html b/docs/Classes/SDLOnEncodedSyncPData.html index 4b0de6f1f..a717bc878 100644 --- a/docs/Classes/SDLOnEncodedSyncPData.html +++ b/docs/Classes/SDLOnEncodedSyncPData.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Callback including encoded data of any SyncP packets that SYNC needs to send back to the mobile device. Legacy / v1 Protocol implementation; responds to EncodedSyncPData. *** DEPRECATED ***</p> <section class="section task-group-section"> @@ -18,12 +18,12 @@ data </h3> - <p>Undocumented</p> + <p>Contains base64 encoded string of SyncP packets.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">data</span></code></pre> + <pre class="highlight objective_c"><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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">data</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +36,12 @@ URL </h3> - <p>Undocumented</p> + <p>If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded to the provided URL.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">URL</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">URL</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +54,12 @@ Timeout </h3> - <p>Undocumented</p> + <p>If blank, the SyncP data shall be forwarded to the app. If not blank, the SyncP data shall be forwarded with the provided timeout in seconds.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">Timeout</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">Timeout</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnHMIStatus.html b/docs/Classes/SDLOnHMIStatus.html index 6ed0fd81d..e6a4b2a4d 100644 --- a/docs/Classes/SDLOnHMIStatus.html +++ b/docs/Classes/SDLOnHMIStatus.html @@ -10,17 +10,14 @@ <h3>Overview</h3> -<p>Notifies an application that HMI conditions have changed for the application. This indicates whether the application - can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This - notification will be sent to the application when there has been a change in any one or several of the indicated - states (<i>SDLHMILevel</i>, <i>SDLAudioStreamingState</i> or <i>SDLSystemContext</i>) for the application.</p> -<p>All three values are, in principle, independent of each other (though there may be some relationships). A value for - one parameter should not be interpreted from the value of another parameter.</p> +<ul> +<li>Notifies an application that HMI conditions have changed for the application. This indicates whether the application can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This notification will be sent to the application when there has been a change in any one or several of the indicated states (<i>SDLHMILevel</i>, <i>SDLAudioStreamingState</i> or <i>SDLSystemContext</i>) for the application.</li> +</ul> + +<p>All three values are, in principle, independent of each other (though there may be some relationships). A value for one parameter should not be interpreted from the value of another parameter.</p> -<p>There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, - information such as <i>SDLAudioStreamingState</i> may not indicate that the audio stream became inaudible to the user - exactly when the SDLOnHMIStatus notification was received.</p> +<p>There are no guarantees about the timeliness or latency of the SDLOnHMIStatus notification. Therefore, for example, information such as <i>SDLAudioStreamingState</i> may not indicate that the audio stream became inaudible to the user exactly when the SDLOnHMIStatus notification was received.</p> <p>@since SDL 1.0</p> @@ -30,7 +27,7 @@ hmiLevel </h3> - <p>@abstract SDLHMILevel in effect for the application</p> + <p>SDLHMILevel in effect for the application</p> @@ -48,7 +45,7 @@ audioStreamingState </h3> - <p>@abstract Current state of audio streaming for the application. When this parameter has a value of NOT_AUDIBLE, the application must stop streaming audio to SDL.</p> + <p>Current state of audio streaming for the application. When this parameter has a value of NOT_AUDIBLE, the application must stop streaming audio to SDL.</p> <p>Informs app whether any currently streaming audio is audible to user (AUDIBLE) or not (NOT_AUDIBLE). A value of NOT_AUDIBLE means that either the application’s audio will not be audible to the user, or that the application’s audio should not be audible to the user (i.e. some other application on the mobile device may be streaming audio and the application’s audio would be blended with that other audio).</p> @@ -69,8 +66,7 @@ systemContext </h3> - <p>@abstract the System Context -@discussion whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN)</p> + <p>Whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN)</p> diff --git a/docs/Classes/SDLOnHashChange.html b/docs/Classes/SDLOnHashChange.html index 592da15f6..27afe1c15 100644 --- a/docs/Classes/SDLOnHashChange.html +++ b/docs/Classes/SDLOnHashChange.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Notification containing an updated hashID which can be used over connection cycles (i.e. loss of connection, ignition cycles, etc.). Sent after initial registration and subsequently after any change in the calculated hash of all persisted app data.</p> <section class="section task-group-section"> @@ -16,12 +16,12 @@ hashID </h3> - <p>Undocumented</p> + <p>Calculated hash ID to be referenced during RegisterAppInterface request.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">hashID</span></code></pre> + <pre class="highlight objective_c"><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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">hashID</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnInteriorVehicleData.html b/docs/Classes/SDLOnInteriorVehicleData.html index 9b6b3d0cd..5158615d6 100644 --- a/docs/Classes/SDLOnInteriorVehicleData.html +++ b/docs/Classes/SDLOnInteriorVehicleData.html @@ -8,7 +8,9 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Notifications when subscribed vehicle data changes.</p> + +<p>See: SDLSubscribeVehicleData</p> <section class="section task-group-section"> @@ -16,12 +18,12 @@ moduleData </h3> - <p>Undocumented</p> + <p>The subscribed module data that changed</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">moduleData</span></code></pre> + <pre class="highlight objective_c"><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/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleData</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnKeyboardInput.html b/docs/Classes/SDLOnKeyboardInput.html index 457e0ba74..14c8c6092 100644 --- a/docs/Classes/SDLOnKeyboardInput.html +++ b/docs/Classes/SDLOnKeyboardInput.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Sent when a keyboard presented by a PerformInteraction has a keyboard input.</p> <section class="section task-group-section"> @@ -17,12 +17,12 @@ event </h3> - <p>Undocumented</p> + <p>The type of keyboard input</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span> <span class="n">event</span></code></pre> + <pre class="highlight objective_c"><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:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span> <span class="n">_Nonnull</span> <span class="n">event</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +35,12 @@ data </h3> - <p>Undocumented</p> + <p>The current keyboard string input from the user</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">data</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnLanguageChange.html b/docs/Classes/SDLOnLanguageChange.html index 349333b94..e0d6d0f88 100644 --- a/docs/Classes/SDLOnLanguageChange.html +++ b/docs/Classes/SDLOnLanguageChange.html @@ -19,7 +19,7 @@ language </h3> - <p>@abstract Current SDL voice engine (VR+TTS) language</p> + <p>Current SDL voice engine (VR+TTS) language</p> @@ -37,7 +37,7 @@ hmiDisplayLanguage </h3> - <p>@abstract Current display language</p> + <p>Current display language</p> diff --git a/docs/Classes/SDLOnLockScreenStatus.html b/docs/Classes/SDLOnLockScreenStatus.html index adb8ce1de..4ab565431 100644 --- a/docs/Classes/SDLOnLockScreenStatus.html +++ b/docs/Classes/SDLOnLockScreenStatus.html @@ -11,13 +11,15 @@ <h3>Overview</h3> -<pre class="highlight objective_c"><code><span class="n">To</span> <span class="n">help</span> <span class="n">prevent</span> <span class="n">driver</span> <span class="n">distraction</span><span class="p">,</span> <span class="n">any</span> <span class="n">SmartDeviceLink</span> <span class="n">application</span> <span class="n">is</span> <span class="n">required</span> <span class="n">to</span> <span class="n">implement</span> <span class="n">a</span> <span class="n">lockscreen</span> <span class="n">that</span> <span class="n">must</span> <span class="n">be</span> <span class="n">enforced</span> <span class="k">while</span> <span class="n">the</span> <span class="n">application</span> <span class="n">is</span> <span class="n">active</span> <span class="n">on</span> <span class="n">the</span> <span class="n">system</span> <span class="k">while</span> <span class="n">the</span> <span class="n">vehicle</span> <span class="n">is</span> <span class="k">in</span> <span class="n">motion</span><span class="p">.</span> +<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> -<span class="n">This</span> <span class="n">lockscreen</span> <span class="n">must</span> <span class="n">perform</span> <span class="n">the</span> <span class="n">following</span><span class="o">:</span> -<span class="n">Limit</span> <span class="n">all</span> <span class="n">application</span> <span class="n">control</span> <span class="n">usability</span> <span class="n">from</span> <span class="n">the</span> <span class="n">mobile</span> <span class="n">device</span> <span class="n">with</span> <span class="n">a</span> <span class="n">full</span><span class="o">-</span><span class="n">screen</span> <span class="k">static</span> <span class="n">image</span> <span class="n">overlay</span> <span class="n">or</span> <span class="n">separate</span> <span class="n">view</span><span class="p">.</span> -<span class="n">For</span> <span class="n">simplicity</span><span class="p">,</span> <span class="n">the</span> <span class="n">OnLockScreenStatus</span> <span class="n">RPC</span> <span class="n">will</span> <span class="n">be</span> <span class="n">provided</span> <span class="n">via</span> <span class="n">the</span> <span class="n">onOnLockScreenNotification</span> <span class="n">call</span> <span class="n">back</span><span class="p">.</span> <span class="n">The</span> <span class="n">call</span> <span class="n">back</span> <span class="n">will</span> <span class="n">include</span> <span class="n">the</span> <span class="n">LockScreenStatus</span> <span class="k">enum</span> <span class="n">which</span> <span class="n">indicates</span> <span class="k">if</span> <span class="n">the</span> <span class="n">lockscreen</span> <span class="n">is</span> <span class="n">required</span><span class="p">,</span> <span class="n">optional</span> <span class="n">or</span> <span class="n">not</span> <span class="n">required</span><span class="p">.</span> -<span class="n">The</span> <span class="n">call</span> <span class="n">back</span> <span class="n">also</span> <span class="n">includes</span> <span class="n">details</span> <span class="n">regarding</span> <span class="n">the</span> <span class="n">current</span> <span class="n">HMI_Status</span> <span class="n">level</span><span class="p">,</span> <span class="n">driver</span> <span class="n">distraction</span> <span class="n">status</span> <span class="n">and</span> <span class="n">user</span> <span class="n">selection</span> <span class="n">status</span> <span class="n">of</span> <span class="n">the</span> <span class="n">application</span><span class="p">.</span> -</code></pre> +<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"> @@ -39,10 +41,6 @@ - <div> - <h4>Return Value</h4> - <p>String</p> - </div> <h3 id="section-userSelected"> userSelected @@ -62,16 +60,12 @@ - <div> - <h4>Return Value</h4> - <p>Boolean the current user selection status</p> - </div> <h3 id="section-lockScreenStatus"> lockScreenStatus </h3> - <p>Get the {@linkplain LockScreenStatus} enumeration, indicating if the lockscreen should be required, optional or off </p> + <p>Indicates if the lockscreen should be required, optional or off</p> @@ -85,10 +79,6 @@ - <div> - <h4>Return Value</h4> - <p>{@linkplain LockScreenStatus}</p> - </div> <h3 id="section-hmiLevel"> hmiLevel @@ -107,9 +97,5 @@ - <div> - <h4>Return Value</h4> - <p>{@linkplain HMILevel} the current HMI Level in effect for the application</p> - </div> </section> diff --git a/docs/Classes/SDLOnPermissionsChange.html b/docs/Classes/SDLOnPermissionsChange.html index 1f0ac4b9d..317e0ef92 100644 --- a/docs/Classes/SDLOnPermissionsChange.html +++ b/docs/Classes/SDLOnPermissionsChange.html @@ -18,14 +18,9 @@ permissionItem </h3> - <p>@abstract Describes change in permissions for a given set of RPCs</p> + <p>Describes change in permissions for a given set of RPCs</p> <p>Required, Array of SDLPermissionItem, Array size 0 - 500</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLPermissionItem - -</div> diff --git a/docs/Classes/SDLOnSyncPData.html b/docs/Classes/SDLOnSyncPData.html index 34450aaf9..d0501aaa0 100644 --- a/docs/Classes/SDLOnSyncPData.html +++ b/docs/Classes/SDLOnSyncPData.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>DEPRECATED</p> <section class="section task-group-section"> diff --git a/docs/Classes/SDLOnSystemRequest.html b/docs/Classes/SDLOnSystemRequest.html index f75a99c9f..89f80c289 100644 --- a/docs/Classes/SDLOnSystemRequest.html +++ b/docs/Classes/SDLOnSystemRequest.html @@ -13,7 +13,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>An asynchronous request from the system for specific data from the device or the cloud or response to a request from the device or cloud Binary data can be included in hybrid part of message for some requests (such as Authentication request responses)</p> <section class="section task-group-section"> @@ -21,12 +21,12 @@ requestType </h3> - <p>Undocumented</p> + <p>The type of system request.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">requestType</span></code></pre> + <pre class="highlight objective_c"><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:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">_Nonnull</span> <span class="n">requestType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -39,12 +39,12 @@ url </h3> - <p>Undocumented</p> + <p>Optional URL for HTTP requests. If blank, the binary data shall be forwarded to the app. If not blank, the binary data shall be forwarded to the url with a provided timeout in seconds.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">url</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">url</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -57,12 +57,12 @@ timeout </h3> - <p>Undocumented</p> + <p>Optional timeout for HTTP requests Required if a URL is provided</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -75,12 +75,12 @@ fileType </h3> - <p>Undocumented</p> + <p>Optional file type (meant for HTTP file requests).</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">fileType</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">fileType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -93,12 +93,12 @@ offset </h3> - <p>Undocumented</p> + <p>Optional offset in bytes for resuming partial data chunks</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">offset</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">offset</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -111,12 +111,12 @@ length </h3> - <p>Undocumented</p> + <p>Optional length in bytes for resuming partial data chunks</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">length</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">length</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnTBTClientState.html b/docs/Classes/SDLOnTBTClientState.html index e32c43487..06d81f092 100644 --- a/docs/Classes/SDLOnTBTClientState.html +++ b/docs/Classes/SDLOnTBTClientState.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Provides applications with notifications specific to the current TBT client status on the module</p> <section class="section task-group-section"> @@ -16,12 +16,12 @@ state </h3> - <p>Undocumented</p> + <p>Current State of TBT client</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">state</span></code></pre> + <pre class="highlight objective_c"><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:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">_Nonnull</span> <span class="n">state</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnTouchEvent.html b/docs/Classes/SDLOnTouchEvent.html index f8b8f10b5..ad977b41b 100644 --- a/docs/Classes/SDLOnTouchEvent.html +++ b/docs/Classes/SDLOnTouchEvent.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Notifies about touch events on the screen’s prescribed area during video streaming</p> <section class="section task-group-section"> @@ -17,12 +17,12 @@ type </h3> - <p>Undocumented</p> + <p>The type of touch event.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">type</span></code></pre> + <pre class="highlight objective_c"><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:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">_Nonnull</span> <span class="n">type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +35,13 @@ event </h3> - <p>Undocumented</p> + <p>List of all individual touches involved in this event.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLTouchEvent.html">SDLTouchEvent</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">event</span></code></pre> + <pre class="highlight objective_c"><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/SDLTouchEvent.html">SDLTouchEvent</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">event</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnVehicleData.html b/docs/Classes/SDLOnVehicleData.html index ce402b6c2..bcae01a0f 100644 --- a/docs/Classes/SDLOnVehicleData.html +++ b/docs/Classes/SDLOnVehicleData.html @@ -32,7 +32,7 @@ <h3>Overview</h3> -<p>Request vehicle data.</p> +<p>Callback for the periodic and non periodic vehicle data read function.</p> <p>Since SmartDeviceLink 2.0</p> @@ -42,7 +42,7 @@ gps </h3> - <p>@abstract A SDLGPSData* value. See GPSData.</p> + <p>The car current GPS coordinates</p> @@ -60,7 +60,7 @@ speed </h3> - <p>@abstract The vehicle speed in kilometers per hour.</p> + <p>The vehicle speed in kilometers per hour</p> @@ -78,7 +78,7 @@ rpm </h3> - <p>@abstract The number of revolutions per minute of the engine.</p> + <p>The number of revolutions per minute of the engine.</p> @@ -96,7 +96,7 @@ fuelLevel </h3> - <p>@abstract The fuel level in the tank (percentage)</p> + <p>The fuel level in the tank (percentage)</p> @@ -114,7 +114,7 @@ fuelLevel_State </h3> - <p>@abstract A SDLComponentVolumeStatus* value. The fuel level state.</p> + <p>The fuel level state</p> @@ -133,7 +133,7 @@ instantFuelConsumption </h3> - <p>@abstract The instantaneous fuel consumption in microlitres.</p> + <p>The instantaneous fuel consumption in microlitres</p> @@ -152,7 +152,7 @@ externalTemperature </h3> - <p>@abstract The external temperature in degrees celsius.</p> + <p>The external temperature in degrees celsius.</p> @@ -171,7 +171,7 @@ vin </h3> - <p>@abstract The Vehicle Identification Number</p> + <p>The Vehicle Identification Number</p> @@ -189,7 +189,7 @@ prndl </h3> - <p>@abstract See PRNDL.</p> + <p>The current gear shift state of the user’s vehicle</p> @@ -207,7 +207,7 @@ tirePressure </h3> - <p>@abstract A SDLTireStatus* value. See TireStatus.</p> + <p>The current pressure warnings for the user’s vehicle</p> @@ -225,7 +225,7 @@ odometer </h3> - <p>@abstract Odometer reading in km.</p> + <p>Odometer reading in km</p> @@ -243,7 +243,7 @@ beltStatus </h3> - <p>@abstract A SDLBeltStatus* value. The status of the seat belts.</p> + <p>The status of the seat belts</p> @@ -261,7 +261,7 @@ bodyInformation </h3> - <p>@abstract A SDLBodyInformation* value. The body information including power modes.</p> + <p>The body information including power modes</p> @@ -280,7 +280,7 @@ deviceStatus </h3> - <p>@abstract A SDLDeviceStatus* value. The device status including signal and battery strength.</p> + <p>The IVI system status including signal and battery strength</p> @@ -298,7 +298,7 @@ driverBraking </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p> + <p>The status of the brake pedal</p> @@ -317,7 +317,7 @@ wiperStatus </h3> - <p>@abstract A SDLWiperStatus* value. The status of the wipers.</p> + <p>The status of the wipers</p> @@ -335,7 +335,7 @@ headLampStatus </h3> - <p>@abstract A SDLHeadLampStatus* value. Status of the head lamps.</p> + <p>Status of the head lamps</p> @@ -354,7 +354,7 @@ engineTorque </h3> - <p>@abstract Torque value for engine (in Nm) on non-diesel variants.</p> + <p>Torque value for engine (in Nm) on non-diesel variants</p> @@ -373,7 +373,7 @@ accPedalPosition </h3> - <p>@abstract Accelerator pedal position (percentage depressed)</p> + <p>Accelerator pedal position (percentage depressed)</p> @@ -392,7 +392,7 @@ steeringWheelAngle </h3> - <p>@abstract Current angle of the steering wheel (in deg)</p> + <p>Current angle of the steering wheel (in deg)</p> @@ -411,12 +411,12 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>Emergency Call notification and confirmation data</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLECallInfo.html">SDLECallInfo</a></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLECallInfo.html">SDLECallInfo</a></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -429,12 +429,12 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>The status of the air bags</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLAirbagStatus.html">SDLAirbagStatus</a></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAirbagStatus.html">SDLAirbagStatus</a></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -447,12 +447,13 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>Information related to an emergency event (and if it occurred)</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLEmergencyEvent.html">SDLEmergencyEvent</a></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLEmergencyEvent.html">SDLEmergencyEvent</a></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -465,12 +466,13 @@ clusterModeStatus </h3> - <p>Undocumented</p> + <p>The status modes of the cluster</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLClusterModeStatus.html">SDLClusterModeStatus</a></span> <span class="o">*</span><span class="n">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLClusterModeStatus.html">SDLClusterModeStatus</a></span> <span class="o">*</span><span class="n">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -483,12 +485,12 @@ myKey </h3> - <p>Undocumented</p> + <p>Information related to the MyKey feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLMyKey.html">SDLMyKey</a></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMyKey.html">SDLMyKey</a></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLOnWaypointChange.html b/docs/Classes/SDLOnWaypointChange.html index b7bed60b3..f2fc86610 100644 --- a/docs/Classes/SDLOnWaypointChange.html +++ b/docs/Classes/SDLOnWaypointChange.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Notification which provides the entire LocationDetails when there is a change to any waypoints or destination.</p> <section class="section task-group-section"> @@ -16,7 +16,7 @@ waypoints </h3> - <p>@abstract Location address for display purposes only.</p> + <p>Location address for display purposes only</p> <p>Required, Array of Strings, Array size 1 - 10</p> diff --git a/docs/Classes/SDLParameterPermissions.html b/docs/Classes/SDLParameterPermissions.html index c13d74d7c..70fa7934e 100644 --- a/docs/Classes/SDLParameterPermissions.html +++ b/docs/Classes/SDLParameterPermissions.html @@ -19,7 +19,7 @@ allowed </h3> - <p>@abstract A set of all parameters that are permitted for this given RPC.</p> + <p>A set of all parameters that are permitted for this given RPC.</p> <p>Required, Array of String, max String length = 100, Array size 0 - 100</p> @@ -39,7 +39,7 @@ userDisallowed </h3> - <p>@abstract A set of all parameters that are prohibited for this given RPC.</p> + <p>A set of all parameters that are prohibited for this given RPC.</p> <p>Required, Array of String, max String length = 100, Array size 0 - 100</p> diff --git a/docs/Classes/SDLPerformAudioPassThru.html b/docs/Classes/SDLPerformAudioPassThru.html index 94a6e338b..f3c98c5d0 100644 --- a/docs/Classes/SDLPerformAudioPassThru.html +++ b/docs/Classes/SDLPerformAudioPassThru.html @@ -109,7 +109,7 @@ initialPrompt </h3> - <p>@abstract initial prompt which will be spoken before opening the audio pass + <p>initial prompt which will be spoken before opening the audio pass thru session by SDL @discussion initialPrompt a Vector<TTSChunk> value represents the initial prompt which @@ -142,7 +142,7 @@ thru session by SDL audioPassThruDisplayText1 </h3> - <p>@abstract a line of text displayed during audio capture + <p>a line of text displayed during audio capture @discussion audioPassThruDisplayText1 a String value representing the line of text displayed during audio capture @@ -166,7 +166,7 @@ thru session by SDL audioPassThruDisplayText2 </h3> - <p>@abstract A line of text displayed during audio capture + <p>A line of text displayed during audio capture @discussion audioPassThruDisplayText2 a String value representing the line of text displayed during audio capture @@ -190,7 +190,7 @@ thru session by SDL samplingRate </h3> - <p>@abstract A samplingRate</p> + <p>A samplingRate</p> <p>@discussion a SamplingRate value representing a 8 or 16 or 22 or 24 khz</p> @@ -210,7 +210,7 @@ thru session by SDL maxDuration </h3> - <p>@abstract the maximum duration of audio recording in milliseconds</p> + <p>the maximum duration of audio recording in milliseconds</p> <p>@discussion maxDuration an Integer value representing the maximum duration of audio @@ -234,7 +234,7 @@ thru session by SDL bitsPerSample </h3> - <p>@abstract the quality the audio is recorded - 8 bit or 16 bit</p> + <p>the quality the audio is recorded - 8 bit or 16 bit</p> <p>@discussion a BitsPerSample value representing 8 bit or 16 bit</p> @@ -254,7 +254,7 @@ thru session by SDL audioType </h3> - <p>@abstract an audioType</p> + <p>an audioType</p> @@ -272,7 +272,7 @@ thru session by SDL muteAudio </h3> - <p>@abstract a Boolean value representing if the current audio source should be + <p>a Boolean value representing if the current audio source should be muted during the APT session<br/></p> diff --git a/docs/Classes/SDLPerformInteraction.html b/docs/Classes/SDLPerformInteraction.html index 1b019dbcc..92450c4f6 100644 --- a/docs/Classes/SDLPerformInteraction.html +++ b/docs/Classes/SDLPerformInteraction.html @@ -188,7 +188,7 @@ initialText </h3> - <p>@abstract The Text that Displayed when the interaction begins. This text may + <p>The Text that Displayed when the interaction begins. This text may be overlaid by the <q>Listening</q> prompt during the interaction. Text is displayed on first line of multiline display, and is centered. If text does not fit on line, it will be truncated</p> @@ -209,7 +209,7 @@ does not fit on line, it will be truncated</p> initialPrompt </h3> - <p>@abstract An array of one or more TTSChunks that, taken together, specify + <p>An array of one or more TTSChunks that, taken together, specify what is to be spoken to the user at the start of an interaction</p> @@ -229,7 +229,7 @@ what is to be spoken to the user at the start of an interaction</p> interactionMode </h3> - <p>@abstract The Indicates mode that indicate how user selects interaction + <p>The Indicates mode that indicate how user selects interaction choice. User can choose either by voice (VR_ONLY), by visual selection from the menu (MANUAL_ONLY), or by either mode (BOTH)</p> @@ -250,7 +250,7 @@ from the menu (MANUAL_ONLY), or by either mode (BOTH)</p> interactionChoiceSetIDList </h3> - <p>@abstract A Vector<Integer> value representing an Array of one or more Choice + <p>A Vector<Integer> value representing an Array of one or more Choice Set IDs</p> @@ -270,7 +270,7 @@ Set IDs</p> helpPrompt </h3> - <p>@abstract A Vector<TTSChunk> which taken together, specify the help phrase to + <p>A Vector<TTSChunk> which taken together, specify the help phrase to be spoken when the user says <q>help</q> during the VR session</p> @@ -290,7 +290,7 @@ be spoken when the user says <q>help</q> during the VR session</p> timeoutPrompt </h3> - <p>@abstract An array of TTSChunks which, taken together, specify the phrase to + <p>An array of TTSChunks which, taken together, specify the phrase to be spoken when the listen times out during the VR session</p> @@ -310,7 +310,7 @@ be spoken when the listen times out during the VR session</p> timeout </h3> - <p>@abstract An Integer value representing the amount of time, in milliseconds, + <p>An Integer value representing the amount of time, in milliseconds, SDL will wait for the user to make a choice (VR or Menu)</p> @@ -329,7 +329,7 @@ SDL will wait for the user to make a choice (VR or Menu)</p> vrHelp </h3> - <p>@abstract A Voice recognition Help, which is a suggested VR Help Items to + <p>A Voice recognition Help, which is a suggested VR Help Items to display on-screen during Perform Interaction @since SmartDeviceLink 2.0</p> diff --git a/docs/Classes/SDLPerformInteractionResponse.html b/docs/Classes/SDLPerformInteractionResponse.html index 210da1c16..5dde4fa14 100644 --- a/docs/Classes/SDLPerformInteractionResponse.html +++ b/docs/Classes/SDLPerformInteractionResponse.html @@ -20,9 +20,7 @@ choiceID </h3> - <p>@abstract ID of the choice that was selected in response to PerformInteraction. </p> - -<p>@discussion Only is valid if general result is <q>success:true</q>.</p> + <p>ID of the choice that was selected in response to PerformInteraction. Only is valid if general result is <q>success:true</q>.</p> <p>Optional, Integer, 0 - 2,000,000,000</p> @@ -42,9 +40,7 @@ manualTextEntry </h3> - <p>@abstract Manually entered text selection, e.g. through keyboard</p> - -<p>@discussion Can be returned in lieu of choiceID, depending on trigger source</p> + <p>Manually entered text selection, e.g. through keyboard. Can be returned in lieu of choiceID, depending on the trigger source.</p> <p>Optional, Max length 500 chars</p> @@ -64,9 +60,7 @@ triggerSource </h3> - <p>@abstract A <em>SDLTriggerSource</em> object which will be shown in the HMI</p> - -<p>@discussion Only is valid if resultCode is SUCCESS.</p> + <p>A <em>SDLTriggerSource</em> object which will be shown in the HMI. Only is valid if resultCode is SUCCESS.</p> diff --git a/docs/Classes/SDLPermissionItem.html b/docs/Classes/SDLPermissionItem.html index 7aa8781c2..e51271058 100644 --- a/docs/Classes/SDLPermissionItem.html +++ b/docs/Classes/SDLPermissionItem.html @@ -18,12 +18,14 @@ rpcName </h3> - <p>Undocumented</p> + <p>Name of the individual RPC in the policy table.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">rpcName</span></code></pre> + <pre class="highlight objective_c"><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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rpcName</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +38,15 @@ hmiPermissions </h3> - <p>Undocumented</p> + <p>HMI Permissions for the individual RPC; i.e. which HMI levels may it be used in</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLHMIPermissions.html">SDLHMIPermissions</a></span> <span class="o">*</span><span class="n">hmiPermissions</span></code></pre> + <pre class="highlight objective_c"><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/SDLHMIPermissions.html">SDLHMIPermissions</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">hmiPermissions</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +59,15 @@ parameterPermissions </h3> - <p>Undocumented</p> + <p>RPC parameters for the individual RPC</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLParameterPermissions.html">SDLParameterPermissions</a></span> <span class="o">*</span><span class="n">parameterPermissions</span></code></pre> + <pre class="highlight objective_c"><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/SDLParameterPermissions.html">SDLParameterPermissions</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">parameterPermissions</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLPhoneCapability.html b/docs/Classes/SDLPhoneCapability.html index ddb043272..4ae442346 100644 --- a/docs/Classes/SDLPhoneCapability.html +++ b/docs/Classes/SDLPhoneCapability.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Extended capabilities of the module’s phone feature</p> <section class="section task-group-section"> @@ -35,8 +35,9 @@ dialNumberEnabled </h3> - <p>Whether or not the DialNumber RPC is enabled. -Boolean, optional</p> + <p>Whether or not the DialNumber RPC is enabled.</p> + +<p>Boolean, optional</p> diff --git a/docs/Classes/SDLPresetBankCapabilities.html b/docs/Classes/SDLPresetBankCapabilities.html index 3e8269770..79d0a594b 100644 --- a/docs/Classes/SDLPresetBankCapabilities.html +++ b/docs/Classes/SDLPresetBankCapabilities.html @@ -18,7 +18,7 @@ onScreenPresetsAvailable </h3> - <p>@abstract If Onscreen custom presets are available.</p> + <p>If Onscreen custom presets are available.</p> <p>Required, Boolean</p> diff --git a/docs/Classes/SDLProtocol.html b/docs/Classes/SDLProtocol.html deleted file mode 100644 index 025a45878..000000000 --- a/docs/Classes/SDLProtocol.html +++ /dev/null @@ -1,166 +0,0 @@ -<h1>SDLProtocol Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section--startServiceWithType:payload:">-startServiceWithType:payload:</a></li> - <li><a href="#section--startSecureServiceWithType:payload:completionHandler:">-startSecureServiceWithType:payload:completionHandler:</a></li> - <li><a href="#section--endServiceWithType:">-endServiceWithType:</a></li> - <li><a href="#section--sendRPC:">-sendRPC:</a></li> - <li><a href="#section--sendRPC:encrypted:error:">-sendRPC:encrypted:error:</a></li> - <li><a href="#section--sendRawData:withServiceType:">-sendRawData:withServiceType:</a></li> - <li><a href="#section--sendEncryptedRawData:onService:">-sendEncryptedRawData:onService:</a></li> - <li><a href="#section--handleBytesFromTransport:">-handleBytesFromTransport:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section--startServiceWithType:payload:"> - -startServiceWithType:payload: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">startService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">,</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?)</span></code></pre> - - - - - <h3 id="section--startSecureServiceWithType:payload:completionHandler:"> - -startSecureServiceWithType:payload:completionHandler: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startSecureServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">BOOL</span> <span class="n">success</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">error</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">startSecureService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">,</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">Bool</span><span class="p">,</span> <span class="kt">Error</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Void</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--endServiceWithType:"> - -endServiceWithType: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">endServiceWithType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">endService</span><span class="p">(</span><span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:"> - -sendRPC: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:encrypted:error:"> - -sendRPC:encrypted:error: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span> <span class="nf">encrypted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">encryption</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">,</span> <span class="n">encrypted</span> <span class="nv">encryption</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span> <span class="k">throws</span></code></pre> - - - - - <h3 id="section--sendRawData:withServiceType:"> - -sendRawData:withServiceType: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">withServiceType</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRawData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">with</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendEncryptedRawData:onService:"> - -sendEncryptedRawData:onService: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendEncryptedRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">onService</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendEncryptedRawData</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="n">on</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleBytesFromTransport:"> - -handleBytesFromTransport: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleBytesFromTransport</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">handleBytes</span><span class="p">(</span><span class="n">fromTransport</span> <span class="nv">receivedData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLProtocolHeader.html b/docs/Classes/SDLProtocolHeader.html deleted file mode 100644 index a511bc98c..000000000 --- a/docs/Classes/SDLProtocolHeader.html +++ /dev/null @@ -1,312 +0,0 @@ -<h1>SDLProtocolHeader Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-_version">_version</a></li> - <li><a href="#section-_size">_size</a></li> - <li><a href="#section-version">version</a></li> - <li><a href="#section-size">size</a></li> - <li><a href="#section-encrypted">encrypted</a></li> - <li><a href="#section-frameType">frameType</a></li> - <li><a href="#section-serviceType">serviceType</a></li> - <li><a href="#section-frameData">frameData</a></li> - <li><a href="#section-sessionID">sessionID</a></li> - <li><a href="#section-bytesInPayload">bytesInPayload</a></li> - <li><a href="#section--init">-init</a></li> - <li><a href="#section--data">-data</a></li> - <li><a href="#section--parse:">-parse:</a></li> - <li><a href="#section--description">-description</a></li> - <li><a href="#section-+headerForVersion:">+headerForVersion:</a></li> - <li><a href="#section-+determineVersion:">+determineVersion:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-_version"> - _version - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">UInt8</span> <span class="n">_version</span></code></pre> - - - - - - <h3 id="section-_size"> - _size - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">NSUInteger</span> <span class="n">_size</span></code></pre> - - - - - - <h3 id="section-version"> - version - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">version</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">version</span><span class="p">:</span> <span class="nf">UInt8</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-size"> - size - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">size</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">size</span><span class="p">:</span> <span class="nf">UInt</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-encrypted"> - encrypted - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">encrypted</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">encrypted</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-frameType"> - frameType - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLFrameType.html">SDLFrameType</a></span> <span class="n">frameType</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">frameType</span><span class="p">:</span> <span class="nf">SDLFrameType</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-serviceType"> - serviceType - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLServiceType.html">SDLServiceType</a></span> <span class="n">serviceType</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">serviceType</span><span class="p">:</span> <span class="nf">SDLServiceType</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-frameData"> - frameData - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLFrameInfo.html">SDLFrameInfo</a></span> <span class="n">frameData</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">frameData</span><span class="p">:</span> <span class="nf">SDLFrameInfo</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-sessionID"> - sessionID - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">sessionID</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">sessionID</span><span class="p">:</span> <span class="nf">UInt8</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-bytesInPayload"> - bytesInPayload - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt32</span> <span class="n">bytesInPayload</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">bytesInPayload</span><span class="p">:</span> <span class="nf">UInt32</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="nf">init</span><span class="p">()</span></code></pre> - - - - - <h3 id="section--data"> - -data - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="n">data</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">data</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Data</span><span class="p">?</span></code></pre> - - - - - <h3 id="section--parse:"> - -parse: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">parse</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">parse</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--description"> - -description - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">description</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">description</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre> - - - - - <h3 id="section-+headerForVersion:"> - +headerForVersion: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">__kindof</span> <span class="n">SDLProtocolHeader</span> <span class="o">*</span><span class="p">)</span><span class="nf">headerForVersion</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">version</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">forVersion</span> <span class="nv">version</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">)</span></code></pre> - - - - - <h3 id="section-+determineVersion:"> - +determineVersion: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">UInt8</span><span class="p">)</span><span class="nf">determineVersion</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">determineVersion</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="o">-></span> <span class="kt">UInt8</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLProtocolMessage.html b/docs/Classes/SDLProtocolMessage.html deleted file mode 100644 index 2a7aa1b16..000000000 --- a/docs/Classes/SDLProtocolMessage.html +++ /dev/null @@ -1,147 +0,0 @@ -<h1>SDLProtocolMessage Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-header">header</a></li> - <li><a href="#section-payload">payload</a></li> - <li><a href="#section-data">data</a></li> - <li><a href="#section-+messageWithHeader:andPayload:">+messageWithHeader:andPayload:</a></li> - <li><a href="#section--size">-size</a></li> - <li><a href="#section--description">-description</a></li> - <li><a href="#section--rpcDictionary">-rpcDictionary</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-header"> - header - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLProtocolHeader.html">SDLProtocolHeader</a></span> <span class="o">*</span><span class="n">header</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">header</span><span class="p">:</span> <span class="nf">SDLProtocolHeader</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-payload"> - payload - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSData</span> <span class="o">*</span><span class="n">payload</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">payload</span><span class="p">:</span> <span class="nf">Data</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> - - - - - <h3 id="section-data"> - data - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">data</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">data</span><span class="p">:</span> <span class="nf">Data</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-+messageWithHeader:andPayload:"> - +messageWithHeader:andPayload: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">messageWithHeader</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLProtocolHeader.html">SDLProtocolHeader</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">header</span> <span class="nf">andPayload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">header</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLProtocolHeader.html">SDLProtocolHeader</a></span><span class="p">,</span> <span class="n">andPayload</span> <span class="nv">payload</span><span class="p">:</span> <span class="kt">Data</span><span class="p">?)</span></code></pre> - - - - - <h3 id="section--size"> - -size - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="n">size</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">size</span><span class="p">()</span> <span class="o">-></span> <span class="kt">UInt</span></code></pre> - - - - - <h3 id="section--description"> - -description - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">description</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">description</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre> - - - - - <h3 id="section--rpcDictionary"> - -rpcDictionary - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">rpcDictionary</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">rpcDictionary</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLProxy.html b/docs/Classes/SDLProxy.html deleted file mode 100644 index 925fbdf3d..000000000 --- a/docs/Classes/SDLProxy.html +++ /dev/null @@ -1,342 +0,0 @@ -<h1>SDLProxy Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-_version">_version</a></li> - <li><a href="#section-_bulkSessionID">_bulkSessionID</a></li> - <li><a href="#section-_isConnected">_isConnected</a></li> - <li><a href="#section-protocol">protocol</a></li> - <li><a href="#section-transport">transport</a></li> - <li><a href="#section-proxyListeners">proxyListeners</a></li> - <li><a href="#section-startSessionTimer">startSessionTimer</a></li> - <li><a href="#section-debugConsoleGroupName">debugConsoleGroupName</a></li> - <li><a href="#section-proxyVersion">proxyVersion</a></li> - <li><a href="#section--initWithTransport:protocol:delegate:">-initWithTransport:protocol:delegate:</a></li> - <li><a href="#section--addDelegate:">-addDelegate:</a></li> - <li><a href="#section--removeDelegate:">-removeDelegate:</a></li> - <li><a href="#section--sendRPC:">-sendRPC:</a></li> - <li><a href="#section--handleRPCDictionary:">-handleRPCDictionary:</a></li> - <li><a href="#section--handleProtocolMessage:">-handleProtocolMessage:</a></li> - <li><a href="#section--addSecurityManagers:forAppId:">-addSecurityManagers:forAppId:</a></li> - <li><a href="#section--putFileStream:withRequest:">-putFileStream:withRequest:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-_version"> - _version - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">Byte</span> <span class="n">_version</span></code></pre> - - - - - - <h3 id="section-_bulkSessionID"> - _bulkSessionID - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">Byte</span> <span class="n">_bulkSessionID</span></code></pre> - - - - - - <h3 id="section-_isConnected"> - _isConnected - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">BOOL</span> <span class="n">_isConnected</span></code></pre> - - - - - - <h3 id="section-protocol"> - protocol - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="n">protocol</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">var</span> <span class="p">`</span><span class="nv">protocol</span><span class="p">`:</span> <span class="nf">SDLAbstractProtocol</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> - - - - - <h3 id="section-transport"> - transport - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="n">transport</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">transport</span><span class="p">:</span> <span class="nf">SDLAbstractTransport</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> - - - - - <h3 id="section-proxyListeners"> - proxyListeners - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><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">NSSet</span><span class="o"><</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">proxyListeners</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">proxyListeners</span><span class="p">:</span> <span class="kt">Set</span><span class="o"><</span><span class="kt">AnyHashable</span><span class="o">></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-startSessionTimer"> - startSessionTimer - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">SDLTimer</span> <span class="o">*</span><span class="n">startSessionTimer</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">startSessionTimer</span><span class="p">:</span> <span class="nf">SDLTimer</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-debugConsoleGroupName"> - debugConsoleGroupName - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">debugConsoleGroupName</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">debugConsoleGroupName</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-proxyVersion"> - proxyVersion - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><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">proxyVersion</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">proxyVersion</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section--initWithTransport:protocol:delegate:"> - -initWithTransport:protocol:delegate: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">initWithTransport</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">transport</span> - <span class="nf">protocol</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span> - <span class="nf">delegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</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">transport</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span><span class="p">,</span> <span class="nv">protocol</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span><span class="p">,</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--addDelegate:"> - -addDelegate: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addDelegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addDelegate</span><span class="p">(</span><span class="n">_</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--removeDelegate:"> - -removeDelegate: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">removeDelegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeDelegate</span><span class="p">(</span><span class="n">_</span> <span class="nv">delegate</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--sendRPC:"> - -sendRPC: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">sendRPC</span><span class="p">(</span><span class="n">_</span> <span class="nv">message</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCMessage.html">SDLRPCMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--handleRPCDictionary:"> - -handleRPCDictionary: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleRPCDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dictionary</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">handleRPCDictionary</span><span class="p">(</span><span class="n">_</span> <span class="nv">dictionary</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">])</span></code></pre> - - - - - <h3 id="section--handleProtocolMessage:"> - -handleProtocolMessage: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolMessage</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">msgData</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">handle</span><span class="p">(</span><span class="n">_</span> <span class="nv">msgData</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span><span class="p">)</span></code></pre> - - - - - <h3 id="section--addSecurityManagers:forAppId:"> - -addSecurityManagers:forAppId: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addSecurityManagers</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="o">*</span><span class="p">)</span><span class="nv">securityManagerClasses</span> <span class="nf">forAppId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">addSecurityManagers</span><span class="p">(</span><span class="n">_</span> <span class="nv">securityManagerClasses</span><span class="p">:</span> <span class="p">[</span><span class="kt">AnyClass</span><span class="p">],</span> <span class="n">forAppId</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> - - - - - <h3 id="section--putFileStream:withRequest:"> - -putFileStream:withRequest: - </h3> - - <p>Puts data into a file on the module -@abstract Performs a putFile for a given input stream, performed in chunks, for handling very large files.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">putFileStream</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSInputStream</span> <span class="o">*</span><span class="p">)</span><span class="nv">inputStream</span> - <span class="nf">withRequest</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLPutFile.html">SDLPutFile</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">putFileRPCRequest</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">putFileStream</span><span class="p">(</span><span class="n">_</span> <span class="nv">inputStream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span> <span class="n">withRequest</span> <span class="nv">putFileRPCRequest</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPutFile.html">SDLPutFile</a></span><span class="p">)</span></code></pre> - - - - <h4>Parameters</h4> - <dl> - <dt>inputStream</dt> - <dd><p>A stream containing the data to put to the module.</p></dd> - <dt>putFileRPCRequest</dt> - <dd><p>A SDLPutFile object containing the parameters for the put(s) -@discussion The proxy will read from the stream based on the max MTU size and send them in individual putFile requests. -This may result in multiple responses being received, one for each request. -Note: the length parameter of the putFileRPCRequest will be ignored. The proxy will substitute the number of bytes read from the stream.</p></dd> - </dl> - -</section> diff --git a/docs/Classes/SDLProxyFactory.html b/docs/Classes/SDLProxyFactory.html deleted file mode 100644 index 9d9074695..000000000 --- a/docs/Classes/SDLProxyFactory.html +++ /dev/null @@ -1,54 +0,0 @@ -<h1>SDLProxyFactory Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+buildSDLProxyWithListener:">+buildSDLProxyWithListener:</a></li> - <li><a href="#section-+buildSDLProxyWithListener:tcpIPAddress:tcpPort:">+buildSDLProxyWithListener:tcpIPAddress:tcpPort:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+buildSDLProxyWithListener:"> - +buildSDLProxyWithListener: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n"><a href="../Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">buildSDLProxyWithListener</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">listener</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">buildSDLProxy</span><span class="p">(</span><span class="n">with</span> <span class="nv">listener</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SDLProxy.html">SDLProxy</a></span></code></pre> - - - - - <h3 id="section-+buildSDLProxyWithListener:tcpIPAddress:tcpPort:"> - +buildSDLProxyWithListener:tcpIPAddress:tcpPort: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n"><a href="../Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">buildSDLProxyWithListener</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">listener</span> - <span class="nf">tcpIPAddress</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">ipaddress</span> - <span class="nf">tcpPort</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">port</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">buildSDLProxy</span><span class="p">(</span><span class="n">with</span> <span class="nv">listener</span><span class="p">:</span> <span class="kt"><a href="../Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="p">,</span> <span class="n">tcpIPAddress</span> <span class="nv">ipaddress</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">tcpPort</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Classes/SDLProxy.html">SDLProxy</a></span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLPutFileResponse.html b/docs/Classes/SDLPutFileResponse.html index 7f01fa2bf..009b9677b 100644 --- a/docs/Classes/SDLPutFileResponse.html +++ b/docs/Classes/SDLPutFileResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Put File Response is sent, when SDLPutFile has been called</p> +<p>Response to SDLPutFile</p> <p>Since SmartDeviceLink 2.0</p> @@ -18,12 +18,13 @@ spaceAvailable </h3> - <p>Undocumented</p> + <p>Provides the total local space available in SDL Core for the registered app. If the transfer has systemFile enabled, then the value will be set to 0 automatically.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">spaceAvailable</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">spaceAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRDSData.html b/docs/Classes/SDLRDSData.html index 6d22701dc..590576a7a 100644 --- a/docs/Classes/SDLRDSData.html +++ b/docs/Classes/SDLRDSData.html @@ -16,9 +16,7 @@ <h3>Overview</h3> -<p>Include the data defined in Radio Data System, -which is a communications protocol standard for embedding small amounts of digital information -in conventional FM radio broadcasts.</p> +<p>Include the data defined in Radio Data System, which is a communications protocol standard for embedding small amounts of digital information in conventional FM radio broadcasts.</p> <section class="section task-group-section"> @@ -44,7 +42,7 @@ in conventional FM radio broadcasts.</p> programService </h3> - <p>@abstract Program Service Name</p> + <p>Program Service Name</p> <p>optional, 0-8</p> @@ -64,7 +62,7 @@ in conventional FM radio broadcasts.</p> radioText </h3> - <p>@abstract Radio Text</p> + <p>Radio Text</p> <p>optional, 0-64</p> @@ -84,7 +82,7 @@ in conventional FM radio broadcasts.</p> clockText </h3> - <p>@abstract The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</p> + <p>The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</p> <p>optional, 0-24</p> @@ -104,7 +102,7 @@ in conventional FM radio broadcasts.</p> programIdentification </h3> - <p>@abstract Program Identification - the call sign for the radio station</p> + <p>Program Identification - the call sign for the radio station</p> <p>optional, 0-6</p> @@ -125,7 +123,7 @@ in conventional FM radio broadcasts.</p> programType </h3> - <p>@abstract The program type - The region should be used to differentiate between EU + <p>The program type - The region should be used to differentiate between EU and North America program types</p> <p>optional, 0-31</p> @@ -146,7 +144,7 @@ in conventional FM radio broadcasts.</p> trafficProgramIdentification </h3> - <p>@abstract Traffic Program Identification - Identifies a station that offers traffic</p> + <p>Traffic Program Identification - Identifies a station that offers traffic</p> <p>optional, Boolean</p> @@ -167,7 +165,7 @@ in conventional FM radio broadcasts.</p> trafficAnnouncementIdentification </h3> - <p>@abstract Traffic Announcement Identification - Indicates an ongoing traffic announcement</p> + <p>Traffic Announcement Identification - Indicates an ongoing traffic announcement</p> <p>optional, Boolean</p> @@ -188,7 +186,7 @@ in conventional FM radio broadcasts.</p> region </h3> - <p>@abstract Region</p> + <p>Region</p> <p>optional, 0-8</p> diff --git a/docs/Classes/SDLRPCMessage.html b/docs/Classes/SDLRPCMessage.html index a70ad1917..f6cbc6d30 100644 --- a/docs/Classes/SDLRPCMessage.html +++ b/docs/Classes/SDLRPCMessage.html @@ -72,12 +72,12 @@ -initWithName: </h3> - <p>Undocumented</p> + <p>Convenience init</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre> + <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">initWithName</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">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -85,17 +85,27 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The name of the message</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLRPCMessage object</p> + </div> <h3 id="section--initWithDictionary:"> -initWithDictionary: </h3> - <p>Undocumented</p> + <p>Convenience init</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + <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">initWithDictionary</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -103,12 +113,21 @@ + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>A dictionary with the format @{messageType: @{parameters}}</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLRPCMessage object</p> + </div> <h3 id="section--getFunctionName"> -getFunctionName </h3> - <p>Undocumented</p> + <p>Returns the function name.</p> @@ -121,12 +140,16 @@ + <div> + <h4>Return Value</h4> + <p>The function name</p> + </div> <h3 id="section--setFunctionName:"> -setFunctionName: </h3> - <p>Undocumented</p> + <p>Sets the function name.</p> @@ -139,17 +162,22 @@ + <h4>Parameters</h4> + <dl> + <dt>functionName</dt> + <dd><p>The function name</p></dd> + </dl> <h3 id="section--getParameters:"> -getParameters: </h3> - <p>Undocumented</p> + <p>Returns the value associated with the provided key. If the key does not exist, null is returned.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nf">getParameters</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nf">getParameters</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">functionName</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -157,17 +185,27 @@ + <h4>Parameters</h4> + <dl> + <dt>functionName</dt> + <dd><p>The key name</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The value associated with the function name</p> + </div> <h3 id="section--setParameters:value:"> -setParameters:value: </h3> - <p>Undocumented</p> + <p>Sets a key-value pair using the function name as the key.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setParameters</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> <span class="nf">value</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setParameters</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">functionName</span> + <span class="nf">value</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -175,17 +213,24 @@ + <h4>Parameters</h4> + <dl> + <dt>functionName</dt> + <dd><p>The name for the key</p></dd> + <dt>value</dt> + <dd><p>The value associated with the function name</p></dd> + </dl> <h3 id="section-bulkData"> bulkData </h3> - <p>Undocumented</p> + <p>The data in the message</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSData</span> <span class="o">*</span><span class="n">bulkData</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">bulkData</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -198,12 +243,12 @@ name </h3> - <p>Undocumented</p> + <p>The name of the message</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">name</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -216,12 +261,12 @@ messageType </h3> - <p>Undocumented</p> + <p>The type of data in the message</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n"><a href="../Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@messageType">messageType</a></span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n"><a href="../Classes/SDLRPCMessage.html#/c:objc(cs)SDLRPCMessage@messageType">messageType</a></span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRPCNotificationNotification.html b/docs/Classes/SDLRPCNotificationNotification.html index 4dfd3090a..47b4fee1e 100644 --- a/docs/Classes/SDLRPCNotificationNotification.html +++ b/docs/Classes/SDLRPCNotificationNotification.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>An NSNotification object that makes retrieving internal SDLRPCNotification data easier</p> <section class="section task-group-section"> @@ -19,12 +19,13 @@ notification </h3> - <p>Undocumented</p> + <p>The notification within the userinfo dictionary</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">__kindof</span> <span class="n"><a href="../Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="n">notification</span></code></pre> + <pre class="highlight objective_c"><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">__kindof</span> <span class="n"><a href="../Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">notification</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +38,15 @@ -initWithName:object:rpcNotification: </h3> - <p>Undocumented</p> + <p>Create an NSNotification object caontaining an SDLRPCNotification</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> <span class="nf">rpcNotification</span><span class="p">:(</span><span class="n">__kindof</span> <span class="n"><a href="../Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> + <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">initWithName</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">name</span> + <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> + <span class="nf">rpcNotification</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">__kindof</span> <span class="n"><a href="../Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -50,6 +54,19 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The NSNotification name</p></dd> + <dt>object</dt> + <dd><p>The NSNotification object</p></dd> + <dt>notification</dt> + <dd><p>The SDLRPCNotification payload</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The NSNotification</p> + </div> <h3 id="section--isNotificationMemberOfClass:"> -isNotificationMemberOfClass: diff --git a/docs/Classes/SDLRPCRequest.html b/docs/Classes/SDLRPCRequest.html index 2f80762c4..fafb48915 100644 --- a/docs/Classes/SDLRPCRequest.html +++ b/docs/Classes/SDLRPCRequest.html @@ -16,12 +16,13 @@ correlationID </h3> - <p>Undocumented</p> + <p>A unique id assigned to message sent to Core. The Correlation ID is used to map a request to its response.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">correlationID</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">correlationID</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRPCResponse.html b/docs/Classes/SDLRPCResponse.html index 2dd783edf..e30df5364 100644 --- a/docs/Classes/SDLRPCResponse.html +++ b/docs/Classes/SDLRPCResponse.html @@ -19,12 +19,13 @@ correlationID </h3> - <p>Undocumented</p> + <p>The correlation id of the corresponding SDLRPCRequest.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">correlationID</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">correlationID</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +38,12 @@ success </h3> - <p>Undocumented</p> + <p>Whether or not the SDLRPCRequest was successful.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">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">success</span></code></pre> + <pre class="highlight objective_c"><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">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">success</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -55,12 +56,12 @@ resultCode </h3> - <p>Undocumented</p> + <p>The result of the SDLRPCRequest. If the request failed, the result code contains the failure reason.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLResult.h@T@SDLResult">SDLResult</a></span> <span class="n">resultCode</span></code></pre> + <pre class="highlight objective_c"><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:SDLResult.h@T@SDLResult">SDLResult</a></span> <span class="n">_Nonnull</span> <span class="n">resultCode</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -73,12 +74,12 @@ info </h3> - <p>Undocumented</p> + <p>More detailed success or error message.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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">NSString</span> <span class="o">*</span><span class="n">info</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">info</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRPCResponseNotification.html b/docs/Classes/SDLRPCResponseNotification.html index 640fffaa6..a64c804d1 100644 --- a/docs/Classes/SDLRPCResponseNotification.html +++ b/docs/Classes/SDLRPCResponseNotification.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>An NSNotification object that makes retrieving internal SDLRPCResponse data easier</p> <section class="section task-group-section"> @@ -19,12 +19,12 @@ response </h3> - <p>Undocumented</p> + <p>The response within the userinfo dictionary</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">readonly</span><span class="p">)</span> <span class="n">__kindof</span> <span class="n"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">response</span></code></pre> + <pre class="highlight objective_c"><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">__kindof</span> <span class="n"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">response</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -37,12 +37,15 @@ -initWithName:object:rpcResponse: </h3> - <p>Undocumented</p> + <p>Create an NSNotification object caontaining an SDLRPCResponse</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> <span class="nf">rpcResponse</span><span class="p">:(</span><span class="n">__kindof</span> <span class="n"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> + <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">initWithName</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">name</span> + <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> + <span class="nf">rpcResponse</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">__kindof</span> <span class="n"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -50,6 +53,19 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The NSNotification name</p></dd> + <dt>object</dt> + <dd><p>The NSNotification object</p></dd> + <dt>response</dt> + <dd><p>The SDLRPCResponse payload</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The NSNotification</p> + </div> <h3 id="section--isResponseMemberOfClass:"> -isResponseMemberOfClass: diff --git a/docs/Classes/SDLRPCStruct.html b/docs/Classes/SDLRPCStruct.html index 97a71fab0..3a0d903ec 100644 --- a/docs/Classes/SDLRPCStruct.html +++ b/docs/Classes/SDLRPCStruct.html @@ -34,12 +34,13 @@ -initWithDictionary: </h3> - <p>Undocumented</p> + <p>Convenience init</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + <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">initWithDictionary</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -47,17 +48,26 @@ + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>A dictionary</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A SDLRPCStruct object</p> + </div> <h3 id="section--init"> -init </h3> - <p>Undocumented</p> + <p>Init</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> + <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="n">init</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -65,17 +75,21 @@ + <div> + <h4>Return Value</h4> + <p>A SDLRPCStruct object</p> + </div> <h3 id="section--serializeAsDictionary:"> -serializeAsDictionary: </h3> - <p>Undocumented</p> + <p>Converts struct to JSON formatted data</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nf">serializeAsDictionary</span><span class="p">:(</span><span class="n">Byte</span><span class="p">)</span><span class="nv">version</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nf">serializeAsDictionary</span><span class="p">:(</span><span class="n">Byte</span><span class="p">)</span><span class="nv">version</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -83,5 +97,14 @@ + <h4>Parameters</h4> + <dl> + <dt>version</dt> + <dd><p>The protocol version</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>JSON formatted data</p> + </div> </section> diff --git a/docs/Classes/SDLRadioControlCapabilities.html b/docs/Classes/SDLRadioControlCapabilities.html index dda91e7fa..6236d30c3 100644 --- a/docs/Classes/SDLRadioControlCapabilities.html +++ b/docs/Classes/SDLRadioControlCapabilities.html @@ -44,8 +44,9 @@ moduleName </h3> - <p>@abstract The short friendly name of the climate control module. - It should not be used to identify a module by mobile application.</p> + <p>The short friendly name of the climate control module.</p> + +<p>It should not be used to identify a module by mobile application.</p> <p>Max string length 100 chars</p> @@ -65,8 +66,9 @@ radioEnableAvailable </h3> - <p>@abstract Availability of the control of enable/disable radio. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the control of enable/disable radio.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -87,8 +89,9 @@ radioBandAvailable </h3> - <p>@abstract Availability of the control of radio band. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the control of radio band.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -109,8 +112,9 @@ radioFrequencyAvailable </h3> - <p>@abstract Availability of the control of radio frequency. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the control of radio frequency.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -131,8 +135,9 @@ hdChannelAvailable </h3> - <p>@abstract Availability of the control of HD radio channel. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the control of HD radio channel.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -153,8 +158,9 @@ rdsDataAvailable </h3> - <p>@abstract Availability of the getting Radio Data System (RDS) data. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting Radio Data System (RDS) data.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -175,8 +181,9 @@ availableHDsAvailable </h3> - <p>@abstract Availability of the getting the number of available HD channels. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting the number of available HD channels.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -197,8 +204,9 @@ stateAvailable </h3> - <p>@abstract Availability of the getting the Radio state. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting the Radio state.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -219,8 +227,9 @@ signalStrengthAvailable </h3> - <p>@abstract Availability of the getting the signal strength. - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting the signal strength.</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> @@ -241,8 +250,9 @@ signalChangeThresholdAvailable </h3> - <p>@abstract Availability of the getting the signal Change Threshold - True: Available, False: Not Available, Not present: Not Available.</p> + <p>Availability of the getting the signal Change Threshold</p> + +<p>True: Available, False: Not Available, Not present: Not Available.</p> <p>Optional, Boolean</p> diff --git a/docs/Classes/SDLRadioControlData.html b/docs/Classes/SDLRadioControlData.html index 6fb95b2fd..36cca3f7a 100644 --- a/docs/Classes/SDLRadioControlData.html +++ b/docs/Classes/SDLRadioControlData.html @@ -44,7 +44,7 @@ frequencyInteger </h3> - <p>@abstract The integer part of the frequency ie for 101.7 this value should be 101</p> + <p>The integer part of the frequency ie for 101.7 this value should be 101</p> <p>Integer</p> @@ -65,7 +65,7 @@ frequencyFraction </h3> - <p>@abstract The fractional part of the frequency for 101.7 is 7</p> + <p>The fractional part of the frequency for 101.7 is 7</p> <p>Integer</p> @@ -86,7 +86,7 @@ band </h3> - <p>@abstract Radio band value</p> + <p>Radio band value</p> <p>SDLRadioBand</p> @@ -106,7 +106,7 @@ rdsData </h3> - <p>@abstract Read only parameter. See RDSData data type for details.</p> + <p>Read only parameter. See RDSData data type for details.</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -131,7 +131,7 @@ availableHDs </h3> - <p>@abstract number of HD sub-channels if available</p> + <p>number of HD sub-channels if available</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -157,7 +157,7 @@ hdChannel </h3> - <p>@abstract Current HD sub-channel if available</p> + <p>Current HD sub-channel if available</p> <p>Integer value Min Value - 1 Max Value -3</p> @@ -177,7 +177,7 @@ signalStrength </h3> - <p>@abstract Signal Strength Value</p> + <p>Signal Strength Value</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -203,7 +203,7 @@ signalChangeThreshold </h3> - <p>@abstract If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</p> + <p>If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> This property is readonly and cannot be set on the module. @@ -229,7 +229,7 @@ radioEnable </h3> - <p>@abstract True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response</p> + <p>True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response</p> <p>Boolean value</p> diff --git a/docs/Classes/SDLReadDID.html b/docs/Classes/SDLReadDID.html index bd37eaf81..f570f2b15 100644 --- a/docs/Classes/SDLReadDID.html +++ b/docs/Classes/SDLReadDID.html @@ -45,7 +45,7 @@ ecuName </h3> - <p>@abstract An ID of the vehicle module + <p>An ID of the vehicle module <br/><b>Notes: </b>Minvalue:0; Maxvalue:65535</p> @@ -64,7 +64,7 @@ didLocation </h3> - <p>@abstract Raw data from vehicle data DID location(s) + <p>Raw data from vehicle data DID location(s) <br/>a Vector<Integer> value representing raw data from vehicle data DID location(s) <p> diff --git a/docs/Classes/SDLReadDIDResponse.html b/docs/Classes/SDLReadDIDResponse.html index 49065c845..db93aff27 100644 --- a/docs/Classes/SDLReadDIDResponse.html +++ b/docs/Classes/SDLReadDIDResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Read DID Response is sent, when ReadDID has been called</p> +<p>A response to ReadDID</p> <p>Since SmartDeviceLink 2.0</p> @@ -18,12 +18,13 @@ didResult </h3> - <p>Undocumented</p> + <p>Array of requested DID results (with data if available).</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLDIDResult.html">SDLDIDResult</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">didResult</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLDIDResult.html">SDLDIDResult</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">didResult</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLRectangle.html b/docs/Classes/SDLRectangle.html index 6c4c0646b..d8da44936 100644 --- a/docs/Classes/SDLRectangle.html +++ b/docs/Classes/SDLRectangle.html @@ -13,7 +13,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct describing a rectangle</p> <section class="section task-group-section"> @@ -84,8 +84,9 @@ x </h3> - <p>The X-coordinate of the user control -Required, Float</p> + <p>The X-coordinate of the user control</p> + +<p>Required, Float</p> @@ -103,8 +104,9 @@ Required, Float</p> y </h3> - <p>The Y-coordinate of the user control -Required, Float</p> + <p>The Y-coordinate of the user control</p> + +<p>Required, Float</p> @@ -122,8 +124,9 @@ Required, Float</p> width </h3> - <p>The width of the user control’s bounding rectangle -Required, Float</p> + <p>The width of the user control’s bounding rectangle</p> + +<p>Required, Float</p> @@ -141,8 +144,9 @@ Required, Float</p> height </h3> - <p>The height of the user control’s bounding rectangle -Required, Float</p> + <p>The height of the user control’s bounding rectangle</p> + +<p>Required, Float</p> diff --git a/docs/Classes/SDLRegisterAppInterface.html b/docs/Classes/SDLRegisterAppInterface.html index 30b6447f7..ac8ae0c4f 100644 --- a/docs/Classes/SDLRegisterAppInterface.html +++ b/docs/Classes/SDLRegisterAppInterface.html @@ -5,9 +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:appType:shortAppName:">-initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:</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:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:">-initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:</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-syncMsgVersion">syncMsgVersion</a></li> <li><a href="#section-appName">appName</a></li> @@ -137,24 +135,6 @@ - <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:"> - -initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppName</span><span class="p">:(</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">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"><a href="../Type Definitions.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">appType</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="p">)</span><span class="nv">appType</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="n">__deprecated_msg</span><span class="p">((</span><span class="s">"use initWithAppName:appId:languageDesired:isMediaApp:appTypes: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 Definitions.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">appType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.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> - - - - <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:"> -initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName: </h3> @@ -173,24 +153,6 @@ - <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:"> - -initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash: - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppName</span><span class="p">:(</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">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"><a href="../Type Definitions.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">appType</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="p">)</span><span class="nv">appType</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"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></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"><</span><span class="n">NSString</span> <span class="o">*></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"><a href="../Type Definitions.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="n">__deprecated_msg</span><span class="p">((</span><span class="s">"use initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired: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 Definitions.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">appType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.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 Definitions.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> - - - - <h3 id="section--initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash:"> -initWithAppName:appId:languageDesired:isMediaApp:appTypes:shortAppName:ttsName:vrSynonyms:hmiDisplayLanguageDesired:resumeHash: </h3> @@ -213,7 +175,7 @@ syncMsgVersion </h3> - <p>@abstract The version of the SDL interface</p> + <p>The version of the SDL interface</p> <p>Required</p> @@ -234,7 +196,7 @@ appName </h3> - <p>@abstract The Mobile Application’s Name, This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink</p> + <p>The Mobile Application’s Name, This name is displayed in the SDL Mobile Applications menu. It also serves as the unique identifier of the application for SmartDeviceLink</p> <p>@discussion <li>Needs to be unique over all applications.</li> @@ -261,7 +223,7 @@ ttsName </h3> - <p>@abstract TTS string for VR recognition of the mobile application name.</p> + <p>TTS string for VR recognition of the mobile application name.</p> <p>@discussion Meant to overcome any failing on speech engine in properly pronouncing / understanding app name. <li>Needs to be unique over all applications.</li> @@ -294,7 +256,7 @@ ngnMediaScreenAppName </h3> - <p>@abstract A String representing an abbreviated version of the mobile application’s name (if necessary) that will be displayed on the media screen</p> + <p>A String representing an abbreviated version of the mobile application’s name (if necessary) that will be displayed on the media screen</p> <p>@discussion If not provided, the appName is used instead (and will be truncated if too long)</p> @@ -317,7 +279,7 @@ vrSynonyms </h3> - <p>@abstract Defines a additional voice recognition commands</p> + <p>Defines a additional voice recognition commands</p> <p>@discussion May not interfere with any app name of previously registered applications and any predefined blacklist of words (global commands)</p> @@ -340,7 +302,7 @@ isMediaApplication </h3> - <p>@abstract Indicates if the application is a media or a non-media application.</p> + <p>Indicates if the application is a media or a non-media application.</p> <p>@discussion Only media applications will be able to stream audio to head units that is audible outside of the BT media source.</p> @@ -363,7 +325,7 @@ languageDesired </h3> - <p>@abstract A Language enumeration indicating what language the application intends to use for user interaction (TTS and VR).</p> + <p>A Language enumeration indicating what language the application intends to use for user interaction (TTS and VR).</p> <p>@discussion If there is a mismatch with the head unit, the app will be able to change this registration with changeRegistration prior to app being brought into focus.</p> @@ -385,7 +347,7 @@ hmiDisplayLanguageDesired </h3> - <p>@abstract An enumeration indicating what language the application intends to use for user interaction (Display).</p> + <p>An enumeration indicating what language the application intends to use for user interaction (Display).</p> <p>@discussion If there is a mismatch with the head unit, the app will be able to change this registration with changeRegistration prior to app being brought into focus.</p> @@ -410,7 +372,7 @@ appHMIType </h3> - <p>@abstract A list of all applicable app types stating which classifications to be given to the app.</p> + <p>A list of all applicable app types stating which classifications to be given to the app.</p> <p>Optional, Array of SDLAppHMIType, Array size 1 - 100</p> @@ -438,7 +400,7 @@ hashID </h3> - <p>@abstract ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).</p> + <p>ID used to uniquely identify current state of all app data that can persist through connection cycles (e.g. ignition cycles).</p> <p>@discussion This registered data (commands, submenus, choice sets, etc.) can be reestablished without needing to explicitly reregister each piece. If omitted, then the previous state of an app’s commands, etc. will not be restored. </p> @@ -462,7 +424,7 @@ deviceInfo </h3> - <p>@abstract Information about the connecting device</p> + <p>Information about the connecting device</p> <p>Optional</p> @@ -482,7 +444,7 @@ appID </h3> - <p>@abstract ID used to validate app with policy table entries</p> + <p>ID used to validate app with policy table entries</p> <p>Required, max length 100</p> @@ -504,7 +466,7 @@ appInfo </h3> - <p>@abstract Information about the application running</p> + <p>Information about the application running</p> <p>Optional</p> diff --git a/docs/Classes/SDLRegisterAppInterfaceResponse.html b/docs/Classes/SDLRegisterAppInterfaceResponse.html index aa8a45630..d620f2760 100644 --- a/docs/Classes/SDLRegisterAppInterfaceResponse.html +++ b/docs/Classes/SDLRegisterAppInterfaceResponse.html @@ -25,7 +25,7 @@ <h3>Overview</h3> -<p>@abstract Register AppInterface Response is sent, when SDLRegisterAppInterface has been called</p> +<p>Response to SDLRegisterAppInterface</p> <p>Since SmartDeviceLink 1.0</p> @@ -35,11 +35,7 @@ syncMsgVersion </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLSyncMsgVersion - -</div> + <p>The RPC spec version supported by the connected IVI system.</p> <p>Optional</p> @@ -60,12 +56,7 @@ language </h3> - <p>The currently active VR+TTS language on Sync.</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLLanguage - -</div> + <p>The currently active VR+TTS language on the module. See <q>Language</q> for options.</p> <p>Optional</p> @@ -85,13 +76,9 @@ hmiDisplayLanguage </h3> - <p>The currently active display language on Sync</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLLanguage -@since SmartDeviceLink 2.0 + <p>The currently active display language on the module. See <q>Language</q> for options.</p> -</div> +<p>Since SmartDeviceLink 2.0</p> <p>Optional</p> @@ -112,11 +99,7 @@ displayCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLDisplayCapabilities - -</div> + <p>Contains information about the display for the SDL system to which the application is currently connected.</p> <p>Optional</p> @@ -137,11 +120,7 @@ buttonCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLButtonCapabilities - -</div> + <p>Provides information about the capabilities of a SDL HMI button.</p> <p>Optional, Array of length 1 - 100, of SDLButtonCapabilities</p> @@ -162,12 +141,7 @@ softButtonCapabilities </h3> - <p>If returned, the platform supports on-screen SoftButtons</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLSoftButtonCapabilities - -</div> + <p>Contains information about a SoftButton’s capabilities.</p> <p>Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities</p> @@ -189,11 +163,6 @@ </h3> <p>If returned, the platform supports custom on-screen Presets</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLPresetBankCapabilities - -</div> <p>Optional</p> @@ -214,11 +183,7 @@ hmiZoneCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLHMIZoneCapabilities - -</div> + <p>Specifies HMI Zones in the vehicle.</p> <p>Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities</p> @@ -239,11 +204,7 @@ speechCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLSpeechCapabilities - -</div> + <p>Contains information about TTS capabilities on the SDL platform.</p> <p>Optional, Array of length 1 - 100, of SDLSpeechCapabilities</p> @@ -264,13 +225,12 @@ prerecordedSpeech </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLPrerecordedSpeech - -</div> + <p>Contains information about the speech capabilities on the SDL platform +*</p> -<p>Optional, Array of length 1 - 100, of SDLPrerecordedSpeech</p> +<ul> +<li>Optional, Array of length 1 - 100, of SDLPrerecordedSpeech</li> +</ul> @@ -289,11 +249,7 @@ vrCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLVRCapabilities - -</div> + <p>The VR capabilities of the connected SDL platform.</p> <p>Optional, Array of length 1 - 100, of SDLVRCapabilities</p> @@ -314,11 +270,7 @@ audioPassThruCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLAudioPassThruCapabilities - -</div> + <p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM}</p> <p>Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities</p> @@ -339,11 +291,7 @@ pcmStreamCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLAudioPassThruCapabilities - -</div> + <p>Describes different audio type configurations for the audio PCM stream service, e.g. {8kHz,8-bit,PCM}</p> @@ -362,14 +310,7 @@ vehicleType </h3> - <p>Specifies the vehicle’s type</p> -<div class="aside aside-see"> - <p class="aside-title">See</p> - SDLVehicleType - -</div> - -<p>Optional, Array of length 1 - 100, of SDLVehicleType</p> + <p>Specifies the connected vehicle’s type</p> @@ -408,11 +349,7 @@ hmiCapabilities </h3> - <div class="aside aside-see"> - <p class="aside-title">See</p> - SDLHMICapabilities - -</div> + <p>Specifies the availability of various SDL features.</p> <p>Optional</p> @@ -433,7 +370,7 @@ sdlVersion </h3> - <p>The SmartDeviceLink version</p> + <p>The SmartDeviceLink Core version</p> <p>Optional, String max length 100</p> @@ -453,7 +390,7 @@ systemSoftwareVersion </h3> - <p>The software version of the system that implements the SmartDeviceLink core</p> + <p>The software version of the system that implements SmartDeviceLink Core</p> <p>Optional, String max length 100</p> diff --git a/docs/Classes/SDLRemoteControlCapabilities.html b/docs/Classes/SDLRemoteControlCapabilities.html index c9615db6b..db4507a94 100644 --- a/docs/Classes/SDLRemoteControlCapabilities.html +++ b/docs/Classes/SDLRemoteControlCapabilities.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Capabilities of the remote control feature</p> <section class="section task-group-section"> @@ -37,7 +37,7 @@ climateControlCapabilities </h3> - <p>@abstract If included, the platform supports RC climate controls. + <p>If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported.</p> <p>Optional, Array of SDLClimateControlCapabilities, Array length 1 - 100</p> @@ -59,7 +59,7 @@ radioControlCapabilities </h3> - <p>@abstract If included, the platform supports RC radio controls. + <p>If included, the platform supports RC radio controls. For this baseline version, maxsize=1. i.e. only one radio control module is supported.</p> <p>Optional, Array of SDLRadioControlCapabilities, Array length 1 - 100</p> @@ -81,7 +81,7 @@ buttonCapabilities </h3> - <p>@abstract If included, the platform supports RC button controls with the included button names.</p> + <p>If included, the platform supports RC button controls with the included button names.</p> <p>Optional, Array of SDLButtonCapabilities, Array length 1 - 100</p> diff --git a/docs/Classes/SDLResetGlobalProperties.html b/docs/Classes/SDLResetGlobalProperties.html index 661b7cecd..49c8a7304 100644 --- a/docs/Classes/SDLResetGlobalProperties.html +++ b/docs/Classes/SDLResetGlobalProperties.html @@ -48,7 +48,7 @@ properties </h3> - <p>@abstract An array of one or more GlobalProperty enumeration elements + <p>An array of one or more GlobalProperty enumeration elements indicating which global properties to reset to their default value</p> diff --git a/docs/Classes/SDLScreenManager.html b/docs/Classes/SDLScreenManager.html index b41f594ff..4184623d5 100644 --- a/docs/Classes/SDLScreenManager.html +++ b/docs/Classes/SDLScreenManager.html @@ -16,7 +16,10 @@ <li><a href="#section-textField3Type">textField3Type</a></li> <li><a href="#section-textField4Type">textField4Type</a></li> <li><a href="#section-softButtonObjects">softButtonObjects</a></li> + <li><a href="#section-menu">menu</a></li> + <li><a href="#section-voiceCommands">voiceCommands</a></li> <li><a href="#section--initWithConnectionManager:fileManager:">-initWithConnectionManager:fileManager:</a></li> + <li><a href="#section--stop">-stop</a></li> <li><a href="#section--beginUpdates">-beginUpdates</a></li> <li><a href="#section--endUpdatesWithCompletionHandler:">-endUpdatesWithCompletionHandler:</a></li> <li><a href="#section--softButtonObjectNamed:">-softButtonObjectNamed:</a></li> @@ -32,12 +35,12 @@ textField1 </h3> - <p>Undocumented</p> + <p>The top text field within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">textField1</span></code></pre> + <pre class="highlight objective_c"><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">textField1</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -50,12 +53,12 @@ textField2 </h3> - <p>Undocumented</p> + <p>The second text field within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">textField2</span></code></pre> + <pre class="highlight objective_c"><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">textField2</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -68,12 +71,12 @@ textField3 </h3> - <p>Undocumented</p> + <p>The third text field within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">textField3</span></code></pre> + <pre class="highlight objective_c"><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">textField3</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -86,12 +89,12 @@ textField4 </h3> - <p>Undocumented</p> + <p>The fourth text field within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">textField4</span></code></pre> + <pre class="highlight objective_c"><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">textField4</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -104,12 +107,12 @@ mediaTrackTextField </h3> - <p>Undocumented</p> + <p>The media text field available within the media layout. Often less emphasized than textField(1-4)</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">mediaTrackTextField</span></code></pre> + <pre class="highlight objective_c"><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">mediaTrackTextField</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -122,12 +125,12 @@ primaryGraphic </h3> - <p>Undocumented</p> + <p>The primary graphic within a template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">primaryGraphic</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">primaryGraphic</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -140,12 +143,12 @@ secondaryGraphic </h3> - <p>Undocumented</p> + <p>A secondary graphic used in some template layouts</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">secondaryGraphic</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">secondaryGraphic</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -158,12 +161,12 @@ textAlignment </h3> - <p>Undocumented</p> + <p>What alignment textField(1-4) should use</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span> <span class="n">textAlignment</span></code></pre> + <pre class="highlight objective_c"><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"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span> <span class="n">_Nonnull</span> <span class="n">textAlignment</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -176,12 +179,12 @@ textField1Type </h3> - <p>Undocumented</p> + <p>The type of data textField1 describes</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField1Type</span></code></pre> + <pre class="highlight objective_c"><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"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField1Type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -194,12 +197,12 @@ textField2Type </h3> - <p>Undocumented</p> + <p>The type of data textField2 describes</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField2Type</span></code></pre> + <pre class="highlight objective_c"><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"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField2Type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -212,12 +215,12 @@ textField3Type </h3> - <p>Undocumented</p> + <p>The type of data textField3 describes</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField3Type</span></code></pre> + <pre class="highlight objective_c"><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"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField3Type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -230,12 +233,12 @@ textField4Type </h3> - <p>Undocumented</p> + <p>The type of data textField4 describes</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField4Type</span></code></pre> + <pre class="highlight objective_c"><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"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField4Type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -248,12 +251,13 @@ softButtonObjects </h3> - <p>Undocumented</p> + <p>The current list of soft buttons within a template layout. Set this array to change the displayed soft buttons.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonObjects</span></code></pre> + <pre class="highlight objective_c"><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">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">softButtonObjects</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -262,20 +266,99 @@ + <h3 id="section-menu"> + menu + </h3> + + <p>The current list of menu cells displayed in the app’s menu.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLMenuCell.html">SDLMenuCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">menu</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">menu</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLMenuCell.html">SDLMenuCell</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> + + + + + <h3 id="section-voiceCommands"> + voiceCommands + </h3> + + <p>The current list of voice commands available for the user to speak and be recognized by the IVI’s voice recognition engine.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVoiceCommand.html">SDLVoiceCommand</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">voiceCommands</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVoiceCommand.html">SDLVoiceCommand</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> + + + + <h3 id="section--initWithConnectionManager:fileManager:"> -initWithConnectionManager:fileManager: </h3> - <p>Undocumented</p> + <p>Initialize a screen manager</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>For internal use</p> + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithConnectionManager</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">connectionManager</span> <span class="nf">fileManager</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLFileManager.html">SDLFileManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManager</span><span class="p">;</span></code></pre> + <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">initWithConnectionManager</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">connectionManager</span> + <span class="nf">fileManager</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLFileManager.html">SDLFileManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManager</span><span class="p">;</span></code></pre> + <h4>Parameters</h4> + <dl> + <dt>connectionManager</dt> + <dd><p>The connection manager used to send RPCs</p></dd> + <dt>fileManager</dt> + <dd><p>The file manager used to upload files</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The screen manager</p> + </div> + + <h3 id="section--stop"> + -stop + </h3> + + <p>Stops the manager.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + For internal use + +</div> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">stop</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">stop</span><span class="p">()</span></code></pre> + + + <h3 id="section--beginUpdates"> -beginUpdates @@ -335,12 +418,13 @@ -softButtonObjectNamed: </h3> - <p>Undocumented</p> + <p>Find a current soft button object with a specific name</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">softButtonObjectNamed</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">softButtonObjectNamed</span><span class="p">:</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">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -348,5 +432,14 @@ + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The name of the soft button object to find</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The soft button object or nil if there isn’t one with that name</p> + </div> </section> diff --git a/docs/Classes/SDLScreenParams.html b/docs/Classes/SDLScreenParams.html index 1db3a4f2f..94b635e4d 100644 --- a/docs/Classes/SDLScreenParams.html +++ b/docs/Classes/SDLScreenParams.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct in DisplayCapabilities describing parameters related to a video / touch input area</p> <section class="section task-group-section"> @@ -17,12 +17,14 @@ resolution </h3> - <p>Undocumented</p> + <p>The resolution of the prescribed screen area</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">resolution</span></code></pre> + <pre class="highlight objective_c"><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/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">resolution</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +37,15 @@ touchEventAvailable </h3> - <p>Undocumented</p> + <p>Types of screen touch events available in screen area</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLTouchEventCapabilities.html">SDLTouchEventCapabilities</a></span> <span class="o">*</span><span class="n">touchEventAvailable</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLTouchEventCapabilities.html">SDLTouchEventCapabilities</a></span> <span class="o">*</span><span class="n">touchEventAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLScrollableMessage.html b/docs/Classes/SDLScrollableMessage.html index e6db99608..a58bf04ee 100644 --- a/docs/Classes/SDLScrollableMessage.html +++ b/docs/Classes/SDLScrollableMessage.html @@ -62,7 +62,7 @@ Function Group: ScrollableMessage scrollableMessageBody </h3> - <p>@abstract A Body of text that can include newlines and tabs + <p>A Body of text that can include newlines and tabs @discussion A String value representing the Body of text that can include newlines and tabs <p> @@ -85,7 +85,7 @@ Function Group: ScrollableMessage timeout </h3> - <p>@abstract Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the + <p>Gets/Sets an App defined timeout. Indicates how long of a timeout in milliseconds from the last action @discussion An Integer value representing an App defined timeout in milliseconds <p> @@ -107,7 +107,7 @@ last action softButtons </h3> - <p>@abstract Gets/Sets App defined SoftButtons.If omitted on supported displays, only the + <p>Gets/Sets App defined SoftButtons.If omitted on supported displays, only the system defined <q>Close</q> SoftButton will be displayed @discussion A Vector<SoftButton> value representing App defined SoftButtons diff --git a/docs/Classes/SDLSetAppIcon.html b/docs/Classes/SDLSetAppIcon.html index e824d155f..a6fa6d086 100644 --- a/docs/Classes/SDLSetAppIcon.html +++ b/docs/Classes/SDLSetAppIcon.html @@ -39,7 +39,7 @@ syncFileName </h3> - <p>@abstract A file reference name + <p>A file reference name @discussion A String value representing a file reference name <p> <b>Notes: </b>Maxlength=500</p> diff --git a/docs/Classes/SDLSetDisplayLayout.html b/docs/Classes/SDLSetDisplayLayout.html index d6d9eb6af..5fec8fa49 100644 --- a/docs/Classes/SDLSetDisplayLayout.html +++ b/docs/Classes/SDLSetDisplayLayout.html @@ -57,7 +57,7 @@ displayLayout </h3> - <p>@abstract A display layout. Predefined or dynamically created screen layout. + <p>A display layout. Predefined or dynamically created screen layout. Currently only predefined screen layouts are defined. Predefined layouts include: <q>ONSCREEN_PRESETS</q> Custom screen containing app-defined onscreen presets. Currently defined for GEN2</p> diff --git a/docs/Classes/SDLSetDisplayLayoutResponse.html b/docs/Classes/SDLSetDisplayLayoutResponse.html index edf629fc0..fd6e8d973 100644 --- a/docs/Classes/SDLSetDisplayLayoutResponse.html +++ b/docs/Classes/SDLSetDisplayLayoutResponse.html @@ -11,7 +11,7 @@ <h3>Overview</h3> -<p>Set Display Layout Response is sent, when SetDisplayLayout has been called</p> +<p>Response to SDLSetDisplayLayout</p> <p>Since SmartDeviceLink 2.0</p> @@ -21,12 +21,13 @@ displayCapabilities </h3> - <p>Undocumented</p> + <p>The display capabilities of the new template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLDisplayCapabilities.html">SDLDisplayCapabilities</a></span> <span class="o">*</span><span class="n">displayCapabilities</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</a></span> <span class="o">*</span><span class="n">displayCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -39,12 +40,13 @@ buttonCapabilities </h3> - <p>Undocumented</p> + <p>The button capabilities of the new template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -57,12 +59,13 @@ softButtonCapabilities </h3> - <p>Undocumented</p> + <p>The soft button capabilities of the new template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonCapabilities</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -75,12 +78,13 @@ presetBankCapabilities </h3> - <p>Undocumented</p> + <p>The preset bank capabilities of the new template layout</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</a></span> <span class="o">*</span><span class="n">presetBankCapabilities</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</a></span> <span class="o">*</span><span class="n">presetBankCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSetGlobalProperties.html b/docs/Classes/SDLSetGlobalProperties.html index 7d98a8eed..87412fb94 100644 --- a/docs/Classes/SDLSetGlobalProperties.html +++ b/docs/Classes/SDLSetGlobalProperties.html @@ -17,14 +17,11 @@ <h3>Overview</h3> -<p>Sets value(s) for the specified global property(ies) - <p> - Function Group: Base <p> - <b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> - </p></p> +<p>Sets global property values</p> -<p>Since SmartDeviceLink 1.0 - See SDLResetGlobalProperties</p> +<p>Since SmartDeviceLink 1.0</p> + +<p>See SDLResetGlobalProperties</p> <section class="section task-group-section"> @@ -32,12 +29,13 @@ -initWithHelpText:timeoutText: </h3> - <p>Undocumented</p> + <p>Initialize SetGlobalProperties with help text and timeout text</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHelpText</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">helpText</span> <span class="nf">timeoutText</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">timeoutText</span><span class="p">;</span></code></pre> + <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">initWithHelpText</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">helpText</span> + <span class="nf">timeoutText</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">timeoutText</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -45,17 +43,32 @@ + <h4>Parameters</h4> + <dl> + <dt>helpText</dt> + <dd><p>A string that will be turned into TTS chunks for the help prompt</p></dd> + <dt>timeoutText</dt> + <dd><p>A string that will be turned into TTS chunks for the timeout prompt</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The SetGlobalProperties RPC</p> + </div> <h3 id="section--initWithHelpText:timeoutText:vrHelpTitle:vrHelp:"> -initWithHelpText:timeoutText:vrHelpTitle:vrHelp: </h3> - <p>Undocumented</p> + <p>Initialize SetGlobalProperties with help text, timeout text, help title, and help items</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHelpText</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">helpText</span> <span class="nf">timeoutText</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">timeoutText</span> <span class="nf">vrHelpTitle</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">vrHelpTitle</span> <span class="nf">vrHelp</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelp</span><span class="p">;</span></code></pre> + <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">initWithHelpText</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">helpText</span> + <span class="nf">timeoutText</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">timeoutText</span> + <span class="nf">vrHelpTitle</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">vrHelpTitle</span> + <span class="nf">vrHelp</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLSetGlobalProperties.html#/c:objc(cs)SDLSetGlobalProperties(py)vrHelp">vrHelp</a></span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -63,17 +76,39 @@ + <h4>Parameters</h4> + <dl> + <dt>helpText</dt> + <dd><p>A string that will be turned into TTS chunks for the help prompt</p></dd> + <dt>timeoutText</dt> + <dd><p>A string that will be turned into TTS chunks for the timeout prompt</p></dd> + <dt>vrHelpTitle</dt> + <dd><p>The title of the help interface prompt</p></dd> + <dt>vrHelp</dt> + <dd><p>The items of the help interface prompt</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The SetGlobalProperties RPC</p> + </div> <h3 id="section--initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:"> -initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties: </h3> - <p>Undocumented</p> + <p>Initialize SetGlobalProperties with all possible items</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHelpText</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">helpText</span> <span class="nf">timeoutText</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">timeoutText</span> <span class="nf">vrHelpTitle</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">vrHelpTitle</span> <span class="nf">vrHelp</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelp</span> <span class="nf">menuTitle</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">menuTitle</span> <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">menuIcon</span> <span class="nf">keyboardProperties</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">keyboardProperties</span><span class="p">;</span></code></pre> + <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">initWithHelpText</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">helpText</span> + <span class="nf">timeoutText</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">timeoutText</span> + <span class="nf">vrHelpTitle</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">vrHelpTitle</span> + <span class="nf">vrHelp</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">vrHelp</span> + <span class="nf">menuTitle</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">menuTitle</span> + <span class="nf">menuIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">menuIcon</span> +<span class="nf">keyboardProperties</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">keyboardProperties</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -81,22 +116,35 @@ + <h4>Parameters</h4> + <dl> + <dt>helpText</dt> + <dd><p>A string that will be turned into TTS chunks for the help prompt</p></dd> + <dt>timeoutText</dt> + <dd><p>A string that will be turned into TTS chunks for the timeout prompt</p></dd> + <dt>vrHelpTitle</dt> + <dd><p>The title of the help interface prompt</p></dd> + <dt>vrHelp</dt> + <dd><p>The items of the help interface prompt</p></dd> + <dt>menuTitle</dt> + <dd><p>The title of the menu button</p></dd> + <dt>menuIcon</dt> + <dd><p>The icon on the menu button</p></dd> + <dt>keyboardProperties</dt> + <dd><p>The properties of a keyboard prompt</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The SetGlobalProperties RPC</p> + </div> <h3 id="section-helpPrompt"> helpPrompt </h3> - <p>@abstract Sets a Vector<TTSChunk> for Help Prompt that Array of one or more -TTSChunk elements specifying the help prompt used in an interaction -started by PTT -@discussion helpPrompt - a Vector<TTSChunk> of one or more TTSChunk elements - <p> - <b>Notes: </b> - <ul> - <li>Array must have at least one element</li> - <li>Only optional it timeoutPrompt has been specified</li> - </ul></p> + <p>Help prompt for when the user asks for help with an interface prompt</p> + +<p>Optional</p> @@ -115,9 +163,9 @@ started by PTT timeoutPrompt </h3> - <p>@abstract A Vector<TTSChunk> for Timeout Prompt representing Array of one or - more TTSChunk elements specifying the help prompt used in an interaction - started by PTT</p> + <p>Help prompt for when an interface prompt times out</p> + +<p>Optional, Array, at least 1 item</p> @@ -136,19 +184,9 @@ started by PTT vrHelpTitle </h3> - <p>@abstract Sets a voice recognition Help Title</p> + <p>Sets a voice recognition Help Title</p> -<p>@discussion A String value representing a voice recognition Help Title - <p> - <b>Notes: </b><br/> - <ul> - <li>If omitted on supported displays, the default SDL help - title will be used</li> - <li>If omitted and one or more vrHelp items are provided, the - request will be rejected.</li> - <li>String Maxlength = 500</li> - </ul> - @since SmartDeviceLink 2.0</p> +<p>Optional</p> @@ -166,24 +204,11 @@ started by PTT vrHelp </h3> - <p>@abstract Sets the items listed in the VR help screen used in an interaction - started by PTT</p> + <p>Sets the items listed in the VR help screen used in an interaction started by Push to Talk</p> + +<p>@since SmartDeviceLink 2.0</p> -<p>@discussion A Vector value representing items listed in the VR help screen - used in an interaction started by PTT - <p> - <b>Notes: </b><br/> - <ul> - <li>If omitted on supported displays, the default SmartDeviceLink VR - help / What Can I Say? screen will be used</li> - <li>If the list of VR Help Items contains nonsequential - positions (e.g. [1,2,4]), the RPC will be rejected</li> - <li>If omitted and a vrHelpTitle is provided, the request - will be rejected</li> - <li>Array Minsize: = 1</li> - <li>Array Maxsize = 100</li> - </ul> - @since SmartDeviceLink 2.0</p> +<p>Optional</p> @@ -202,12 +227,14 @@ started by PTT menuTitle </h3> - <p>Undocumented</p> + <p>Text for the menu button label</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">menuTitle</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">menuTitle</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -220,12 +247,14 @@ started by PTT menuIcon </h3> - <p>Undocumented</p> + <p>Icon for the menu button</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">menuIcon</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">menuIcon</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -238,12 +267,15 @@ started by PTT keyboardProperties </h3> - <p>Undocumented</p> + <p>On-screen keyboard (perform interaction) configuration</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="n">keyboardProperties</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="n">keyboardProperties</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSetInteriorVehicleDataResponse.html b/docs/Classes/SDLSetInteriorVehicleDataResponse.html index 396291336..6970dc424 100644 --- a/docs/Classes/SDLSetInteriorVehicleDataResponse.html +++ b/docs/Classes/SDLSetInteriorVehicleDataResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Used to set the values of one remote control module</p> +<p>Response to SDLSetInteriorVehicleData</p> <section class="section task-group-section"> @@ -16,7 +16,7 @@ moduleData </h3> - <p>The module data to set for the requested remote control module.</p> + <p>The new module data for the requested module</p> diff --git a/docs/Classes/SDLSetMediaClockTimer.html b/docs/Classes/SDLSetMediaClockTimer.html index c2d891d2c..f9696d997 100644 --- a/docs/Classes/SDLSetMediaClockTimer.html +++ b/docs/Classes/SDLSetMediaClockTimer.html @@ -63,7 +63,7 @@ startTime </h3> - <p>@abstract A Start Time with specifying hour, minute, second values</p> + <p>A Start Time with specifying hour, minute, second values</p> <p>@discussion A startTime object with specifying hour, minute, second values <p> @@ -90,7 +90,7 @@ endTime </h3> - <p>@abstract An END time of type SDLStartTime, specifying hour, minute, second values</p> + <p>An END time of type SDLStartTime, specifying hour, minute, second values</p> <p>@discussion An SDLStartTime object with specifying hour, minute, second values</p> @@ -110,7 +110,7 @@ updateMode </h3> - <p>@abstract The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)</p> + <p>The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)</p> <p>@discussion a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME) <p> diff --git a/docs/Classes/SDLShow.html b/docs/Classes/SDLShow.html index 79272fd54..9ca0350ac 100644 --- a/docs/Classes/SDLShow.html +++ b/docs/Classes/SDLShow.html @@ -161,7 +161,7 @@ mainField1 </h3> - <p>@abstract The text displayed in a single-line display, or in the upper display + <p>The text displayed in a single-line display, or in the upper display line in a two-line display @discussion The String value representing the text displayed in a single-line display, or in the upper display line in a @@ -191,7 +191,7 @@ line in a two-line display mainField2 </h3> - <p>@abstract The text displayed on the second display line of a two-line display</p> + <p>The text displayed on the second display line of a two-line display</p> <p>@discussion The String value representing the text displayed on the second display line of a two-line display @@ -223,7 +223,7 @@ line in a two-line display mainField3 </h3> - <p>@abstract The text displayed on the first display line of the second page</p> + <p>The text displayed on the first display line of the second page</p> <p>@discussion The String value representing the text displayed on the first display line of the second page @@ -256,7 +256,7 @@ line in a two-line display mainField4 </h3> - <p>@abstract The text displayed on the second display line of the second page</p> + <p>The text displayed on the second display line of the second page</p> <p>@discussion The String value representing the text displayed on the second display line of the second page @@ -289,7 +289,7 @@ line in a two-line display alignment </h3> - <p>@abstract The alignment that Specifies how mainField1 and mainField2 text + <p>The alignment that Specifies how mainField1 and mainField2 text should be aligned on display</p> <p>@discussion An Enumeration value @@ -319,7 +319,7 @@ line in a two-line display statusBar </h3> - <p>@abstract Text in the Status Bar</p> + <p>Text in the Status Bar</p> <p>@discussion A String representing the text you want to add in the Status Bar @@ -351,7 +351,7 @@ line in a two-line display mediaClock </h3> - <p>@abstract This property is deprecated use SetMediaClockTimer instead. + <p>This property is deprecated use SetMediaClockTimer instead. <p> The value for the MediaClock field using a format described in the MediaClockFormat enumeration</p> @@ -382,7 +382,7 @@ line in a two-line display mediaTrack </h3> - <p>@abstract The text in the track field</p> + <p>The text in the track field</p> <p>@discussion A String value disaplayed in the track field <p> @@ -409,7 +409,7 @@ line in a two-line display graphic </h3> - <p>@abstract An image to be shown on supported displays</p> + <p>An image to be shown on supported displays</p> <p>@discussion The value representing the image shown on supported displays <p> @@ -433,7 +433,7 @@ line in a two-line display secondaryGraphic </h3> - <p>@abstract An image to be shown on supported displays</p> + <p>An image to be shown on supported displays</p> <p>@discussion The value representing the image shown on supported displays <p> @@ -457,7 +457,7 @@ line in a two-line display softButtons </h3> - <p>@abstract The the Soft buttons defined by the App</p> + <p>The the Soft buttons defined by the App</p> <p>@discussion A Vector value represemting the Soft buttons defined by the App @@ -489,10 +489,9 @@ line in a two-line display customPresets </h3> - <p>@abstract The Custom Presets defined by the App</p> + <p>The Custom Presets defined by the App</p> -<p>@discussion A Vector value representing the Custom Presets defined by the - App +<p>@discussion A Vector value representing the Custom Presets defined by the App <p> <ul> <li>If omitted on supported displays, the presets will be shown as not defined</li> @@ -518,15 +517,11 @@ line in a two-line display metadataTags </h3> - <p>@abstract Text Field Metadata</p> + <p>Text Field Metadata</p> -<p>@discussion A Vector value representing the Custom Presets defined by the - App - <p> - App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. - If omitted on supported displays, the currently set metadata tags will not change. - If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed. - @since SmartDeviceLink 2.0</p> +<p>App defined metadata information. See MetadataStruct. Uses mainField1, mainField2, mainField3, mainField4. If omitted on supported displays, the currently set metadata tags will not change. If any text field contains no tags or the none tag, the metadata tag for that textfield should be removed.</p> + +<p>@since SmartDeviceLink 2.0</p> diff --git a/docs/Classes/SDLShowConstantTBT.html b/docs/Classes/SDLShowConstantTBT.html index 19e06bec9..452554579 100644 --- a/docs/Classes/SDLShowConstantTBT.html +++ b/docs/Classes/SDLShowConstantTBT.html @@ -19,14 +19,9 @@ <h3>Overview</h3> -<p>This RPC is used to update the user with navigation information<br></p> +<p>This RPC is used to update the user with navigation information for the constantly shown screen (base screen), but also for the alert maneuver screen.</p> -<ul> -<li>for the constantly shown screen (base screen),but also for the<br></li> -<li>alert type screen. -*<p></li> -<li>@since SmartDeviceLink 2.0</li> -</ul> +<p>@since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -52,12 +47,14 @@ navigationText1 </h3> - <p>Undocumented</p> + <p>The first line of text in a multi-line overlay screen.</p> + +<p>Optional, Max length 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText1</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText1</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -70,12 +67,14 @@ navigationText2 </h3> - <p>Undocumented</p> + <p>The second line of text in a multi-line overlay screen.</p> + +<p>Optional, 1 - 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText2</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText2</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -88,12 +87,14 @@ eta </h3> - <p>Undocumented</p> + <p>Estimated Time of Arrival time at final destination</p> + +<p>Optional, 1 - 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">eta</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">eta</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -106,12 +107,14 @@ timeToDestination </h3> - <p>Undocumented</p> + <p>The amount of time needed to reach the final destination</p> + +<p>Optional, 1 - 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">timeToDestination</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">timeToDestination</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -124,12 +127,14 @@ totalDistance </h3> - <p>Undocumented</p> + <p>The distance to the final destination</p> + +<p>Optional, 1 - 500 chars</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">totalDistance</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">totalDistance</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -142,12 +147,19 @@ turnIcon </h3> - <p>Undocumented</p> + <p>An icon to show with the turn description</p> + +<p>Optional</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLImage + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -160,12 +172,19 @@ nextTurnIcon </h3> - <p>Undocumented</p> + <p>An icon to show with the next turn description</p> + +<p>Optional</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLImage + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">nextTurnIcon</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">nextTurnIcon</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -178,12 +197,15 @@ distanceToManeuver </h3> - <p>Undocumented</p> + <p>Fraction of distance till next maneuver (starting from when AlertManeuver is triggered). Used to calculate progress bar.</p> + +<p>Optional, Float, 0 - 1,000,000,000</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuver</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuver</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -196,12 +218,15 @@ distanceToManeuverScale </h3> - <p>Undocumented</p> + <p>Distance till next maneuver (starting from) from previous maneuver. Used to calculate progress bar.</p> + +<p>Optional, Float, 0 - 1,000,000,000</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuverScale</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">distanceToManeuverScale</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -214,12 +239,15 @@ maneuverComplete </h3> - <p>Undocumented</p> + <p>If and when a maneuver has completed while an AlertManeuver is active, the app must send this value set to TRUE in order to clear the AlertManeuver overlay. If omitted the value will be assumed as FALSE.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">maneuverComplete</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">maneuverComplete</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -232,12 +260,20 @@ softButtons </h3> - <p>Undocumented</p> + <p>Three dynamic SoftButtons available (first SoftButton is fixed to <q>Turns</q>). If omitted on supported displays, the currently displayed SoftButton values will not change.</p> + +<p>Optional, Array length 0 - 3</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLSoftButton + +</div> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSingleTireStatus.html b/docs/Classes/SDLSingleTireStatus.html index 577f3be3f..8afe53674 100644 --- a/docs/Classes/SDLSingleTireStatus.html +++ b/docs/Classes/SDLSingleTireStatus.html @@ -18,7 +18,12 @@ status </h3> - <p>@abstract The volume status of a single tire</p> + +<ul> +<li>The volume status of a single tire</li> +</ul> + +<p>Required</p> diff --git a/docs/Classes/SDLSlider.html b/docs/Classes/SDLSlider.html index a6f13dd2a..91bd97017 100644 --- a/docs/Classes/SDLSlider.html +++ b/docs/Classes/SDLSlider.html @@ -136,7 +136,7 @@ numTicks </h3> - <p>@abstract Represents a number of selectable items on a horizontal axis</p> + <p>Represents a number of selectable items on a horizontal axis</p> <p>Required, Integer, 2 - 26</p> @@ -156,7 +156,7 @@ position </h3> - <p>@abstract An Initial position of slider control</p> + <p>An Initial position of slider control</p> <p>Required, Integer, 1 - 26</p> @@ -176,7 +176,7 @@ sliderHeader </h3> - <p>@abstract A text header to display</p> + <p>A text header to display</p> <p>Required, Max length 500 chars</p> @@ -196,7 +196,7 @@ sliderFooter </h3> - <p>@abstract A text footer to display</p> + <p>A text footer to display</p> <p>@discussion For a static text footer, only one footer string shall be provided in the array.</p> @@ -225,7 +225,7 @@ timeout </h3> - <p>@abstract An App defined timeout in milliseconds</p> + <p>An App defined timeout in milliseconds</p> <p>@discussion Indicates how long of a timeout from the last action (i.e. sliding control resets timeout).</p> diff --git a/docs/Classes/SDLSliderResponse.html b/docs/Classes/SDLSliderResponse.html index 946687d73..e9fe72714 100644 --- a/docs/Classes/SDLSliderResponse.html +++ b/docs/Classes/SDLSliderResponse.html @@ -8,7 +8,7 @@ <h3>Overview</h3> -<p>Slider Response is sent, when Slider has been called</p> +<p>Response to SDLSlider</p> <p>Since SmartDeviceLink 2.0</p> @@ -18,7 +18,7 @@ sliderPosition </h3> - <p>@abstract The selected position of the slider.</p> + <p>The selected position of the slider.</p> diff --git a/docs/Classes/SDLSoftButton.html b/docs/Classes/SDLSoftButton.html index 08d57c80e..8e73e209d 100644 --- a/docs/Classes/SDLSoftButton.html +++ b/docs/Classes/SDLSoftButton.html @@ -16,7 +16,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Describes an on-screen button which may be presented in various contexts, e.g. templates or alerts</p> <section class="section task-group-section"> @@ -78,12 +78,14 @@ type </h3> - <p>Undocumented</p> + <p>Describes whether this soft button displays only text, only an image, or both</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span> <span class="n">type</span></code></pre> + <pre class="highlight objective_c"><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:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span> <span class="n">_Nonnull</span> <span class="n">type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -96,12 +98,14 @@ text </h3> - <p>Undocumented</p> + <p>Optional text to display (if defined as TEXT or BOTH type)</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -114,12 +118,14 @@ image </h3> - <p>Undocumented</p> + <p>Optional image struct for SoftButton (if defined as IMAGE or BOTH type)</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -132,12 +138,15 @@ isHighlighted </h3> - <p>Undocumented</p> + <p>Displays in an alternate mode, e.g. with a colored background or foreground. Depends on the IVI system.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">isHighlighted</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">isHighlighted</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -150,12 +159,14 @@ softButtonID </h3> - <p>Undocumented</p> + <p>Value which is returned via OnButtonPress / OnButtonEvent</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">softButtonID</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">softButtonID</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -168,12 +179,14 @@ systemAction </h3> - <p>Undocumented</p> + <p>Parameter indicating whether selecting a SoftButton shall call a specific system action. This is intended to allow Notifications to bring the callee into full / focus; or in the case of persistent overlays, the overlay can persist when a SoftButton is pressed.</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span> <span class="n">systemAction</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span> <span class="n">systemAction</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSoftButtonCapabilities.html b/docs/Classes/SDLSoftButtonCapabilities.html index ceffe0a47..12b05bc31 100644 --- a/docs/Classes/SDLSoftButtonCapabilities.html +++ b/docs/Classes/SDLSoftButtonCapabilities.html @@ -21,9 +21,9 @@ shortPressAvailable </h3> - <p>@abstract The button supports a short press.</p> + <p>The button supports a short press.</p> -<p>@discussion Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked.</p> +<p>Whenever the button is pressed short, onButtonPressed(SHORT) will be invoked.</p> <p>Required, Boolean</p> @@ -44,9 +44,9 @@ longPressAvailable </h3> - <p>@abstract The button supports a LONG press.</p> + <p>The button supports a LONG press.</p> -<p>@discussion Whenever the button is pressed long, onButtonPressed(LONG) will be invoked.</p> +<p>Whenever the button is pressed long, onButtonPressed(LONG) will be invoked.</p> <p>Required, Boolean</p> @@ -67,9 +67,9 @@ upDownAvailable </h3> - <p>@abstract The button supports <q>button down</q> and <q>button up</q>.</p> + <p>The button supports <q>button down</q> and <q>button up</q>.</p> -<p>@discussion Whenever the button is pressed, onButtonEvent(DOWN) will be invoked. Whenever the button is released, onButtonEvent(UP) will be invoked.</p> +<p>Whenever the button is pressed, onButtonEvent(DOWN) will be invoked. Whenever the button is released, onButtonEvent(UP) will be invoked.</p> <p>Required, Boolean</p> @@ -90,7 +90,7 @@ imageSupported </h3> - <p>@abstract The button supports referencing a static or dynamic image.</p> + <p>The button supports referencing a static or dynamic image.</p> <p>Required, Boolean</p> diff --git a/docs/Classes/SDLSoftButtonObject.html b/docs/Classes/SDLSoftButtonObject.html index 4e8384a72..ed84c3384 100644 --- a/docs/Classes/SDLSoftButtonObject.html +++ b/docs/Classes/SDLSoftButtonObject.html @@ -17,7 +17,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A soft button wrapper object that is capable of storing and switching between states</p> <section class="section task-group-section"> @@ -212,7 +212,7 @@ -transitionToNextState </h3> - <p>Undocumented</p> + <p>Transition the soft button to the next state of the array set when in the <code><a href="../Classes/SDLSoftButtonObject.html#/c:objc(cs)SDLSoftButtonObject(py)states">states</a></code> property</p> diff --git a/docs/Classes/SDLSpeak.html b/docs/Classes/SDLSpeak.html index 46db95951..03958a86b 100644 --- a/docs/Classes/SDLSpeak.html +++ b/docs/Classes/SDLSpeak.html @@ -88,7 +88,7 @@ ttsChunks </h3> - <p>@abstract An array of TTSChunk structs which, taken together, specify the phrase to be spoken</p> + <p>An array of TTSChunk structs which, taken together, specify the phrase to be spoken</p> <p>@discussion The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected</p> diff --git a/docs/Classes/SDLStartTime.html b/docs/Classes/SDLStartTime.html index adf46e898..e687b970a 100644 --- a/docs/Classes/SDLStartTime.html +++ b/docs/Classes/SDLStartTime.html @@ -39,9 +39,9 @@ hours </h3> - <p>@abstract The hour of the media clock</p> + <p>The hour of the media clock</p> -<p>@discussion Some display types only support a max value of 19. If out of range, it will be rejected.</p> +<p>Some display types only support a max value of 19. If out of range, it will be rejected.</p> <p>Required, Integer, 0 - 59</p> @@ -61,7 +61,7 @@ minutes </h3> - <p>@abstract The minute of the media clock</p> + <p>The minute of the media clock</p> <p>Required, Integer, 0 - 59</p> @@ -81,7 +81,7 @@ seconds </h3> - <p>@abstract The second of the media clock</p> + <p>The second of the media clock</p> <p>Required, Integer, 0 - 59</p> diff --git a/docs/Classes/SDLStreamingMediaConfiguration.html b/docs/Classes/SDLStreamingMediaConfiguration.html index 20383f6a6..ff784b7ea 100644 --- a/docs/Classes/SDLStreamingMediaConfiguration.html +++ b/docs/Classes/SDLStreamingMediaConfiguration.html @@ -7,13 +7,11 @@ <li><a href="#section-maximumDesiredEncryption">maximumDesiredEncryption</a></li> <li><a href="#section-customVideoEncoderSettings">customVideoEncoderSettings</a></li> <li><a href="#section-dataSource">dataSource</a></li> - <li><a href="#section-window">window</a></li> <li><a href="#section-rootViewController">rootViewController</a></li> <li><a href="#section-carWindowRenderingType">carWindowRenderingType</a></li> <li><a href="#section-enableForcedFramerateSync">enableForcedFramerateSync</a></li> <li><a href="#section-allowMultipleViewControllerOrientations">allowMultipleViewControllerOrientations</a></li> <li><a href="#section--init">-init</a></li> - <li><a href="#section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:">-initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:</a></li> <li><a href="#section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:">-initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:</a></li> <li><a href="#section--initWithSecurityManagers:">-initWithSecurityManagers:</a></li> <li><a href="#section-+secureConfigurationWithSecurityManagers:">+secureConfigurationWithSecurityManagers:</a></li> @@ -93,43 +91,13 @@ <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span> + <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingMediaManagerDataSource.html">SDLStreamingMediaManagerDataSource</a></span><span class="o">></span> <span class="n">dataSource</span><span class="p">;</span></code></pre> - <h3 id="section-window"> - window - </h3> - - <p>Set the window your video streaming content is within.</p> - -<p>Activates the haptic view parser when set. If the window contains <code>UIView</code> based views, these will be discovered and automatically sent to the head unit if it uses a haptic interface. Whether or not it supports the haptic interace, this library will also use that information to attempt to return the touched view to you in <code><a href="../Protocols/SDLTouchManagerDelegate.html">SDLTouchManagerDelegate</a></code>.</p> -<div class="aside aside-warning"> - <p class="aside-title">Warning</p> - <p>Apps using views outside of the <code>UIView</code> heirarchy (such as OpenGL) are currently unsupported. If you app uses partial views in the heirarchy, only those views will be discovered. Your OpenGL views will not be discoverable to a haptic interface head unit and you will have to manually make these views discoverable via the <code><a href="../Classes/SDLSendHapticData.html">SDLSendHapticData</a></code> RPC request.</p> - -</div> -<div class="aside aside-warning"> - <p class="aside-title">Warning</p> - <p>This is a weak property and it’s therefore your job to hold a strong reference to this window.</p> - -</div> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">UIWindow</span> <span class="o">*</span><span class="n">window</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">window</span><span class="p">:</span> <span class="nf">UIWindow</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> - - - - <h3 id="section-rootViewController"> rootViewController </h3> @@ -254,43 +222,6 @@ <p>The configuration</p> </div> - <h3 id="section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:"> - -initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window: - </h3> - - <p>Manually set all the properties to the streaming media configuration</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">initWithSecurityManagers</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</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="p">)</span><span class="nv">securityManagers</span> - <span class="nf">encryptionFlag</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span><span class="p">)</span><span class="nv">encryptionFlag</span> - <span class="nf">videoSettings</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">videoSettings</span> - <span class="nf">dataSource</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> - <span class="nf">window</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIWindow</span> <span class="o">*</span><span class="p">)</span><span class="nv">window</span><span class="p">;</span></code></pre> - - - - - <h4>Parameters</h4> - <dl> - <dt>securityManagers</dt> - <dd><p>The security managers to use or nil for none.</p></dd> - <dt>encryptionFlag</dt> - <dd><p>The maximum encrpytion supported. If the connected head unit supports less than set here, it will still connect, but if it supports more than set here, it will not connect.</p></dd> - <dt>videoSettings</dt> - <dd><p>Custom video encoder settings to be used in video streaming.</p></dd> - <dt>window</dt> - <dd><p>The UIWindow you are running the content that is being streamed on, to use for haptics if needed and possible (only works for UIViews)</p></dd> - </dl> - <div> - <h4>Return Value</h4> - <p>The configuration</p> - </div> - <h3 id="section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController:"> -initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:rootViewController: </h3> @@ -306,7 +237,7 @@ <span class="nf">encryptionFlag</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span><span class="p">)</span><span class="nv">encryptionFlag</span> <span class="nf">videoSettings</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">videoSettings</span> <span class="nf">dataSource</span><span class="p">:</span> - <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingMediaManagerDataSource.html">SDLStreamingMediaManagerDataSource</a></span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> <span class="nf">rootViewController</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">rootViewController</span><span class="p">;</span></code></pre> diff --git a/docs/Classes/SDLStreamingMediaManager.html b/docs/Classes/SDLStreamingMediaManager.html index 46f1cd85b..026edf9f9 100644 --- a/docs/Classes/SDLStreamingMediaManager.html +++ b/docs/Classes/SDLStreamingMediaManager.html @@ -55,12 +55,13 @@ audioManager </h3> - <p>Undocumented</p> + <p>Audio Manager responsible for managing streaming audio.</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">readonly</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="n">audioManager</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">audioManager</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -379,11 +380,11 @@ <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startWithProtocol</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startWithProtocol</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">SDLProtocol</span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">start</span><span class="p">(</span><span class="n">with</span> <span class="nv">protocol</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span><span class="p">)</span></code></pre> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">start</span><span class="p">(</span><span class="n">with</span> <span class="nv">protocol</span><span class="p">:</span> <span class="kt">SDLProtocol</span><span class="p">)</span></code></pre> diff --git a/docs/Classes/SDLSubscribeButton.html b/docs/Classes/SDLSubscribeButton.html index 31e692b1a..758c0a464 100644 --- a/docs/Classes/SDLSubscribeButton.html +++ b/docs/Classes/SDLSubscribeButton.html @@ -136,7 +136,7 @@ buttonName </h3> - <p>@abstract The name of the button to subscribe to + <p>The name of the button to subscribe to @discussion An enum value, see <i>SDLButtonName</i></p> diff --git a/docs/Classes/SDLSubscribeVehicleData.html b/docs/Classes/SDLSubscribeVehicleData.html index d5cdedb95..05545dd3c 100644 --- a/docs/Classes/SDLSubscribeVehicleData.html +++ b/docs/Classes/SDLSubscribeVehicleData.html @@ -52,12 +52,36 @@ -initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus: </h3> - <p>Undocumented</p> + <p>Initialize a subscribe RPC with various possible to describe to</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAccelerationPedalPosition</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">accelerationPedalPosition</span> <span class="nf">airbagStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">airbagStatus</span> <span class="nf">beltStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">beltStatus</span> <span class="nf">bodyInformation</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">bodyInformation</span> <span class="nf">clusterModeStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">clusterModeStatus</span> <span class="nf">deviceStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">deviceStatus</span> <span class="nf">driverBraking</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">driverBraking</span> <span class="nf">eCallInfo</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">eCallInfo</span> <span class="nf">emergencyEvent</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">emergencyEvent</span> <span class="nf">engineTorque</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">engineTorque</span> <span class="nf">externalTemperature</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">externalTemperature</span> <span class="nf">fuelLevel</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">fuelLevel</span> <span class="nf">fuelLevelState</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">fuelLevelState</span> <span class="nf">gps</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">gps</span> <span class="nf">headLampStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">headLampStatus</span> <span class="nf">instantFuelConsumption</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">instantFuelConsumption</span> <span class="nf">myKey</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">myKey</span> <span class="nf">odometer</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">odometer</span> <span class="nf">prndl</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">prndl</span> <span class="nf">rpm</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">rpm</span> <span class="nf">speed</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">speed</span> <span class="nf">steeringWheelAngle</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">steeringWheelAngle</span> <span class="nf">tirePressure</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">tirePressure</span> <span class="nf">wiperStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">wiperStatus</span><span class="p">;</span></code></pre> + <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">initWithAccelerationPedalPosition</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">accelerationPedalPosition</span> + <span class="nf">airbagStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">airbagStatus</span> + <span class="nf">beltStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">beltStatus</span> + <span class="nf">bodyInformation</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">bodyInformation</span> + <span class="nf">clusterModeStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">clusterModeStatus</span> + <span class="nf">deviceStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">deviceStatus</span> + <span class="nf">driverBraking</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">driverBraking</span> + <span class="nf">eCallInfo</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">eCallInfo</span> + <span class="nf">emergencyEvent</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">emergencyEvent</span> + <span class="nf">engineTorque</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">engineTorque</span> + <span class="nf">externalTemperature</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">externalTemperature</span> + <span class="nf">fuelLevel</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">fuelLevel</span> + <span class="nf">fuelLevelState</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">fuelLevelState</span> + <span class="nf">gps</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">gps</span> + <span class="nf">headLampStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">headLampStatus</span> + <span class="nf">instantFuelConsumption</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">instantFuelConsumption</span> + <span class="nf">myKey</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">myKey</span> + <span class="nf">odometer</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">odometer</span> + <span class="nf">prndl</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">prndl</span> + <span class="nf">rpm</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">rpm</span> + <span class="nf">speed</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">speed</span> + <span class="nf">steeringWheelAngle</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">steeringWheelAngle</span> + <span class="nf">tirePressure</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">tirePressure</span> + <span class="nf">wiperStatus</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">wiperStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -65,12 +89,67 @@ + <h4>Parameters</h4> + <dl> + <dt>accelerationPedalPosition</dt> + <dd><p>Subcribe to accelerationPedalPosition</p></dd> + <dt>airbagStatus</dt> + <dd><p>Subcribe to airbagStatus</p></dd> + <dt>beltStatus</dt> + <dd><p>Subcribe to beltStatus</p></dd> + <dt>bodyInformation</dt> + <dd><p>Subcribe to bodyInformation</p></dd> + <dt>clusterModeStatus</dt> + <dd><p>Subcribe to clusterModeStatus</p></dd> + <dt>deviceStatus</dt> + <dd><p>Subcribe to deviceStatus</p></dd> + <dt>driverBraking</dt> + <dd><p>Subcribe to driverBraking</p></dd> + <dt>eCallInfo</dt> + <dd><p>Subcribe to eCallInfo</p></dd> + <dt>emergencyEvent</dt> + <dd><p>Subcribe to v</p></dd> + <dt>engineTorque</dt> + <dd><p>Subcribe to engineTorque</p></dd> + <dt>externalTemperature</dt> + <dd><p>Subcribe to externalTemperature</p></dd> + <dt>fuelLevel</dt> + <dd><p>Subcribe to fuelLevel</p></dd> + <dt>fuelLevelState</dt> + <dd><p>Subcribe to fuelLevelState</p></dd> + <dt>gps</dt> + <dd><p>Subcribe to gps</p></dd> + <dt>headLampStatus</dt> + <dd><p>Subcribe to headLampStatus</p></dd> + <dt>instantFuelConsumption</dt> + <dd><p>Subcribe to instantFuelConsumption</p></dd> + <dt>myKey</dt> + <dd><p>Subcribe to myKey</p></dd> + <dt>odometer</dt> + <dd><p>Subcribe to odometer</p></dd> + <dt>prndl</dt> + <dd><p>Subcribe to prndl</p></dd> + <dt>rpm</dt> + <dd><p>Subcribe to rpm</p></dd> + <dt>speed</dt> + <dd><p>Subcribe to speed</p></dd> + <dt>steeringWheelAngle</dt> + <dd><p>Subcribe to steeringWheelAngle</p></dd> + <dt>tirePressure</dt> + <dd><p>Subcribe to tirePressure</p></dd> + <dt>wiperStatus</dt> + <dd><p>Subcribe to wiperStatus</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-gps"> gps </h3> - <p>@abstract A boolean value. If true, subscribes Gps data</p> + <p>A boolean value. If true, subscribes Gps data</p> @@ -88,7 +167,7 @@ speed </h3> - <p>@abstract A boolean value. If true, subscribes speed data</p> + <p>A boolean value. If true, subscribes speed data</p> @@ -106,7 +185,7 @@ rpm </h3> - <p>@abstract A boolean value. If true, subscribes rpm data</p> + <p>A boolean value. If true, subscribes rpm data</p> @@ -124,7 +203,7 @@ fuelLevel </h3> - <p>@abstract A boolean value. If true, subscribes FuelLevel data</p> + <p>A boolean value. If true, subscribes FuelLevel data</p> @@ -142,7 +221,7 @@ fuelLevel_State </h3> - <p>@abstract A boolean value. If true, subscribes fuelLevel_State data</p> + <p>A boolean value. If true, subscribes fuelLevel_State data</p> @@ -161,7 +240,7 @@ instantFuelConsumption </h3> - <p>@abstract A boolean value. If true, subscribes instantFuelConsumption data</p> + <p>A boolean value. If true, subscribes instantFuelConsumption data</p> @@ -180,7 +259,7 @@ externalTemperature </h3> - <p>@abstract A boolean value. If true, subscribes externalTemperature data</p> + <p>A boolean value. If true, subscribes externalTemperature data</p> @@ -199,7 +278,7 @@ prndl </h3> - <p>@abstract A boolean value. If true, subscribes Currently selected gear data</p> + <p>A boolean value. If true, subscribes Currently selected gear data</p> @@ -217,7 +296,7 @@ tirePressure </h3> - <p>@abstract A boolean value. If true, subscribes tire pressure status data</p> + <p>A boolean value. If true, subscribes tire pressure status data</p> @@ -236,7 +315,7 @@ odometer </h3> - <p>@abstract A boolean value. If true, subscribes odometer data</p> + <p>A boolean value. If true, subscribes odometer data</p> @@ -254,7 +333,7 @@ beltStatus </h3> - <p>@abstract A boolean value. If true, subscribes belt Status data</p> + <p>A boolean value. If true, subscribes belt Status data</p> @@ -272,7 +351,7 @@ bodyInformation </h3> - <p>@abstract A boolean value. If true, subscribes body Information data</p> + <p>A boolean value. If true, subscribes body Information data</p> @@ -291,7 +370,7 @@ deviceStatus </h3> - <p>@abstract A boolean value. If true, subscribes device Status data</p> + <p>A boolean value. If true, subscribes device Status data</p> @@ -310,7 +389,7 @@ driverBraking </h3> - <p>@abstract A boolean value. If true, subscribes driver Braking data</p> + <p>A boolean value. If true, subscribes driver Braking data</p> @@ -329,7 +408,7 @@ wiperStatus </h3> - <p>@abstract A boolean value. If true, subscribes wiper Status data</p> + <p>A boolean value. If true, subscribes wiper Status data</p> @@ -348,7 +427,7 @@ headLampStatus </h3> - <p>@abstract A boolean value. If true, subscribes Head Lamp Status data</p> + <p>A boolean value. If true, subscribes Head Lamp Status data</p> @@ -367,7 +446,7 @@ engineTorque </h3> - <p>@abstract A boolean value. If true, subscribes Engine Torque data</p> + <p>A boolean value. If true, subscribes Engine Torque data</p> @@ -386,7 +465,7 @@ accPedalPosition </h3> - <p>@abstract A boolean value. If true, means the accPedalPosition data has been + <p>A boolean value. If true, means the accPedalPosition data has been subscribed.</p> @@ -406,7 +485,7 @@ subscribed.</p> steeringWheelAngle </h3> - <p>@abstract A boolean value. If true, means the steeringWheelAngle data has been + <p>A boolean value. If true, means the steeringWheelAngle data has been subscribed.</p> @@ -426,12 +505,12 @@ subscribed.</p> eCallInfo </h3> - <p>Undocumented</p> + <p>Subscribe to eCallInfo</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -444,12 +523,13 @@ subscribed.</p> airbagStatus </h3> - <p>Undocumented</p> + <p>Subscribe to airbagStatus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -462,12 +542,13 @@ subscribed.</p> emergencyEvent </h3> - <p>Undocumented</p> + <p>Subscribe to emergencyEvent</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -480,12 +561,13 @@ subscribed.</p> clusterModeStatus </h3> - <p>Undocumented</p> + <p>Subscribe to clusterModeStatus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -498,12 +580,12 @@ subscribed.</p> myKey </h3> - <p>Undocumented</p> + <p>Subscribe to myKey</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">myKey</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSubscribeVehicleDataResponse.html b/docs/Classes/SDLSubscribeVehicleDataResponse.html index 64177f10c..27a28e658 100644 --- a/docs/Classes/SDLSubscribeVehicleDataResponse.html +++ b/docs/Classes/SDLSubscribeVehicleDataResponse.html @@ -31,7 +31,7 @@ <h3>Overview</h3> -<p>Subscribe Vehicle Data Response is sent, when SDLSubscribeVehicleData has been called</p> +<p>Response to SDLSubscribeVehicleData</p> <p>Since SmartDeviceLink 2.0</p> @@ -41,7 +41,9 @@ gps </h3> - <p>@abstract A SDLVehicleDataResult* value. See GPSData.</p> + <p>The result of requesting to subscribe to the GPSData.</p> + +<p>Optional</p> @@ -59,7 +61,9 @@ speed </h3> - <p>@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour.</p> + <p>The result of requesting to subscribe to the vehicle speed in kilometers per hour.</p> + +<p>Optional</p> @@ -77,7 +81,9 @@ rpm </h3> - <p>@abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine.</p> + <p>The result of requesting to subscribe to the number of revolutions per minute of the engine.</p> + +<p>Optional</p> @@ -95,7 +101,9 @@ fuelLevel </h3> - <p>@abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage)</p> + <p>The result of requesting to subscribe to the fuel level in the tank (percentage)</p> + +<p>Optional</p> @@ -114,7 +122,9 @@ fuelLevel_State </h3> - <p>@abstract A SDLVehicleDataResult* value. The fuel level state.</p> + <p>The result of requesting to subscribe to the fuel level state.</p> + +<p>Optional</p> @@ -133,7 +143,9 @@ instantFuelConsumption </h3> - <p>@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres.</p> + <p>The result of requesting to subscribe to the instantaneous fuel consumption in microlitres.</p> + +<p>Optional</p> @@ -152,7 +164,9 @@ externalTemperature </h3> - <p>@abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius.</p> + <p>The result of requesting to subscribe to the external temperature in degrees celsius.</p> + +<p>Optional</p> @@ -171,7 +185,9 @@ prndl </h3> - <p>@abstract A SDLVehicleDataResult* value. See PRNDL.</p> + <p>The result of requesting to subscribe to the PRNDL status.</p> + +<p>Optional</p> @@ -189,7 +205,9 @@ tirePressure </h3> - <p>@abstract A SDLVehicleDataResult* value. See TireStatus.</p> + <p>The result of requesting to subscribe to the tireStatus.</p> + +<p>Optional</p> @@ -208,7 +226,9 @@ odometer </h3> - <p>@abstract A SDLVehicleDataResult* value. Odometer in km.</p> + <p>The result of requesting to subscribe to the odometer in km.</p> + +<p>Optional</p> @@ -227,7 +247,9 @@ beltStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the seat belts.</p> + <p>The result of requesting to subscribe to the status of the seat belts.</p> + +<p>Optional</p> @@ -246,7 +268,9 @@ bodyInformation </h3> - <p>@abstract A SDLVehicleDataResult* value. The body information including power modes.</p> + <p>The result of requesting to subscribe to the body information including power modes.</p> + +<p>Optional</p> @@ -265,7 +289,9 @@ deviceStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The device status including signal and battery strength.</p> + <p>The result of requesting to subscribe to the device status including signal and battery strength.</p> + +<p>Optional</p> @@ -284,7 +310,9 @@ driverBraking </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p> + <p>The result of requesting to subscribe to the status of the brake pedal.</p> + +<p>Optional</p> @@ -303,7 +331,9 @@ wiperStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the wipers.</p> + <p>The result of requesting to subscribe to the status of the wipers.</p> + +<p>Optional</p> @@ -322,7 +352,9 @@ headLampStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. Status of the head lamps.</p> + <p>The result of requesting to subscribe to the status of the head lamps.</p> + +<p>Optional</p> @@ -341,7 +373,9 @@ engineTorque </h3> - <p>@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants.</p> + <p>The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants.</p> + +<p>Optional</p> @@ -360,7 +394,9 @@ accPedalPosition </h3> - <p>@abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed)</p> + <p>The result of requesting to subscribe to the accelerator pedal position (percentage depressed)</p> + +<p>Optional</p> @@ -379,7 +415,9 @@ steeringWheelAngle </h3> - <p>@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg)</p> + <p>The result of requesting to subscribe to the current angle of the steering wheel (in deg)</p> + +<p>Optional</p> @@ -398,12 +436,15 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the emergency call info</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -416,12 +457,15 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the airbag status</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -434,12 +478,15 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the emergency event</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -452,12 +499,15 @@ clusterModes </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the cluster modes</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">clusterModes</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">clusterModes</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -470,12 +520,14 @@ myKey </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the myKey status</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSyncMsgVersion.html b/docs/Classes/SDLSyncMsgVersion.html index 5ebda3484..4be84b949 100644 --- a/docs/Classes/SDLSyncMsgVersion.html +++ b/docs/Classes/SDLSyncMsgVersion.html @@ -39,7 +39,7 @@ majorVersion </h3> - <p>@abstract The major version indicates versions that is not-compatible to previous versions</p> + <p>The major version indicates versions that is not-compatible to previous versions</p> <p>Required, Integer, 1 - 10</p> @@ -59,7 +59,7 @@ minorVersion </h3> - <p>@abstract The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p> + <p>The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p> <p>Required, Integer, 0 - 1000</p> @@ -79,7 +79,9 @@ patchVersion </h3> - <p>@abstract Optional, allows backward-compatible fixes to the API without increasing the minor version of the interface</p> + <p>Allows backward-compatible fixes to the API without increasing the minor version of the interface</p> + +<p>Optional, Integer, 0 - 1000</p> diff --git a/docs/Classes/SDLSystemCapability.html b/docs/Classes/SDLSystemCapability.html index b4911359e..c8f1b1441 100644 --- a/docs/Classes/SDLSystemCapability.html +++ b/docs/Classes/SDLSystemCapability.html @@ -18,9 +18,7 @@ <p>The systemCapabilityType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a <q>navigationCapability</q> should exist.</p> -<ul> -<li>First implemented in SDL Core v4.4</li> -</ul> +<p>First implemented in SDL Core v4.4</p> <section class="section task-group-section"> @@ -100,12 +98,13 @@ systemCapabilityType </h3> - <p>Undocumented</p> + <p>Used as a descriptor of what data to expect in this struct. The corresponding param to this enum should be included and the only other parameter included.</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span> <span class="n">systemCapabilityType</span></code></pre> + <pre class="highlight objective_c"><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:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span> <span class="n">_Nonnull</span> <span class="n">systemCapabilityType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -118,12 +117,13 @@ navigationCapability </h3> - <p>Undocumented</p> + <p>Describes extended capabilities for onboard navigation system</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLNavigationCapability.html">SDLNavigationCapability</a></span> <span class="o">*</span><span class="n">navigationCapability</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLNavigationCapability.html">SDLNavigationCapability</a></span> <span class="o">*</span><span class="n">navigationCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -136,12 +136,13 @@ phoneCapability </h3> - <p>Undocumented</p> + <p>Describes extended capabilities of the module’s phone feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLPhoneCapability.html">SDLPhoneCapability</a></span> <span class="o">*</span><span class="n">phoneCapability</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLPhoneCapability.html">SDLPhoneCapability</a></span> <span class="o">*</span><span class="n">phoneCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -154,12 +155,13 @@ videoStreamingCapability </h3> - <p>Undocumented</p> + <p>Describes extended capabilities of the module’s phone feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLVideoStreamingCapability.html">SDLVideoStreamingCapability</a></span> <span class="o">*</span><span class="n">videoStreamingCapability</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html">SDLVideoStreamingCapability</a></span> <span class="o">*</span><span class="n">videoStreamingCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -172,12 +174,13 @@ remoteControlCapability </h3> - <p>Undocumented</p> + <p>Describes extended capabilities of the module’s phone feature</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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/SDLRemoteControlCapabilities.html">SDLRemoteControlCapabilities</a></span> <span class="o">*</span><span class="n">remoteControlCapability</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html">SDLRemoteControlCapabilities</a></span> <span class="o">*</span><span class="n">remoteControlCapability</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLSystemCapabilityManager.html b/docs/Classes/SDLSystemCapabilityManager.html new file mode 100644 index 000000000..d39f534c7 --- /dev/null +++ b/docs/Classes/SDLSystemCapabilityManager.html @@ -0,0 +1,501 @@ +<h1>SDLSystemCapabilityManager Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-displayCapabilities">displayCapabilities</a></li> + <li><a href="#section-hmiCapabilities">hmiCapabilities</a></li> + <li><a href="#section-softButtonCapabilities">softButtonCapabilities</a></li> + <li><a href="#section-buttonCapabilities">buttonCapabilities</a></li> + <li><a href="#section-presetBankCapabilities">presetBankCapabilities</a></li> + <li><a href="#section-hmiZoneCapabilities">hmiZoneCapabilities</a></li> + <li><a href="#section-speechCapabilities">speechCapabilities</a></li> + <li><a href="#section-prerecordedSpeechCapabilities">prerecordedSpeechCapabilities</a></li> + <li><a href="#section-vrCapability">vrCapability</a></li> + <li><a href="#section-audioPassThruCapabilities">audioPassThruCapabilities</a></li> + <li><a href="#section-pcmStreamCapability">pcmStreamCapability</a></li> + <li><a href="#section-navigationCapability">navigationCapability</a></li> + <li><a href="#section-phoneCapability">phoneCapability</a></li> + <li><a href="#section-videoStreamingCapability">videoStreamingCapability</a></li> + <li><a href="#section-remoteControlCapability">remoteControlCapability</a></li> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithConnectionManager:">-initWithConnectionManager:</a></li> + <li><a href="#section--stop">-stop</a></li> + <li><a href="#section--updateCapabilityType:completionHandler:">-updateCapabilityType:completionHandler:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-displayCapabilities"> + displayCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLDisplayCapabilities + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</a></span> <span class="o">*</span><span class="n">displayCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">displayCapabilities</span><span class="p">:</span> <span class="nf">SDLDisplayCapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-hmiCapabilities"> + hmiCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLHMICapabilities + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLHMICapabilities.html">SDLHMICapabilities</a></span> <span class="o">*</span><span class="n">hmiCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">hmiCapabilities</span><span class="p">:</span> <span class="nf">SDLHMICapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-softButtonCapabilities"> + softButtonCapabilities + </h3> + + <p>If returned, the platform supports on-screen SoftButtons</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLSoftButtonCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLSoftButtonCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">softButtonCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-buttonCapabilities"> + buttonCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLButtonCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLButtonCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">buttonCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-presetBankCapabilities"> + presetBankCapabilities + </h3> + + <p>If returned, the platform supports custom on-screen Presets</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLPresetBankCapabilities + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</a></span> <span class="o">*</span><span class="n">presetBankCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">presetBankCapabilities</span><span class="p">:</span> <span class="nf">SDLPresetBankCapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-hmiZoneCapabilities"> + hmiZoneCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLHMIZoneCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLHMIZoneCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLHMIZoneCapabilities.h@T@SDLHMIZoneCapabilities">SDLHMIZoneCapabilities</a></span><span class="o">></span> <span class="o">*</span><span class="n">hmiZoneCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">hmiZoneCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLHMIZoneCapabilities.h@T@SDLHMIZoneCapabilities">SDLHMIZoneCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-speechCapabilities"> + speechCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLSpeechCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLSpeechCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="o">></span> <span class="o">*</span><span class="n">speechCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">speechCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-prerecordedSpeechCapabilities"> + prerecordedSpeechCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLPrerecordedSpeech + +</div> + +<p>Optional, Array of length 1 - 100, of SDLPrerecordedSpeech</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span><span class="o">></span> <span class="o">*</span><span class="n">prerecordedSpeechCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">prerecordedSpeechCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-vrCapability"> + vrCapability + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLVRCapabilities + +</div> + +<p>True if the head unit supports voice recognition; false if not.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">vrCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">vrCapability</span><span class="p">:</span> <span class="nf">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-audioPassThruCapabilities"> + audioPassThruCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAudioPassThruCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">audioPassThruCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">audioPassThruCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-pcmStreamCapability"> + pcmStreamCapability + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAudioPassThruCapabilities + +</div> + +<p>Optional, Array of length 1 - 100, of SDLAudioPassThruCapabilities</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span> <span class="o">*</span><span class="n">pcmStreamCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">pcmStreamCapability</span><span class="p">:</span> <span class="nf">SDLAudioPassThruCapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-navigationCapability"> + navigationCapability + </h3> + + <p>If returned, the platform supports navigation</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLNavigationCapability + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLNavigationCapability.html">SDLNavigationCapability</a></span> <span class="o">*</span><span class="n">navigationCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">navigationCapability</span><span class="p">:</span> <span class="nf">SDLNavigationCapability</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-phoneCapability"> + phoneCapability + </h3> + + <p>If returned, the platform supports making phone calls</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLPhoneCapability + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLPhoneCapability.html">SDLPhoneCapability</a></span> <span class="o">*</span><span class="n">phoneCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">phoneCapability</span><span class="p">:</span> <span class="nf">SDLPhoneCapability</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-videoStreamingCapability"> + videoStreamingCapability + </h3> + + <p>If returned, the platform supports video streaming</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLVideoStreamingCapability + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html">SDLVideoStreamingCapability</a></span> <span class="o">*</span><span class="n">videoStreamingCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">videoStreamingCapability</span><span class="p">:</span> <span class="nf">SDLVideoStreamingCapability</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-remoteControlCapability"> + remoteControlCapability + </h3> + + <p>If returned, the platform supports remote control capabilities</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLRemoteControlCapabilities + +</div> + +<p>Optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLRemoteControlCapabilities.html">SDLRemoteControlCapabilities</a></span> <span class="o">*</span><span class="n">remoteControlCapability</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">remoteControlCapability</span><span class="p">:</span> <span class="nf">SDLRemoteControlCapabilities</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--init"> + -init + </h3> + + <p>Init is unavailable. Dependencies must be injected using initWithConnectionManager:</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="n">init</span><span class="p">;</span></code></pre> + + + + + <div> + <h4>Return Value</h4> + <p>nil</p> + </div> + + <h3 id="section--initWithConnectionManager:"> + -initWithConnectionManager: + </h3> + + <p>Creates a new system capability manager with a specified connection manager</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">initWithConnectionManager</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">manager</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>manager</dt> + <dd><p>A connection manager to use to forward on RPCs</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An instance of SDLSystemCapabilityManager</p> + </div> + + <h3 id="section--stop"> + -stop + </h3> + + <p>Stops the manager. This method is used internally.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">stop</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">stop</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--updateCapabilityType:completionHandler:"> + -updateCapabilityType:completionHandler: + </h3> + + <p>Retrieves a capability type from the remote system. This function must be called in order to retrieve the values of <code><a href="../Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)navigationCapability">navigationCapability</a></code>, <code><a href="../Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)phoneCapability">phoneCapability</a></code>, <code><a href="../Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)videoStreamingCapability">videoStreamingCapability</a></code> and <code><a href="../Classes/SDLSystemCapabilityManager.html#/c:objc(cs)SDLSystemCapabilityManager(py)remoteControlCapability">remoteControlCapability</a></code>. If you do not call this method first, those values will be nil. After calling this method, assuming there is no error in the handler, you may retrieve the capability you requested from the manager within the handler.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">updateCapabilityType</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span><span class="p">)</span><span class="nv">type</span> + <span class="nf">completionHandler</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemCapabilityManager.h@T@SDLUpdateCapabilityHandler">SDLUpdateCapabilityHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">updateCapabilityType</span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span><span class="p">,</span> <span class="n">completionHandler</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSystemCapabilityManager.h@T@SDLUpdateCapabilityHandler">SDLUpdateCapabilityHandler</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>type</dt> + <dd><p>The type of capability to retrieve</p></dd> + <dt>handler</dt> + <dd><p>The handler to be called when the retrieval is complete</p></dd> + </dl> + +</section> diff --git a/docs/Classes/SDLTCPTransport.html b/docs/Classes/SDLTCPTransport.html deleted file mode 100644 index 07607af11..000000000 --- a/docs/Classes/SDLTCPTransport.html +++ /dev/null @@ -1,68 +0,0 @@ -<h1>SDLTCPTransport Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-socket">socket</a></li> - <li><a href="#section-hostName">hostName</a></li> - <li><a href="#section-portNumber">portNumber</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-socket"> - socket - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="n">_Nullable</span> <span class="n">CFSocketRef</span> <span class="n">socket</span></code></pre> - - - - - - <h3 id="section-hostName"> - hostName - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">hostName</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">hostName</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - - <h3 id="section-portNumber"> - portNumber - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">portNumber</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">portNumber</span><span class="p">:</span> <span class="nf">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLTTSChunk.html b/docs/Classes/SDLTTSChunk.html index 0e343ce91..7a40e59ab 100644 --- a/docs/Classes/SDLTTSChunk.html +++ b/docs/Classes/SDLTTSChunk.html @@ -21,28 +21,6 @@ <p>For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme"><a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a></a>.</p> -<p>Parameter List - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>text</td> - <td>String</td> - <td>Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the <q>type</q> field.</td> - <td>SmartDeviceLink 1.0</td> - </tr> - <tr> - <td>type</td> - <td>SpeechCapabilities</td> - <td>Indicates the type of information in the <q>text</q> field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). </td> - <td>SmartDeviceLink 1.0</td> - </tr> - </table></p> - <p>@since SmartDeviceLink 1.0</p> @@ -51,12 +29,13 @@ -initWithText:type: </h3> - <p>Undocumented</p> + <p>Initialize with text and a type</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithText</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">type</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="p">)</span><span class="nv">type</span><span class="p">;</span></code></pre> + <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">initWithText</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">text</span> + <span class="nf">type</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="p">)</span><span class="nv">type</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -64,17 +43,29 @@ + <h4>Parameters</h4> + <dl> + <dt>text</dt> + <dd><p>The string to be spoken</p></dd> + <dt>type</dt> + <dd><p>The type of text the string is</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+textChunksFromString:"> +textChunksFromString: </h3> - <p>Undocumented</p> + <p>Create TTS using text</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">textChunksFromString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">textChunksFromString</span><span class="p">:</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">string</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -82,17 +73,27 @@ + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The text chunk</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+sapiChunksFromString:"> +sapiChunksFromString: </h3> - <p>Undocumented</p> + <p>Create TTS using SAPI</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">sapiChunksFromString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">sapiChunksFromString</span><span class="p">:</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">string</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -100,17 +101,27 @@ + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The SAPI chunk</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+lhPlusChunksFromString:"> +lhPlusChunksFromString: </h3> - <p>Undocumented</p> + <p>Create TTS using LH Plus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">lhPlusChunksFromString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">lhPlusChunksFromString</span><span class="p">:</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">string</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -118,17 +129,27 @@ + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The LH Plus chunk</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+prerecordedChunksFromString:"> +prerecordedChunksFromString: </h3> - <p>Undocumented</p> + <p>Create TTS using prerecorded chunks</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">prerecordedChunksFromString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nf">prerecordedChunksFromString</span><span class="p">:</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">string</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -136,17 +157,26 @@ + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The prerecorded chunk</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-+silenceChunks"> +silenceChunks </h3> - <p>Undocumented</p> + <p>Create TTS using silence</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="n">silenceChunks</span><span class="p">;</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">SDLTTSChunk</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="n">silenceChunks</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -154,12 +184,16 @@ + <div> + <h4>Return Value</h4> + <p>The RPC</p> + </div> <h3 id="section-text"> text </h3> - <p>@abstract Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the <q>type</q> field.</p> + <p>Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the <q>type</q> field.</p> <p>Required, Max length 500</p> @@ -179,7 +213,7 @@ type </h3> - <p>@abstract The type of information in the <q>text</q> field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).</p> + <p>The type of information in the <q>text</q> field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).</p> <p>Required</p> diff --git a/docs/Classes/SDLTemperature.html b/docs/Classes/SDLTemperature.html index 37564345b..01d9931e7 100644 --- a/docs/Classes/SDLTemperature.html +++ b/docs/Classes/SDLTemperature.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Struct using in Remote Control representing a temperature.</p> <section class="section task-group-section"> @@ -36,7 +36,9 @@ unit </h3> - <p>@abstract Temperature Unit</p> + <p>Temperature Unit</p> + +<p>Required, float</p> @@ -54,9 +56,9 @@ value </h3> - <p>@abstract Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL</p> + <p>Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL.</p> -<p>FLoat value</p> +<p>Required, float</p> diff --git a/docs/Classes/SDLTextField.html b/docs/Classes/SDLTextField.html index 51ff3ca84..0d5b303a0 100644 --- a/docs/Classes/SDLTextField.html +++ b/docs/Classes/SDLTextField.html @@ -13,50 +13,6 @@ <p>Struct defining the characteristics of a displayed field on the HMI.</p> -<p>Parameter List - <table border="1" rules="all"> - <tr> - <th>Name</th> - <th>Type</th> - <th>Description</th> - <th>SmartDeviceLink Ver. Available</th> - </tr> - <tr> - <td>name</td> - <td>TextFieldName</td> - <td>Enumeration identifying the field. </td> - <td>SDL 1.0</td> - </tr> - <tr> - <td>characterSet</td> - <td>CharacterSet</td> - <td>The character set that is supported in this field. </td> - <td>SDL 1.0</td> - </tr> - <tr> - <td>width</td> - <td>Int16</td> - <td>The number of characters in one row of this field. - <ul> - <li>Minvalue=<q>1</q></li> - <li>maxvalue=<q>500</q></li> - </ul> - </td> - <td>SDL 1.0</td> - </tr> - <tr> - <td>rows</td> - <td>Int16</td> - <td>The number of rows for this text field. - <ul> - <li>Minvalue=<q>1</q></li> - <li>maxvalue=<q>3</q></li> - </ul> - </td> - <td>SDL 1.0</td> - </tr> - </table></p> - <p>@since SDL 1.0</p> @@ -65,7 +21,7 @@ name </h3> - <p>@abstract The enumeration identifying the field.</p> + <p>The enumeration identifying the field.</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLTextFieldName @@ -90,7 +46,7 @@ characterSet </h3> - <p>@abstract The character set that is supported in this field.</p> + <p>The character set that is supported in this field.</p> <div class="aside aside-see"> <p class="aside-title">See</p> SDLCharacterSet @@ -115,7 +71,7 @@ width </h3> - <p>@abstract The number of characters in one row of this field.</p> + <p>The number of characters in one row of this field.</p> <p>Required, Integer 1 - 500</p> @@ -135,7 +91,7 @@ rows </h3> - <p>@abstract The number of rows for this text field.</p> + <p>The number of rows for this text field.</p> <p>Required, Integer 1 - 8</p> diff --git a/docs/Classes/SDLTireStatus.html b/docs/Classes/SDLTireStatus.html index 604e1479a..9bf044120 100644 --- a/docs/Classes/SDLTireStatus.html +++ b/docs/Classes/SDLTireStatus.html @@ -14,7 +14,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Struct used in Vehicle Data; the status and pressure of the tires.</p> <section class="section task-group-section"> @@ -22,12 +22,15 @@ pressureTelltale </h3> - <p>Undocumented</p> + <p>Status of the Tire Pressure Telltale. See WarningLightStatus.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLWarningLightStatus.h@T@SDLWarningLightStatus">SDLWarningLightStatus</a></span> <span class="n">pressureTelltale</span></code></pre> + <pre class="highlight objective_c"><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:SDLWarningLightStatus.h@T@SDLWarningLightStatus">SDLWarningLightStatus</a></span> <span class="n">_Nonnull</span> <span class="n">pressureTelltale</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -40,12 +43,14 @@ leftFront </h3> - <p>Undocumented</p> + <p>The status of the left front tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">leftFront</span></code></pre> + <pre class="highlight objective_c"><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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">leftFront</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -58,12 +63,15 @@ rightFront </h3> - <p>Undocumented</p> + <p>The status of the right front tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">rightFront</span></code></pre> + <pre class="highlight objective_c"><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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rightFront</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -76,12 +84,14 @@ leftRear </h3> - <p>Undocumented</p> + <p>The status of the left rear tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">leftRear</span></code></pre> + <pre class="highlight objective_c"><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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">leftRear</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -94,12 +104,14 @@ rightRear </h3> - <p>Undocumented</p> + <p>The status of the right rear tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">rightRear</span></code></pre> + <pre class="highlight objective_c"><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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rightRear</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -112,12 +124,15 @@ innerLeftRear </h3> - <p>Undocumented</p> + <p>The status of the inner left rear tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">innerLeftRear</span></code></pre> + <pre class="highlight objective_c"><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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">innerLeftRear</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -130,12 +145,15 @@ innerRightRear </h3> - <p>Undocumented</p> + <p>The status of the innter right rear tire.</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">innerRightRear</span></code></pre> + <pre class="highlight objective_c"><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/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">innerRightRear</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLTouchCoord.html b/docs/Classes/SDLTouchCoord.html index cb0a08204..f84d5c54c 100644 --- a/docs/Classes/SDLTouchCoord.html +++ b/docs/Classes/SDLTouchCoord.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The coordinate of a touch, used in a touch event</p> <section class="section task-group-section"> @@ -17,12 +17,14 @@ x </h3> - <p>Undocumented</p> + <p>The x value of the touch coordinate</p> + +<p>Required, float 0 - 10000</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">x</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">x</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +37,14 @@ y </h3> - <p>Undocumented</p> + <p>The y value of the touch coordinate</p> + +<p>Required, float 0 - 10000</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">y</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">y</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLTouchEvent.html b/docs/Classes/SDLTouchEvent.html index 70cbc0f2b..5c4fbf680 100644 --- a/docs/Classes/SDLTouchEvent.html +++ b/docs/Classes/SDLTouchEvent.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A touch which occurred on the IVI system during projection</p> <section class="section task-group-section"> @@ -18,11 +18,13 @@ touchEventId </h3> - <p>A touch’s unique identifier. The application can track the current touch events by id. -If a touch event has type begin, the id should be added to the set of touches. -If a touch event has type end, the id should be removed from the set of touches.</p> + <p>A touch’s unique identifier. The application can track the current touch events by id.</p> -<p>Mandatory, 0-9</p> +<p>If a touch event has type begin, the id should be added to the set of touches.</p> + +<p>If a touch event has type end, the id should be removed from the set of touches.</p> + +<p>Required, 0-9</p> @@ -40,7 +42,7 @@ If a touch event has type end, the id should be removed from the set of touches. timeStamp </h3> - <p>The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p> + <p>The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds.</p> <p>The timestamp is used to determined the rate of change of position of a touch.</p> @@ -48,7 +50,7 @@ If a touch event has type end, the id should be removed from the set of touches. <p>If there is only a single timestamp in this array, it is the same for every coordinate in the coordinates array.</p> -<p>Mandatory, array size 1-1000, contains <NSNumber> size 0-5000000000</p> +<p>Required, array size 1-1000, contains integer value 0-2000000000</p> @@ -67,7 +69,9 @@ If a touch event has type end, the id should be removed from the set of touches. coord </h3> - <p>Mandatory, array size 1-1000, contains SDLTouchCoord</p> + <p>The touch’s coordinate</p> + +<p>Required, array size 1-1000</p> diff --git a/docs/Classes/SDLTouchEventCapabilities.html b/docs/Classes/SDLTouchEventCapabilities.html index 611ec23bd..1cea98a5d 100644 --- a/docs/Classes/SDLTouchEventCapabilities.html +++ b/docs/Classes/SDLTouchEventCapabilities.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>The capabilities of touches during projection applications</p> <section class="section task-group-section"> @@ -18,12 +18,13 @@ pressAvailable </h3> - <p>Undocumented</p> + <p>Whether or not long presses are available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">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">pressAvailable</span></code></pre> + <pre class="highlight objective_c"><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">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">pressAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -36,12 +37,13 @@ multiTouchAvailable </h3> - <p>Undocumented</p> + <p>Whether or not multi-touch (e.g. a pinch gesture) is available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">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">multiTouchAvailable</span></code></pre> + <pre class="highlight objective_c"><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">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">multiTouchAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +56,13 @@ doublePressAvailable </h3> - <p>Undocumented</p> + <p>Whether or not a double tap is available</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">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">doublePressAvailable</span></code></pre> + <pre class="highlight objective_c"><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">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">doublePressAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLTurn.html b/docs/Classes/SDLTurn.html index bb75760e0..cf746905b 100644 --- a/docs/Classes/SDLTurn.html +++ b/docs/Classes/SDLTurn.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A struct used in UpdateTurnList for Turn-by-Turn navigation applications</p> <section class="section task-group-section"> @@ -36,12 +36,12 @@ navigationText </h3> - <p>Undocumented</p> + <p>Individual turn text. Must provide at least text or icon for a given turn</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -54,12 +54,12 @@ turnIcon </h3> - <p>Undocumented</p> + <p>Individual turn icon. Must provide at least text or icon for a given turn</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLUnsubscribeButton.html b/docs/Classes/SDLUnsubscribeButton.html index 57bc4c1ad..1adfc6d8d 100644 --- a/docs/Classes/SDLUnsubscribeButton.html +++ b/docs/Classes/SDLUnsubscribeButton.html @@ -45,7 +45,7 @@ See SDLSubscribeButton</p> buttonName </h3> - <p>@abstract A name of the button to unsubscribe from + <p>A name of the button to unsubscribe from @discussion An Enumeration value, see <i> SDLButtonName</i></p> diff --git a/docs/Classes/SDLUnsubscribeVehicleData.html b/docs/Classes/SDLUnsubscribeVehicleData.html index 861bb874c..48917bfd4 100644 --- a/docs/Classes/SDLUnsubscribeVehicleData.html +++ b/docs/Classes/SDLUnsubscribeVehicleData.html @@ -67,7 +67,7 @@ gps </h3> - <p>@abstract A boolean value. If true, unsubscribes Gps data</p> + <p>A boolean value. If true, unsubscribes Gps data</p> @@ -85,7 +85,7 @@ speed </h3> - <p>@abstract A boolean value. If true, unsubscribes speed data</p> + <p>A boolean value. If true, unsubscribes speed data</p> @@ -103,7 +103,7 @@ rpm </h3> - <p>@abstract A boolean value. If true, unsubscribe data</p> + <p>A boolean value. If true, unsubscribe data</p> @@ -121,7 +121,7 @@ fuelLevel </h3> - <p>@abstract A boolean value. If true, unsubscribes FuelLevel data</p> + <p>A boolean value. If true, unsubscribes FuelLevel data</p> @@ -139,7 +139,7 @@ fuelLevel_State </h3> - <p>@abstract A boolean value. If true, unsubscribes fuelLevel_State data</p> + <p>A boolean value. If true, unsubscribes fuelLevel_State data</p> @@ -158,7 +158,7 @@ instantFuelConsumption </h3> - <p>@abstract A boolean value. If true, unsubscribes instantFuelConsumption data</p> + <p>A boolean value. If true, unsubscribes instantFuelConsumption data</p> @@ -177,7 +177,7 @@ externalTemperature </h3> - <p>@abstract A boolean value. If true, unsubscribes externalTemperature data</p> + <p>A boolean value. If true, unsubscribes externalTemperature data</p> @@ -196,7 +196,7 @@ prndl </h3> - <p>@abstract A boolean value. If true, unsubscribes Currently selected gear data</p> + <p>A boolean value. If true, unsubscribes Currently selected gear data</p> @@ -214,7 +214,7 @@ tirePressure </h3> - <p>@abstract A boolean value. If true, unsubscribes tire pressure status data</p> + <p>A boolean value. If true, unsubscribes tire pressure status data</p> @@ -233,7 +233,7 @@ odometer </h3> - <p>@abstract A boolean value. If true, unsubscribes odometer data</p> + <p>A boolean value. If true, unsubscribes odometer data</p> @@ -251,7 +251,7 @@ beltStatus </h3> - <p>@abstract A boolean value. If true, unsubscribes belt Status data</p> + <p>A boolean value. If true, unsubscribes belt Status data</p> @@ -269,7 +269,7 @@ bodyInformation </h3> - <p>@abstract A boolean value. If true, unsubscribes body Information data</p> + <p>A boolean value. If true, unsubscribes body Information data</p> @@ -288,7 +288,7 @@ deviceStatus </h3> - <p>@abstract A boolean value. If true, unsubscribes device Status data</p> + <p>A boolean value. If true, unsubscribes device Status data</p> @@ -307,7 +307,7 @@ driverBraking </h3> - <p>@abstract A boolean value. If true, unsubscribes driver Braking data</p> + <p>A boolean value. If true, unsubscribes driver Braking data</p> @@ -326,7 +326,7 @@ wiperStatus </h3> - <p>@abstract A boolean value. If true, unsubscribes wiper Status data</p> + <p>A boolean value. If true, unsubscribes wiper Status data</p> @@ -345,7 +345,7 @@ headLampStatus </h3> - <p>@abstract A boolean value. If true, unsubscribes Head Lamp Status data</p> + <p>A boolean value. If true, unsubscribes Head Lamp Status data</p> @@ -364,7 +364,7 @@ engineTorque </h3> - <p>@abstract A boolean value. If true, unsubscribes Engine Torque data</p> + <p>A boolean value. If true, unsubscribes Engine Torque data</p> @@ -383,7 +383,7 @@ accPedalPosition </h3> - <p>@abstract A boolean value. If true, unsubscribes accPedalPosition data</p> + <p>A boolean value. If true, unsubscribes accPedalPosition data</p> @@ -402,12 +402,13 @@ steeringWheelAngle </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from steeringWheelAngle</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">steeringWheelAngle</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">steeringWheelAngle</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -420,12 +421,12 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from eCallInfo</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -438,12 +439,13 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from airbagStatus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -456,12 +458,13 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from emergencyEvent</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -474,12 +477,13 @@ clusterModeStatus </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from clusterModeStatus</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">clusterModeStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">clusterModeStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -492,12 +496,12 @@ myKey </h3> - <p>Undocumented</p> + <p>If true, unsubscribes from myKey</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</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">myKey</span></code></pre> + <pre class="highlight objective_c"><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">nullable</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">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLUnsubscribeVehicleDataResponse.html b/docs/Classes/SDLUnsubscribeVehicleDataResponse.html index a87a00161..5dcee9d1e 100644 --- a/docs/Classes/SDLUnsubscribeVehicleDataResponse.html +++ b/docs/Classes/SDLUnsubscribeVehicleDataResponse.html @@ -31,9 +31,9 @@ <h3>Overview</h3> -<p>Unsubscribe Vehicle Data Response is sent, when UnsubscribeVehicleData has been called</p> +<p>Response to UnsubscribeVehicleData</p> -<p>@since SmartDeviceLink 2.0</p> +<p>since SmartDeviceLink 2.0</p> <section class="section task-group-section"> @@ -41,7 +41,9 @@ gps </h3> - <p>@abstract A SDLVehicleDataResult* value. See GPSData.</p> + <p>The result of requesting to subscribe to the GPSData.</p> + +<p>Optional</p> @@ -59,7 +61,9 @@ speed </h3> - <p>@abstract A SDLVehicleDataResult* value. The vehicle speed in kilometers per hour.</p> + <p>The result of requesting to subscribe to the vehicle speed in kilometers per hour.</p> + +<p>Optional</p> @@ -77,7 +81,9 @@ rpm </h3> - <p>@abstract A SDLVehicleDataResult* value. The number of revolutions per minute of the engine.</p> + <p>The result of requesting to subscribe to the number of revolutions per minute of the engine.</p> + +<p>Optional</p> @@ -95,7 +101,9 @@ fuelLevel </h3> - <p>@abstract A SDLVehicleDataResult* value. The fuel level in the tank (percentage)</p> + <p>The result of requesting to subscribe to the fuel level in the tank (percentage)</p> + +<p>Optional</p> @@ -114,7 +122,9 @@ fuelLevel_State </h3> - <p>@abstract A SDLVehicleDataResult* value. The fuel level state.</p> + <p>The result of requesting to subscribe to the fuel level state.</p> + +<p>Optional</p> @@ -133,7 +143,9 @@ instantFuelConsumption </h3> - <p>@abstract A SDLVehicleDataResult* value. The instantaneous fuel consumption in microlitres.</p> + <p>The result of requesting to subscribe to the instantaneous fuel consumption in microlitres.</p> + +<p>Optional</p> @@ -152,7 +164,9 @@ externalTemperature </h3> - <p>@abstract A SDLVehicleDataResult* value. The external temperature in degrees celsius.</p> + <p>The result of requesting to subscribe to the external temperature in degrees celsius.</p> + +<p>Optional</p> @@ -171,7 +185,9 @@ prndl </h3> - <p>@abstract A SDLVehicleDataResult* value. See PRNDL.</p> + <p>The result of requesting to subscribe to the PRNDL status.</p> + +<p>Optional</p> @@ -189,7 +205,9 @@ tirePressure </h3> - <p>@abstract A SDLVehicleDataResult* value. See TireStatus.</p> + <p>The result of requesting to subscribe to the tireStatus.</p> + +<p>Optional</p> @@ -208,7 +226,9 @@ odometer </h3> - <p>@abstract A SDLVehicleDataResult* value. Odometer in km.</p> + <p>The result of requesting to subscribe to the odometer in km.</p> + +<p>Optional</p> @@ -227,7 +247,9 @@ beltStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the seat belts.</p> + <p>The result of requesting to subscribe to the status of the seat belts.</p> + +<p>Optional</p> @@ -246,7 +268,9 @@ bodyInformation </h3> - <p>@abstract A SDLVehicleDataResult* value. The body information including power modes.</p> + <p>The result of requesting to subscribe to the body information including power modes.</p> + +<p>Optional</p> @@ -265,7 +289,9 @@ deviceStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The device status including signal and battery strength.</p> + <p>The result of requesting to subscribe to the device status including signal and battery strength.</p> + +<p>Optional</p> @@ -284,7 +310,9 @@ driverBraking </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the brake pedal.</p> + <p>The result of requesting to subscribe to the status of the brake pedal.</p> + +<p>Optional</p> @@ -303,7 +331,9 @@ wiperStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. The status of the wipers.</p> + <p>The result of requesting to subscribe to the status of the wipers.</p> + +<p>Optional</p> @@ -322,7 +352,9 @@ headLampStatus </h3> - <p>@abstract A SDLVehicleDataResult* value. Status of the head lamps.</p> + <p>The result of requesting to subscribe to the status of the head lamps.</p> + +<p>Optional</p> @@ -341,7 +373,9 @@ engineTorque </h3> - <p>@abstract A SDLVehicleDataResult* value. Torque value for engine (in Nm) on non-diesel variants.</p> + <p>The result of requesting to subscribe to the torque value for engine (in Nm) on non-diesel variants.</p> + +<p>Optional</p> @@ -360,7 +394,9 @@ accPedalPosition </h3> - <p>@abstract A SDLVehicleDataResult* value. Accelerator pedal position (percentage depressed)</p> + <p>The result of requesting to subscribe to the accelerator pedal position (percentage depressed)</p> + +<p>Optional</p> @@ -379,7 +415,9 @@ steeringWheelAngle </h3> - <p>@abstract A SDLVehicleDataResult* value. Current angle of the steering wheel (in deg)</p> + <p>The result of requesting to subscribe to the current angle of the steering wheel (in deg)</p> + +<p>Optional</p> @@ -398,12 +436,15 @@ eCallInfo </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the emergency call info</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">eCallInfo</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">eCallInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -416,12 +457,15 @@ airbagStatus </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the airbag status</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">airbagStatus</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">airbagStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -434,12 +478,15 @@ emergencyEvent </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the emergency event</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">emergencyEvent</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">emergencyEvent</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -452,12 +499,15 @@ clusterModes </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the cluster modes</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">clusterModes</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">clusterModes</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -470,12 +520,14 @@ myKey </h3> - <p>Undocumented</p> + <p>The result of requesting to subscribe to the myKey status</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">myKey</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">myKey</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLVRHelpItem.html b/docs/Classes/SDLVRHelpItem.html index db425ad47..2cce1bf92 100644 --- a/docs/Classes/SDLVRHelpItem.html +++ b/docs/Classes/SDLVRHelpItem.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>A help item for voice commands, used locally in interaction lists and globally</p> <section class="section task-group-section"> @@ -56,12 +56,14 @@ text </h3> - <p>Undocumented</p> + <p>Text to display for VR Help item</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSString</span> <span class="o">*</span><span class="n">text</span></code></pre> + <pre class="highlight objective_c"><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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">text</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -74,12 +76,14 @@ image </h3> - <p>Undocumented</p> + <p>Image for VR Help item</p> + +<p>Optional</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span></code></pre> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -92,12 +96,14 @@ position </h3> - <p>Undocumented</p> + <p>Position to display item in VR Help list</p> + +<p>Required</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">position</span></code></pre> + <pre class="highlight objective_c"><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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">position</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLVehicleDataResult.html b/docs/Classes/SDLVehicleDataResult.html index 940601085..ccd06fd55 100644 --- a/docs/Classes/SDLVehicleDataResult.html +++ b/docs/Classes/SDLVehicleDataResult.html @@ -9,7 +9,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Individual published data request result</p> <section class="section task-group-section"> @@ -17,12 +17,12 @@ dataType </h3> - <p>Undocumented</p> + <p>Defined published data element type</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataType.h@T@SDLVehicleDataType">SDLVehicleDataType</a></span> <span class="n">dataType</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataType.h@T@SDLVehicleDataType">SDLVehicleDataType</a></span> <span class="n">_Nonnull</span> <span class="n">dataType</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -35,12 +35,13 @@ resultCode </h3> - <p>Undocumented</p> + <p>Published data result code</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@property</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:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">resultCode</span></code></pre> + <pre class="highlight objective_c"><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:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">_Nonnull</span> <span class="n">resultCode</span><span class="p">;</span></code></pre> <h4>Swift</h4> diff --git a/docs/Classes/SDLVehicleType.html b/docs/Classes/SDLVehicleType.html index be590d28d..8be4b3e9e 100644 --- a/docs/Classes/SDLVehicleType.html +++ b/docs/Classes/SDLVehicleType.html @@ -21,9 +21,9 @@ make </h3> - <p>@abstract The make of the vehicle</p> + <p>The make of the vehicle</p> -<p>@discussion For example, <q>Ford</q>, <q>Lincoln</q>, etc.</p> +<p>For example, <q>Ford</q>, <q>Lincoln</q>, etc.</p> <p>Optional, Max String length 500 chars</p> @@ -43,9 +43,9 @@ model </h3> - <p>@abstract The model of the vehicle</p> + <p>The model of the vehicle</p> -<p>@discussion For example, <q>Fiesta</q>, <q>Focus</q>, etc.</p> +<p>For example, <q>Fiesta</q>, <q>Focus</q>, etc.</p> <p>Optional, Max String length 500 chars</p> @@ -65,9 +65,9 @@ modelYear </h3> - <p>@abstract The model year of the vehicle</p> + <p>The model year of the vehicle</p> -<p>@discussion For example, <q>2013</q></p> +<p>For example, <q>2013</q></p> <p>Optional, Max String length 500 chars</p> @@ -87,9 +87,9 @@ trim </h3> - <p>@abstract The trim of the vehicle</p> + <p>The trim of the vehicle</p> -<p>@discussion For example, <q>SE</q>, <q>SEL</q></p> +<p>For example, <q>SE</q>, <q>SEL</q></p> <p>Optional, Max String length 500 chars</p> diff --git a/docs/Classes/SDLVideoStreamingCapability.html b/docs/Classes/SDLVideoStreamingCapability.html index ddb74e1d6..39ac3ed7c 100644 --- a/docs/Classes/SDLVideoStreamingCapability.html +++ b/docs/Classes/SDLVideoStreamingCapability.html @@ -12,7 +12,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>Contains information about this system’s video streaming capabilities</p> <section class="section task-group-section"> @@ -38,7 +38,9 @@ preferredResolution </h3> - <p>@abstract The preferred resolution of a video stream for decoding and rendering on HMI, optional</p> + <p>The preferred resolution of a video stream for decoding and rendering on HMI</p> + +<p>Optional</p> @@ -57,11 +59,9 @@ maxBitrate </h3> - <p>@abstract The maximum bitrate of video stream that is supported, in kbps, optional</p> - -<p>minvalue= 0</p> + <p>The maximum bitrate of video stream that is supported, in kbps, optional</p> -<p>maxvalue= 2147483647</p> +<p>Optional, minvalue= 0, maxvalue= 2147483647</p> @@ -79,7 +79,9 @@ supportedFormats </h3> - <p>@abstract Detailed information on each format supported by this system, in its preferred order, optional</p> + <p>Detailed information on each format supported by this system, in its preferred order</p> + +<p>Optional</p> @@ -100,6 +102,8 @@ <p>True if the system can utilize the haptic spatial data from the source being streamed.</p> +<p>Optional</p> + <h4>Objective-C</h4> diff --git a/docs/Classes/SDLVideoStreamingFormat.html b/docs/Classes/SDLVideoStreamingFormat.html index 4c31d582e..219ce68cb 100644 --- a/docs/Classes/SDLVideoStreamingFormat.html +++ b/docs/Classes/SDLVideoStreamingFormat.html @@ -10,7 +10,7 @@ <h3>Overview</h3> -<p>Undocumented</p> +<p>An available format for video streaming in projection applications</p> <section class="section task-group-section"> @@ -18,7 +18,9 @@ protocol </h3> - <p>@abstract Protocol type, see VideoStreamingProtocol, mandatory</p> + <p>Protocol type, see VideoStreamingProtocol</p> + +<p>Required</p> @@ -37,7 +39,9 @@ codec </h3> - <p>@abstract Codec type, see VideoStreamingCodec, mandatory</p> + <p>Codec type, see VideoStreamingCodec</p> + +<p>Required</p> diff --git a/docs/Classes/SDLVoiceCommand.html b/docs/Classes/SDLVoiceCommand.html new file mode 100644 index 000000000..665331e0b --- /dev/null +++ b/docs/Classes/SDLVoiceCommand.html @@ -0,0 +1,73 @@ +<h1>SDLVoiceCommand Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-voiceCommands">voiceCommands</a></li> + <li><a href="#section-handler">handler</a></li> + <li><a href="#section--initWithVoiceCommands:handler:">-initWithVoiceCommands:handler:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-voiceCommands"> + voiceCommands + </h3> + + <p>The strings the user can say to activate this 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">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">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">voiceCommands</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">voiceCommands</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="p">}</span></code></pre> + + + + + <h3 id="section-handler"> + handler + </h3> + + <p>The handler that will be called when the command is activated</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">handler</span><span class="p">:</span> <span class="nf">SDLVoiceCommandSelectionHandler</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--initWithVoiceCommands:handler:"> + -initWithVoiceCommands:handler: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithVoiceCommands</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</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">voiceCommands</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">],</span> <span class="nv">handler</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">)</span></code></pre> + + + + +</section> |