diff options
Diffstat (limited to 'docs/Classes')
201 files changed, 3548 insertions, 1503 deletions
diff --git a/docs/Classes/SDLAbstractProtocol.html b/docs/Classes/SDLAbstractProtocol.html index d1f7d3dac..bbf903d4d 100644 --- a/docs/Classes/SDLAbstractProtocol.html +++ b/docs/Classes/SDLAbstractProtocol.html @@ -10,12 +10,14 @@ <li><a href="#section-appId">appId</a></li> <li><a href="#section--sendStartSessionWithType:">-sendStartSessionWithType:</a></li> <li><a href="#section--startServiceWithType:">-startServiceWithType:</a></li> + <li><a href="#section--startServiceWithType:payload:">-startServiceWithType:payload:</a></li> <li><a href="#section--startSecureServiceWithType:completionHandler:">-startSecureServiceWithType:completionHandler:</a></li> + <li><a href="#section--startSecureServiceWithType:payload:completionHandler:">-startSecureServiceWithType:payload:completionHandler:</a></li> <li><a href="#section--sendEndSessionWithType:">-sendEndSessionWithType:</a></li> <li><a href="#section--endServiceWithType:">-endServiceWithType:</a></li> + <li><a href="#section--sendRPCRequest:">-sendRPCRequest:</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--sendRPCRequest:">-sendRPCRequest:</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--sendRawDataStream:withServiceType:">-sendRawDataStream:withServiceType:</a></li> @@ -107,6 +109,17 @@ + <h3 id="section--startServiceWithType:payload:"> + -startServiceWithType:payload: + </h3> + + <p>Undocumented</p> + + + + + + <h3 id="section--startSecureServiceWithType:completionHandler:"> -startSecureServiceWithType:completionHandler: </h3> @@ -118,6 +131,17 @@ + <h3 id="section--startSecureServiceWithType:payload:completionHandler:"> + -startSecureServiceWithType:payload:completionHandler: + </h3> + + <p>Undocumented</p> + + + + + + <h3 id="section--sendEndSessionWithType:"> -sendEndSessionWithType: </h3> @@ -140,8 +164,8 @@ - <h3 id="section--sendRPC:"> - -sendRPC: + <h3 id="section--sendRPCRequest:"> + -sendRPCRequest: </h3> <p>Undocumented</p> @@ -151,8 +175,8 @@ - <h3 id="section--sendRPC:encrypted:error:"> - -sendRPC:encrypted:error: + <h3 id="section--sendRPC:"> + -sendRPC: </h3> <p>Undocumented</p> @@ -162,8 +186,8 @@ - <h3 id="section--sendRPCRequest:"> - -sendRPCRequest: + <h3 id="section--sendRPC:encrypted:error:"> + -sendRPC:encrypted:error: </h3> <p>Undocumented</p> diff --git a/docs/Classes/SDLAddCommand.html b/docs/Classes/SDLAddCommand.html index 742fadfa7..b55a80898 100644 --- a/docs/Classes/SDLAddCommand.html +++ b/docs/Classes/SDLAddCommand.html @@ -38,7 +38,6 @@ <p>HMILevel needs to be FULL, LIMITED or BACKGROUD</p> <p>@since SDL 1.0</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeleteCommand SDLAddSubMenu SDLDeleteSubMenu @@ -85,13 +84,11 @@ <h4>Parameters</h4> <dl> <dt>handler</dt> - <dd><p>A callback that will be called when a button event occurs for the command</p> -</dd> + <dd><p>A callback that will be called when a button event occurs for the command</p></dd> </dl> <div> <h4>Return Value</h4> <p>An SDLAddCommand object</p> - </div> <h3 id="section--initWithDictionary:"> @@ -114,8 +111,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithId:vrCommands:handler:"> @@ -127,7 +123,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommand</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span> <span class="o"><</span><span class="n"><a href="../Protocols/SDLRequestHandler.html">SDLRequestHandler</a></span><span class="o">></span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommand</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o"><</span><span class="n"><a href="../Protocols/SDLRequestHandler.html">SDLRequestHandler</a></span><span class="o">></span></code></pre> @@ -142,7 +138,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommand</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span> <span class="o"><</span><span class="n"><a href="../Protocols/SDLRequestHandler.html">SDLRequestHandler</a></span><span class="o">></span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommand</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o"><</span><span class="n"><a href="../Protocols/SDLRequestHandler.html">SDLRequestHandler</a></span><span class="o">></span></code></pre> @@ -157,7 +153,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommand</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span> <span class="o"><</span><span class="n"><a href="../Protocols/SDLRequestHandler.html">SDLRequestHandler</a></span><span class="o">></span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommand</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o"><</span><span class="n"><a href="../Protocols/SDLRequestHandler.html">SDLRequestHandler</a></span><span class="o">></span></code></pre> @@ -168,7 +164,6 @@ </h3> <p>A handler that will let you know when the button you created is subscribed.</p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> This will only work if you use SDLManager. diff --git a/docs/Classes/SDLAddCommandResponse.html b/docs/Classes/SDLAddCommandResponse.html index 9408d0b95..72ff1f951 100644 --- a/docs/Classes/SDLAddCommandResponse.html +++ b/docs/Classes/SDLAddCommandResponse.html @@ -24,7 +24,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommandResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommandResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +39,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommandResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddCommandResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLAddSubMenu.html b/docs/Classes/SDLAddSubMenu.html index f9600ae12..6f471313b 100644 --- a/docs/Classes/SDLAddSubMenu.html +++ b/docs/Classes/SDLAddSubMenu.html @@ -67,8 +67,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithId:menuName:"> @@ -80,7 +79,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddSubMenu</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddSubMenu</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -95,7 +94,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddSubMenu</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddSubMenu</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLAddSubMenuResponse.html b/docs/Classes/SDLAddSubMenuResponse.html index eb288793d..3ee1ed84e 100644 --- a/docs/Classes/SDLAddSubMenuResponse.html +++ b/docs/Classes/SDLAddSubMenuResponse.html @@ -23,7 +23,7 @@ Since <b>SmartDeviceLink 1.0</b></p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddSubMenuResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddSubMenuResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -38,7 +38,7 @@ Since <b>SmartDeviceLink 1.0</b></p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddSubMenuResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAddSubMenuResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLAlert.html b/docs/Classes/SDLAlert.html index eb679e26b..d0765221d 100644 --- a/docs/Classes/SDLAlert.html +++ b/docs/Classes/SDLAlert.html @@ -94,8 +94,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithAlertText1:alertText2:duration:"> @@ -107,7 +106,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -122,7 +121,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -137,7 +136,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -152,7 +151,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -167,7 +166,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -182,7 +181,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -197,7 +196,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -212,7 +211,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -227,7 +226,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -242,7 +241,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlert</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -336,7 +335,6 @@ <p>@abstract 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"> <p class="aside-title">See</p> SDLTTSChunk @@ -434,7 +432,6 @@ <p>@discussion If omitted on supported displays, the displayed alert shall not have any SoftButtons</p> <p>Optional, Array of SDLSoftButton, Array size 0 - 4</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLSoftButton diff --git a/docs/Classes/SDLAlertManeuver.html b/docs/Classes/SDLAlertManeuver.html index 4b998110e..0e91bc876 100644 --- a/docs/Classes/SDLAlertManeuver.html +++ b/docs/Classes/SDLAlertManeuver.html @@ -26,7 +26,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -41,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -56,7 +56,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -71,7 +71,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -86,7 +86,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -101,7 +101,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuver</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLAlertManeuverResponse.html b/docs/Classes/SDLAlertManeuverResponse.html index ad6069e1b..1b49821bc 100644 --- a/docs/Classes/SDLAlertManeuverResponse.html +++ b/docs/Classes/SDLAlertManeuverResponse.html @@ -9,8 +9,11 @@ <h3>Overview</h3> -<p>SDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called. - * @since SmartDeviceLink 1.0</p> +<p>SDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called.</p> + +<ul> +<li>@since SmartDeviceLink 1.0</li> +</ul> <section class="section task-group-section"> @@ -23,7 +26,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuverResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuverResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -38,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuverResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertManeuverResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLAlertResponse.html b/docs/Classes/SDLAlertResponse.html index 900b6533c..c2a2beb86 100644 --- a/docs/Classes/SDLAlertResponse.html +++ b/docs/Classes/SDLAlertResponse.html @@ -24,7 +24,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +39,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -54,7 +54,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAlertResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLAmbientLightStatus.html b/docs/Classes/SDLAmbientLightStatus.html index 4aff7b620..5811862a7 100644 --- a/docs/Classes/SDLAmbientLightStatus.html +++ b/docs/Classes/SDLAmbientLightStatus.html @@ -31,7 +31,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -46,7 +46,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -61,7 +61,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -76,7 +76,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -91,7 +91,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -106,7 +106,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -121,7 +121,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -136,7 +136,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -151,7 +151,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -166,7 +166,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAmbientLightStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLAppHMIType.html b/docs/Classes/SDLAppHMIType.html index 33a9cd30f..3cf762189 100644 --- a/docs/Classes/SDLAppHMIType.html +++ b/docs/Classes/SDLAppHMIType.html @@ -12,6 +12,7 @@ <li><a href="#section-+NAVIGATION">+NAVIGATION</a></li> <li><a href="#section-+INFORMATION">+INFORMATION</a></li> <li><a href="#section-+SOCIAL">+SOCIAL</a></li> + <li><a href="#section-+PROJECTION">+PROJECTION</a></li> <li><a href="#section-+BACKGROUND_PROCESS">+BACKGROUND_PROCESS</a></li> <li><a href="#section-+TESTING">+TESTING</a></li> <li><a href="#section-+SYSTEM">+SYSTEM</a></li> @@ -45,13 +46,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLAppHMIType</p> - </div> <h3 id="section-+values"> @@ -74,7 +73,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLAppHMIType</p> - </div> <h3 id="section-+DEFAULT"> @@ -97,7 +95,6 @@ <div> <h4>Return Value</h4> <p>SDLAppHMIType with value <em>DEFAULT</em></p> - </div> <h3 id="section-+COMMUNICATION"> @@ -120,7 +117,6 @@ <div> <h4>Return Value</h4> <p>SDLAppHMIType with value <em>COMMUNICATION</em></p> - </div> <h3 id="section-+MEDIA"> @@ -143,7 +139,6 @@ <div> <h4>Return Value</h4> <p>SDLAppHMIType with value <em>MEDIA</em></p> - </div> <h3 id="section-+MESSAGING"> @@ -166,7 +161,6 @@ <div> <h4>Return Value</h4> <p>SDLAppHMIType with value <em>MESSAGING</em></p> - </div> <h3 id="section-+NAVIGATION"> @@ -189,7 +183,6 @@ <div> <h4>Return Value</h4> <p>SDLAppHMIType with value <em>NAVIGATION</em></p> - </div> <h3 id="section-+INFORMATION"> @@ -212,7 +205,6 @@ <div> <h4>Return Value</h4> <p>SDLAppHMIType with value <em>INFORMATION</em></p> - </div> <h3 id="section-+SOCIAL"> @@ -235,7 +227,28 @@ <div> <h4>Return Value</h4> <p>SDLAppHMIType with value <em>SOCIAL</em></p> + </div> + + <h3 id="section-+PROJECTION"> + +PROJECTION + </h3> + + <p>@abstract App dealing with Mobile Projection applications</p> + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">PROJECTION</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">projection</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>SDLAppHMIType with value <em>PROJECTION</em></p> </div> <h3 id="section-+BACKGROUND_PROCESS"> @@ -247,7 +260,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAppHMIType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAppHMIType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -273,7 +286,6 @@ <div> <h4>Return Value</h4> <p>SDLAppHMIType with value <em>TESTING</em></p> - </div> <h3 id="section-+SYSTEM"> @@ -296,7 +308,6 @@ <div> <h4>Return Value</h4> <p>SDLAppHMIType with value <em>SYSTEM</em></p> - </div> </section> diff --git a/docs/Classes/SDLAppInterfaceUnregisteredReason.html b/docs/Classes/SDLAppInterfaceUnregisteredReason.html index 071c32115..e92d08920 100644 --- a/docs/Classes/SDLAppInterfaceUnregisteredReason.html +++ b/docs/Classes/SDLAppInterfaceUnregisteredReason.html @@ -45,13 +45,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String value to retrieve the object for</p> -</dd> + <dd><p>String value to retrieve the object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason</p> - </div> <h3 id="section-+values"> @@ -74,7 +72,6 @@ <div> <h4>Return Value</h4> <p>an array that stores all possible SDLAppInterfaceUnregisteredReason</p> - </div> <h3 id="section-+IGNITION_OFF"> @@ -97,7 +94,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>IGNITION_OFF</em></p> - </div> <h3 id="section-+BLUETOOTH_OFF"> @@ -120,7 +116,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>BLUETOOTH_OFF</em></p> - </div> <h3 id="section-+USB_DISCONNECTED"> @@ -143,7 +138,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>USB_DISCONNECTED</em></p> - </div> <h3 id="section-+REQUEST_WHILE_IN_NONE_HMI_LEVEL"> @@ -166,7 +160,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>REQUEST_WHILE_IN_NONE_HMI_LEVEL</em></p> - </div> <h3 id="section-+TOO_MANY_REQUESTS"> @@ -189,7 +182,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>TOO_MANY_REQUESTS</em></p> - </div> <h3 id="section-+DRIVER_DISTRACTION_VIOLATION"> @@ -212,7 +204,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>DRIVER_DISTRACTION_VIOLATION</em></p> - </div> <h3 id="section-+LANGUAGE_CHANGE"> @@ -235,7 +226,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>LANGUAGE_CHANGE</em></p> - </div> <h3 id="section-+MASTER_RESET"> @@ -258,7 +248,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>MASTER_RESET</em></p> - </div> <h3 id="section-+FACTORY_DEFAULTS"> @@ -281,7 +270,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>FACTORY_DEFAULTS</em></p> - </div> <h3 id="section-+APP_UNAUTHORIZED"> @@ -306,7 +294,6 @@ <div> <h4>Return Value</h4> <p>SDLAppInterfaceUnregisteredReason with value <em>APP_UNAUTHORIZED</em></p> - </div> </section> diff --git a/docs/Classes/SDLArtwork.html b/docs/Classes/SDLArtwork.html index c461ff991..d7f8684b8 100644 --- a/docs/Classes/SDLArtwork.html +++ b/docs/Classes/SDLArtwork.html @@ -23,7 +23,6 @@ <p>This is an ephemeral file, it will not be persisted through sessions / ignition cycles. Any files that you do not <em>know</em> you will use in future sessions should be created through this method. For example, album / artist artwork should be ephemeral.</p> <p>Persistent files should be created using <code>persistentArtworkWithImage:name:asImageFormat:</code></p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> <p>It is strongly recommended to pass the file url using an SDLFile initializer instead of the image. If you pass the UIImage, it is loaded into memory, and will be dumped to a temporary file. This will create a duplicate file. <em>Only pass a UIImage if the image is not stored on disk</em>.</p> @@ -39,26 +38,22 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">image</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">image</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span></code></pre> <h4>Parameters</h4> <dl> <dt>image</dt> - <dd><p>The UIImage to be sent to the remote head unit</p> -</dd> + <dd><p>The UIImage to be sent to the remote head unit</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> <dt>imageFormat</dt> - <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p> -</dd> + <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class to be passed to the file manager.</p> - </div> <h3 id="section-+persistentArtworkWithImage:name:asImageFormat:"> @@ -70,7 +65,6 @@ <p>This is a persistent file, it will be persisted through sessions / ignition cycles. You will only have a limited space for all files, so be sure to only persist files that are required for all or most sessions. For example, menu artwork should be persistent.</p> <p>Ephemeral files should be created using <code>ephemeralArtworkWithImage:name:asImageFormat:</code></p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> <p>It is strongly recommended to pass the file url using an SDLFile initializer instead of the image. If you pass the UIImage, it is loaded into memory, and will be dumped to a temporary file. This will create a duplicate file. <em>Only pass a UIImage if the image is not stored on disk</em>.</p> @@ -87,26 +81,22 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">persistentArtwork</span><span class="p">(</span><span class="n">withImage</span> <span class="nv">image</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">persistentArtwork</span><span class="p">(</span><span class="n">with</span> <span class="nv">image</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> <h4>Parameters</h4> <dl> <dt>image</dt> - <dd><p>The UIImage to be sent to the remote head unit</p> -</dd> + <dd><p>The UIImage to be sent to the remote head unit</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> <dt>imageFormat</dt> - <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p> -</dd> + <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class to be passed to the file manager.</p> - </div> <h3 id="section--initWithImage:name:persistent:asImageFormat:"> @@ -125,29 +115,24 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">image</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">persistent</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">image</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">,</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">persistent</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="k">as</span> <span class="nv">imageFormat</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span></code></pre> <h4>Parameters</h4> <dl> <dt>image</dt> - <dd><p>The UIImage to be sent to the remote head unit</p> -</dd> + <dd><p>The UIImage to be sent to the remote head unit</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> <dt>persistent</dt> - <dd><p>Whether or not the artwork should be persistent.</p> -</dd> + <dd><p>Whether or not the artwork should be persistent.</p></dd> <dt>imageFormat</dt> - <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p> -</dd> + <dd><p>Whether the image should be converted to a PNG or JPG before transmission. Images with transparency or few colors should be PNGs. Images with many colors should be JPGs.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class to be passed to the file manager.</p> - </div> </section> diff --git a/docs/Classes/SDLAudioPassThruCapabilities.html b/docs/Classes/SDLAudioPassThruCapabilities.html index d91434ff8..32b30ab5a 100644 --- a/docs/Classes/SDLAudioPassThruCapabilities.html +++ b/docs/Classes/SDLAudioPassThruCapabilities.html @@ -13,7 +13,8 @@ <h3>Overview</h3> <p>Describes different audio type configurations for SDLPerformAudioPassThru, e.g. {8kHz,8-bit,PCM} -<p><b>Parameter List</b> +<p><b>Parameter List</b></p> + <table border="1" rules="all"> <tr> <th>Name</th> @@ -43,7 +44,8 @@ <td>SmartDeviceLink 2.0</td> </tr> </table> -Since <b>SmartDeviceLink 2.0</b></p> + +<p>Since <b>SmartDeviceLink 2.0</b></p> <section class="section task-group-section"> @@ -69,8 +71,7 @@ Since <b>SmartDeviceLink 2.0</b></p> -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLAudioPassThruCapabilities object indicated by the Hashtable parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLAudioPassThruCapabilities object indicated by the Hashtable parameter</p> @@ -86,8 +87,7 @@ Since <b>SmartDeviceLink 2.0</b></p> <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-samplingRate"> diff --git a/docs/Classes/SDLAudioStreamingState.html b/docs/Classes/SDLAudioStreamingState.html index 54f3ad005..a55a40ec8 100644 --- a/docs/Classes/SDLAudioStreamingState.html +++ b/docs/Classes/SDLAudioStreamingState.html @@ -38,13 +38,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLAudioStreamingState</p> - </div> <h3 id="section-+values"> @@ -67,7 +65,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLAudioStreamingState</p> - </div> <h3 id="section-+AUDIBLE"> @@ -90,7 +87,6 @@ <div> <h4>Return Value</h4> <p>SDLAudioStreamingState with value of <em>AUDIBLE</em></p> - </div> <h3 id="section-+ATTENUATED"> @@ -115,7 +111,6 @@ <div> <h4>Return Value</h4> <p>SDLAudioStreamingState with value of <em>ATTENUATED</em></p> - </div> <h3 id="section-+NOT_AUDIBLE"> @@ -138,7 +133,6 @@ <div> <h4>Return Value</h4> <p>SDLAudioStreamingState with value of <em>NOT_AUDIBLE</em></p> - </div> </section> diff --git a/docs/Classes/SDLAudioType.html b/docs/Classes/SDLAudioType.html index 65652a5ce..2d5d1302a 100644 --- a/docs/Classes/SDLAudioType.html +++ b/docs/Classes/SDLAudioType.html @@ -34,13 +34,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLAudioType</p> - </div> <h3 id="section-+values"> @@ -63,7 +61,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLAudioType</p> - </div> <h3 id="section-+PCM"> @@ -88,7 +85,6 @@ <div> <h4>Return Value</h4> <p>SDLAudioType with value of <em>PCM</em></p> - </div> </section> diff --git a/docs/Classes/SDLBitsPerSample.html b/docs/Classes/SDLBitsPerSample.html index f50340444..280b151a4 100644 --- a/docs/Classes/SDLBitsPerSample.html +++ b/docs/Classes/SDLBitsPerSample.html @@ -37,13 +37,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLBitsPerSample</p> - </div> <h3 id="section-+values"> @@ -66,7 +64,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLBitsPerSample</p> - </div> <h3 id="section-+_8_BIT"> @@ -89,7 +86,6 @@ <div> <h4>Return Value</h4> <p>a SDLBitsPerSample with value of <em>8_BIT</em></p> - </div> <h3 id="section-+_16_BIT"> @@ -112,7 +108,6 @@ <div> <h4>Return Value</h4> <p>a SDLBitsPerSample with value of <em>16_BIT</em></p> - </div> </section> diff --git a/docs/Classes/SDLBodyInformation.html b/docs/Classes/SDLBodyInformation.html index 5987be4d3..893f29211 100644 --- a/docs/Classes/SDLBodyInformation.html +++ b/docs/Classes/SDLBodyInformation.html @@ -43,8 +43,7 @@ </h3> <p>@abstract Constructs a new SDLBodyInformation object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -60,8 +59,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-parkBrakeActive"> diff --git a/docs/Classes/SDLButtonCapabilities.html b/docs/Classes/SDLButtonCapabilities.html index eabf7370c..d6853667c 100644 --- a/docs/Classes/SDLButtonCapabilities.html +++ b/docs/Classes/SDLButtonCapabilities.html @@ -41,8 +41,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLButtonCapabilities object indicated by the Hashtable parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLButtonCapabilities object indicated by the Hashtable parameter</p> @@ -58,8 +57,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-name"> diff --git a/docs/Classes/SDLButtonEventMode.html b/docs/Classes/SDLButtonEventMode.html index 364c2c9b8..e4e4663c0 100644 --- a/docs/Classes/SDLButtonEventMode.html +++ b/docs/Classes/SDLButtonEventMode.html @@ -21,9 +21,7 @@ +valueOf: </h3> - <p>@abstract Convert String to SDLButtonEventMode -- parameter: value The value of the string to get an object for -- returns: SDLButtonEventMode (BUTTONUP / BUTTONDOWN)</p> + <p>@abstract Convert String to SDLButtonEventMode</p> @@ -39,21 +37,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLButtonEventMode (BUTTONUP / BUTTONDOWN)</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLButtonEventMode -- returns: an array that store all possible SDLButtonEventMode</p> + <p>@abstract Store the enumeration of all possible SDLButtonEventMode</p> @@ -69,15 +64,13 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLButtonEventMode</p> - </div> <h3 id="section-+BUTTONUP"> +BUTTONUP </h3> - <p>@abstract The button was released -- returns: a SDLButtonEventMode with value of <em>BUTTONUP</em></p> + <p>@abstract The button was released</p> @@ -93,15 +86,13 @@ <div> <h4>Return Value</h4> <p>a SDLButtonEventMode with value of <em>BUTTONUP</em></p> - </div> <h3 id="section-+BUTTONDOWN"> +BUTTONDOWN </h3> - <p>@abstract The button was depressed -- returns: a SDLButtonEventMode with value of <em>BUTTONDOWN</em></p> + <p>@abstract The button was depressed</p> @@ -117,7 +108,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonEventMode with value of <em>BUTTONDOWN</em></p> - </div> </section> diff --git a/docs/Classes/SDLButtonName.html b/docs/Classes/SDLButtonName.html index 2ec047792..00d0c74c1 100644 --- a/docs/Classes/SDLButtonName.html +++ b/docs/Classes/SDLButtonName.html @@ -64,13 +64,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String value to retrieve the object for</p> -</dd> + <dd><p>String value to retrieve the object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLButtonName</p> - </div> <h3 id="section-+values"> @@ -93,7 +91,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLButtonName</p> - </div> <h3 id="section-+OK"> @@ -116,7 +113,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>OK</em></p> - </div> <h3 id="section-+SEEKLEFT"> @@ -139,7 +135,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>SEEKLEFT</em></p> - </div> <h3 id="section-+SEEKRIGHT"> @@ -162,7 +157,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>SEEKRIGHT</em></p> - </div> <h3 id="section-+TUNEUP"> @@ -185,7 +179,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>TUNEUP</em></p> - </div> <h3 id="section-+TUNEDOWN"> @@ -208,7 +201,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>TUNEDOWN</em></p> - </div> <h3 id="section-+PRESET_0"> @@ -231,7 +223,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_0</em></p> - </div> <h3 id="section-+PRESET_1"> @@ -254,7 +245,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_1</em></p> - </div> <h3 id="section-+PRESET_2"> @@ -277,7 +267,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_2</em></p> - </div> <h3 id="section-+PRESET_3"> @@ -300,7 +289,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_3</em></p> - </div> <h3 id="section-+PRESET_4"> @@ -323,7 +311,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_4</em></p> - </div> <h3 id="section-+PRESET_5"> @@ -346,7 +333,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_5</em></p> - </div> <h3 id="section-+PRESET_6"> @@ -369,7 +355,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_6</em></p> - </div> <h3 id="section-+PRESET_7"> @@ -392,7 +377,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_7</em></p> - </div> <h3 id="section-+PRESET_8"> @@ -415,7 +399,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_8</em></p> - </div> <h3 id="section-+PRESET_9"> @@ -438,7 +421,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonName with the value of <em>PRESET_9</em></p> - </div> <h3 id="section-+CUSTOM_BUTTON"> @@ -450,7 +432,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLButtonName</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLButtonName</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -465,7 +447,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLButtonName</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLButtonName</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLButtonPressMode.html b/docs/Classes/SDLButtonPressMode.html index 0cf97073e..8da70c64e 100644 --- a/docs/Classes/SDLButtonPressMode.html +++ b/docs/Classes/SDLButtonPressMode.html @@ -37,13 +37,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLButtonPressMode</p> - </div> <h3 id="section-+values"> @@ -66,7 +64,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLButtonPressMode</p> - </div> <h3 id="section-+LONG"> @@ -89,7 +86,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonPressMode with the value of <em>LONG</em></p> - </div> <h3 id="section-+SHORT"> @@ -112,7 +108,6 @@ <div> <h4>Return Value</h4> <p>a SDLButtonPressMode with the value of <em>SHORT</em></p> - </div> </section> diff --git a/docs/Classes/SDLCarModeStatus.html b/docs/Classes/SDLCarModeStatus.html index ef12611c4..d5fda2ae5 100644 --- a/docs/Classes/SDLCarModeStatus.html +++ b/docs/Classes/SDLCarModeStatus.html @@ -13,8 +13,11 @@ <h3>Overview</h3> -<p>Describes the carmode the vehicle is in. - * <b>Since</b> SmartDeviceLink 2.0</p> +<p>Describes the carmode the vehicle is in.</p> + +<ul> +<li><b>Since</b> SmartDeviceLink 2.0</li> +</ul> <section class="section task-group-section"> @@ -27,7 +30,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCarModeStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCarModeStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -42,7 +45,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCarModeStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCarModeStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLChangeRegistration.html b/docs/Classes/SDLChangeRegistration.html index 709f8d62f..c015390f8 100644 --- a/docs/Classes/SDLChangeRegistration.html +++ b/docs/Classes/SDLChangeRegistration.html @@ -63,8 +63,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithLanguage:hmiDisplayLanguage:"> @@ -76,7 +75,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChangeRegistration</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChangeRegistration</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -91,7 +90,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChangeRegistration</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChangeRegistration</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLChangeRegistrationResponse.html b/docs/Classes/SDLChangeRegistrationResponse.html index 2c933ff64..bf9fb5b27 100644 --- a/docs/Classes/SDLChangeRegistrationResponse.html +++ b/docs/Classes/SDLChangeRegistrationResponse.html @@ -24,7 +24,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChangeRegistrationResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChangeRegistrationResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +39,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChangeRegistrationResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChangeRegistrationResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLCharacterSet.html b/docs/Classes/SDLCharacterSet.html index 5f8dccea7..69f05d768 100644 --- a/docs/Classes/SDLCharacterSet.html +++ b/docs/Classes/SDLCharacterSet.html @@ -39,13 +39,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLCharacterSet</p> - </div> <h3 id="section-+values"> @@ -68,7 +66,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLCharacterSet</p> - </div> <h3 id="section-+TYPE2SET"> @@ -80,7 +77,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCharacterSet</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCharacterSet</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -95,7 +92,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCharacterSet</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCharacterSet</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -110,7 +107,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCharacterSet</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCharacterSet</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -125,7 +122,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCharacterSet</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCharacterSet</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLChoice.html b/docs/Classes/SDLChoice.html index 43d1f3981..703883c79 100644 --- a/docs/Classes/SDLChoice.html +++ b/docs/Classes/SDLChoice.html @@ -85,8 +85,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLChoice object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLChoice object indicated by the dictionary parameter</p> @@ -102,8 +101,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithId:menuName:vrCommands:"> @@ -115,7 +113,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChoice</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChoice</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> @@ -130,7 +128,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChoice</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLChoice</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> diff --git a/docs/Classes/SDLCompassDirection.html b/docs/Classes/SDLCompassDirection.html index 2955a1adc..c83a2e674 100644 --- a/docs/Classes/SDLCompassDirection.html +++ b/docs/Classes/SDLCompassDirection.html @@ -27,9 +27,7 @@ +valueOf: </h3> - <p>@abstract Convert String to SDLCompassDirection -- parameter: value The value of the string to get an object for -- returns: SDLCompassDirection</p> + <p>@abstract Convert String to SDLCompassDirection</p> @@ -45,21 +43,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLCompassDirection</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLCompassDirection -- returns: An array that store all possible SDLCompassDirection</p> + <p>@abstract Store the enumeration of all possible SDLCompassDirection</p> @@ -75,15 +70,13 @@ <div> <h4>Return Value</h4> <p>An array that store all possible SDLCompassDirection</p> - </div> <h3 id="section-+NORTH"> +NORTH </h3> - <p>@abstract Direction North -- returns: A SDLCompassDirection with the value of <em>NORTH</em></p> + <p>@abstract Direction North</p> @@ -99,15 +92,13 @@ <div> <h4>Return Value</h4> <p>A SDLCompassDirection with the value of <em>NORTH</em></p> - </div> <h3 id="section-+NORTHWEST"> +NORTHWEST </h3> - <p>@abstract Direction Northwest -- returns: A SDLCompassDirection with the value of <em>NORTHWEST</em></p> + <p>@abstract Direction Northwest</p> @@ -123,15 +114,13 @@ <div> <h4>Return Value</h4> <p>A SDLCompassDirection with the value of <em>NORTHWEST</em></p> - </div> <h3 id="section-+WEST"> +WEST </h3> - <p>@abstract Direction West -- returns: A SDLCompassDirection with the value of <em>WEST</em></p> + <p>@abstract Direction West</p> @@ -147,15 +136,13 @@ <div> <h4>Return Value</h4> <p>A SDLCompassDirection with the value of <em>WEST</em></p> - </div> <h3 id="section-+SOUTHWEST"> +SOUTHWEST </h3> - <p>@abstract Direction Southwest -- returns: A SDLCompassDirection with the value of <em>SOUTHWEST</em></p> + <p>@abstract Direction Southwest</p> @@ -171,15 +158,13 @@ <div> <h4>Return Value</h4> <p>A SDLCompassDirection with the value of <em>SOUTHWEST</em></p> - </div> <h3 id="section-+SOUTH"> +SOUTH </h3> - <p>@abstract Direction South -- returns: A SDLCompassDirection with the value of <em>SOUTH</em></p> + <p>@abstract Direction South</p> @@ -195,15 +180,13 @@ <div> <h4>Return Value</h4> <p>A SDLCompassDirection with the value of <em>SOUTH</em></p> - </div> <h3 id="section-+SOUTHEAST"> +SOUTHEAST </h3> - <p>@abstract Direction Southeast -- returns: A SDLCompassDirection with the value of <em>SOUTHEAST</em></p> + <p>@abstract Direction Southeast</p> @@ -219,15 +202,13 @@ <div> <h4>Return Value</h4> <p>A SDLCompassDirection with the value of <em>SOUTHEAST</em></p> - </div> <h3 id="section-+EAST"> +EAST </h3> - <p>@abstract Direction East -- returns: A SDLCompassDirection with the value of <em>EAST</em></p> + <p>@abstract Direction East</p> @@ -243,15 +224,13 @@ <div> <h4>Return Value</h4> <p>A SDLCompassDirection with the value of <em>EAST</em></p> - </div> <h3 id="section-+NORTHEAST"> +NORTHEAST </h3> - <p>@abstract Direction Northeast -- returns: A SDLCompassDirection with the value of <em>NORTHEAST</em></p> + <p>@abstract Direction Northeast</p> @@ -267,7 +246,6 @@ <div> <h4>Return Value</h4> <p>A SDLCompassDirection with the value of <em>NORTHEAST</em></p> - </div> </section> diff --git a/docs/Classes/SDLComponentVolumeStatus.html b/docs/Classes/SDLComponentVolumeStatus.html index 4a2f86fc5..e4aa85eda 100644 --- a/docs/Classes/SDLComponentVolumeStatus.html +++ b/docs/Classes/SDLComponentVolumeStatus.html @@ -25,9 +25,7 @@ +valueOf: </h3> - <p>@abstract Convert String to SDLComponentVolumeStatus -- parameter: value The value of the string to get an object for -- returns: SDLComponentVolumeStatus</p> + <p>@abstract Convert String to SDLComponentVolumeStatus</p> @@ -43,21 +41,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLComponentVolumeStatus</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLComponentVolumeStatus -- returns: An array that store all possible SDLComponentVolumeStatus</p> + <p>@abstract Store the enumeration of all possible SDLComponentVolumeStatus</p> @@ -73,15 +68,13 @@ <div> <h4>Return Value</h4> <p>An array that store all possible SDLComponentVolumeStatus</p> - </div> <h3 id="section-+UNKNOWN"> +UNKNOWN </h3> - <p>@abstract Unknown SDLComponentVolumeStatus -- returns: a SDLComponentVolumeStatus with the value of <em>UNKNOWN</em></p> + <p>@abstract Unknown SDLComponentVolumeStatus</p> @@ -97,15 +90,13 @@ <div> <h4>Return Value</h4> <p>a SDLComponentVolumeStatus with the value of <em>UNKNOWN</em></p> - </div> <h3 id="section-+NORMAL"> +NORMAL </h3> - <p>@abstract Normal SDLComponentVolumeStatus -- returns: a SDLComponentVolumeStatus with the value of <em>NORMAL</em></p> + <p>@abstract Normal SDLComponentVolumeStatus</p> @@ -121,15 +112,13 @@ <div> <h4>Return Value</h4> <p>a SDLComponentVolumeStatus with the value of <em>NORMAL</em></p> - </div> <h3 id="section-+LOW"> +LOW </h3> - <p>@abstract Low SDLComponentVolumeStatus -- returns: a SDLComponentVolumeStatus with the value of <em>LOW</em></p> + <p>@abstract Low SDLComponentVolumeStatus</p> @@ -145,15 +134,13 @@ <div> <h4>Return Value</h4> <p>a SDLComponentVolumeStatus with the value of <em>LOW</em></p> - </div> <h3 id="section-+FAULT"> +FAULT </h3> - <p>@abstract Fault SDLComponentVolumeStatus -- returns: a SDLComponentVolumeStatus with the value of <em>FAULT</em></p> + <p>@abstract Fault SDLComponentVolumeStatus</p> @@ -169,15 +156,13 @@ <div> <h4>Return Value</h4> <p>a SDLComponentVolumeStatus with the value of <em>FAULT</em></p> - </div> <h3 id="section-+ALERT"> +ALERT </h3> - <p>@abstract Alert SDLComponentVolumeStatus -- returns: a SDLComponentVolumeStatus with the value of <em>ALERT</em></p> + <p>@abstract Alert SDLComponentVolumeStatus</p> @@ -193,15 +178,13 @@ <div> <h4>Return Value</h4> <p>a SDLComponentVolumeStatus with the value of <em>ALERT</em></p> - </div> <h3 id="section-+NOT_SUPPORTED"> +NOT_SUPPORTED </h3> - <p>@abstract Not supported SDLComponentVolumeStatus -- returns: a SDLComponentVolumeStatus with the value of <em>NOT_SUPPORTED</em></p> + <p>@abstract Not supported SDLComponentVolumeStatus</p> @@ -217,7 +200,6 @@ <div> <h4>Return Value</h4> <p>a SDLComponentVolumeStatus with the value of <em>NOT_SUPPORTED</em></p> - </div> </section> diff --git a/docs/Classes/SDLConfiguration.html b/docs/Classes/SDLConfiguration.html index c27a5f2eb..9322a73ac 100644 --- a/docs/Classes/SDLConfiguration.html +++ b/docs/Classes/SDLConfiguration.html @@ -75,16 +75,13 @@ <h4>Parameters</h4> <dl> <dt>lifecycleConfig</dt> - <dd><p>The lifecycle configuration to be used.</p> -</dd> + <dd><p>The lifecycle configuration to be used.</p></dd> <dt>lockScreenConfig</dt> - <dd><p>The lockscreen configuration to be used. If nil, this will be <code>enabledConfiguration</code>.</p> -</dd> + <dd><p>The lockscreen configuration to be used. If nil, this will be <code>enabledConfiguration</code>.</p></dd> </dl> <div> <h4>Return Value</h4> <p>The configuration</p> - </div> <h3 id="section-+configurationWithLifecycle:lockScreen:"> @@ -107,16 +104,13 @@ <h4>Parameters</h4> <dl> <dt>lifecycleConfig</dt> - <dd><p>The lifecycle configuration to be used.</p> -</dd> + <dd><p>The lifecycle configuration to be used.</p></dd> <dt>lockScreenConfig</dt> - <dd><p>The lockscreen configuration to be used. If nil, this will be <code>enabledConfiguration</code>.</p> -</dd> + <dd><p>The lockscreen configuration to be used. If nil, this will be <code>enabledConfiguration</code>.</p></dd> </dl> <div> <h4>Return Value</h4> <p>The configuration</p> - </div> </section> diff --git a/docs/Classes/SDLCreateInteractionChoiceSet.html b/docs/Classes/SDLCreateInteractionChoiceSet.html index 89d9f4557..a5e651e9c 100644 --- a/docs/Classes/SDLCreateInteractionChoiceSet.html +++ b/docs/Classes/SDLCreateInteractionChoiceSet.html @@ -21,7 +21,6 @@ <p>If you do not wait the system may not recognize the first utterance from the user.</p> <p>@since SDL 1.0</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeleteInteractionChoiceSet SDLPerformInteraction @@ -68,8 +67,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithId:choiceSet:"> @@ -81,7 +79,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCreateInteractionChoiceSet</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCreateInteractionChoiceSet</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLCreateInteractionChoiceSetResponse.html b/docs/Classes/SDLCreateInteractionChoiceSetResponse.html index f4745e136..7646c792c 100644 --- a/docs/Classes/SDLCreateInteractionChoiceSetResponse.html +++ b/docs/Classes/SDLCreateInteractionChoiceSetResponse.html @@ -25,7 +25,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCreateInteractionChoiceSetResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCreateInteractionChoiceSetResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -40,7 +40,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCreateInteractionChoiceSetResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLCreateInteractionChoiceSetResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLDeleteCommand.html b/docs/Classes/SDLDeleteCommand.html index f0d834aae..932658d47 100644 --- a/docs/Classes/SDLDeleteCommand.html +++ b/docs/Classes/SDLDeleteCommand.html @@ -64,8 +64,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithId:"> @@ -77,7 +76,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteCommand</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteCommand</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLDeleteCommandResponse.html b/docs/Classes/SDLDeleteCommandResponse.html index f0728e1fe..5de02884b 100644 --- a/docs/Classes/SDLDeleteCommandResponse.html +++ b/docs/Classes/SDLDeleteCommandResponse.html @@ -24,7 +24,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteCommandResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteCommandResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +39,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteCommandResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteCommandResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLDeleteFile.html b/docs/Classes/SDLDeleteFile.html index 468b526ff..43cf3eaa3 100644 --- a/docs/Classes/SDLDeleteFile.html +++ b/docs/Classes/SDLDeleteFile.html @@ -59,8 +59,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithFileName:"> @@ -72,7 +71,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteFile</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteFile</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLDeleteFileResponse.html b/docs/Classes/SDLDeleteFileResponse.html index 3893bbd72..626eca910 100644 --- a/docs/Classes/SDLDeleteFileResponse.html +++ b/docs/Classes/SDLDeleteFileResponse.html @@ -25,7 +25,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteFileResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteFileResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -40,7 +40,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteFileResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteFileResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -55,7 +55,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteFileResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteFileResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLDeleteInteractionChoiceSet.html b/docs/Classes/SDLDeleteInteractionChoiceSet.html index 9e879984a..cb2358a6c 100644 --- a/docs/Classes/SDLDeleteInteractionChoiceSet.html +++ b/docs/Classes/SDLDeleteInteractionChoiceSet.html @@ -66,8 +66,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithId:"> @@ -79,7 +78,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteInteractionChoiceSet</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteInteractionChoiceSet</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLDeleteInteractionChoiceSetResponse.html b/docs/Classes/SDLDeleteInteractionChoiceSetResponse.html index f66ff8b73..ccbe62169 100644 --- a/docs/Classes/SDLDeleteInteractionChoiceSetResponse.html +++ b/docs/Classes/SDLDeleteInteractionChoiceSetResponse.html @@ -24,7 +24,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteInteractionChoiceSetResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteInteractionChoiceSetResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +39,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteInteractionChoiceSetResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteInteractionChoiceSetResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLDeleteSubMenu.html b/docs/Classes/SDLDeleteSubMenu.html index f5678029c..6a33bf38d 100644 --- a/docs/Classes/SDLDeleteSubMenu.html +++ b/docs/Classes/SDLDeleteSubMenu.html @@ -46,8 +46,7 @@ -initWithDictionary: </h3> - <p>Constructs a new SDLDeleteSubMenu object indicated by the dictionary parameter<p> -- parameter: dict The dictionary to use</p> + <p>Constructs a new SDLDeleteSubMenu object indicated by the dictionary parameter<p></p> @@ -63,8 +62,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithId:"> @@ -76,7 +74,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteSubMenu</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteSubMenu</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLDeleteSubMenuResponse.html b/docs/Classes/SDLDeleteSubMenuResponse.html index c26d8815d..de08d4187 100644 --- a/docs/Classes/SDLDeleteSubMenuResponse.html +++ b/docs/Classes/SDLDeleteSubMenuResponse.html @@ -24,7 +24,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteSubMenuResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteSubMenuResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +39,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteSubMenuResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeleteSubMenuResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLDeliveryMode.html b/docs/Classes/SDLDeliveryMode.html index 48d5dfd8d..392ae09c3 100644 --- a/docs/Classes/SDLDeliveryMode.html +++ b/docs/Classes/SDLDeliveryMode.html @@ -36,13 +36,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLDeliveryMode</p> - </div> <h3 id="section-+values"> @@ -65,7 +63,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLDeliveryMode</p> - </div> <h3 id="section-+PROMPT"> @@ -88,7 +85,6 @@ <div> <h4>Return Value</h4> <p>a SDLDeliveryMode with value of <em>PROMPT</em></p> - </div> <h3 id="section-+DESTINATION"> @@ -111,7 +107,6 @@ <div> <h4>Return Value</h4> <p>a SDLDeliveryMode with value of <em>DESTINATION</em></p> - </div> <h3 id="section-+QUEUE"> @@ -134,7 +129,6 @@ <div> <h4>Return Value</h4> <p>a SDLDeliveryMode with value of <em>QUEUE</em></p> - </div> </section> diff --git a/docs/Classes/SDLDeviceLevelStatus.html b/docs/Classes/SDLDeviceLevelStatus.html index 122268a1b..ad5b2608e 100644 --- a/docs/Classes/SDLDeviceLevelStatus.html +++ b/docs/Classes/SDLDeviceLevelStatus.html @@ -25,9 +25,7 @@ +valueOf: </h3> - <p>Convert String to DeviceLevelStatus -- parameter: value String -- returns: DeviceLevelStatus</p> + <p>Convert String to DeviceLevelStatus</p> @@ -43,21 +41,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String</p> -</dd> + <dd><p>String</p></dd> </dl> <div> <h4>Return Value</h4> <p>DeviceLevelStatus</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLDeviceLevelStatus -- returns: an array that store all possible SDLDeviceLevelStatus</p> + <p>@abstract Store the enumeration of all possible SDLDeviceLevelStatus</p> @@ -73,15 +68,13 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLDeviceLevelStatus</p> - </div> <h3 id="section-+ZERO_LEVEL_BARS"> +ZERO_LEVEL_BARS </h3> - <p>@abstract Device battery level is zero bars -- returns: a SDLDeviceLevelStatus with value of <em>ZERO_LEVEL_BARS</em></p> + <p>@abstract Device battery level is zero bars</p> @@ -97,15 +90,13 @@ <div> <h4>Return Value</h4> <p>a SDLDeviceLevelStatus with value of <em>ZERO_LEVEL_BARS</em></p> - </div> <h3 id="section-+ONE_LEVEL_BARS"> +ONE_LEVEL_BARS </h3> - <p>@abstract Device battery level is one bar -- returns: a SDLDeviceLevelStatus with value of <em>ONE_LEVEL_BARS</em></p> + <p>@abstract Device battery level is one bar</p> @@ -121,15 +112,13 @@ <div> <h4>Return Value</h4> <p>a SDLDeviceLevelStatus with value of <em>ONE_LEVEL_BARS</em></p> - </div> <h3 id="section-+TWO_LEVEL_BARS"> +TWO_LEVEL_BARS </h3> - <p>@abstract Device battery level is two bars -- returns: a SDLDeviceLevelStatus with value of <em>TWO_LEVEL_BARS</em></p> + <p>@abstract Device battery level is two bars</p> @@ -145,15 +134,13 @@ <div> <h4>Return Value</h4> <p>a SDLDeviceLevelStatus with value of <em>TWO_LEVEL_BARS</em></p> - </div> <h3 id="section-+THREE_LEVEL_BARS"> +THREE_LEVEL_BARS </h3> - <p>@abstract Device battery level is three bars -- returns: a SDLDeviceLevelStatus with value of <em>THREE_LEVEL_BARS</em></p> + <p>@abstract Device battery level is three bars</p> @@ -169,15 +156,13 @@ <div> <h4>Return Value</h4> <p>a SDLDeviceLevelStatus with value of <em>THREE_LEVEL_BARS</em></p> - </div> <h3 id="section-+FOUR_LEVEL_BARS"> +FOUR_LEVEL_BARS </h3> - <p>@abstract Device battery level is four bars -- returns: a SDLDeviceLevelStatus with value of <em>FOUR_LEVEL_BARS</em></p> + <p>@abstract Device battery level is four bars</p> @@ -193,15 +178,13 @@ <div> <h4>Return Value</h4> <p>a SDLDeviceLevelStatus with value of <em>FOUR_LEVEL_BARS</em></p> - </div> <h3 id="section-+NOT_PROVIDED"> +NOT_PROVIDED </h3> - <p>@abstract Device battery level is unknown -- returns: a SDLDeviceLevelStatus with value of <em>NOT_PROVIDED</em></p> + <p>@abstract Device battery level is unknown</p> @@ -217,7 +200,6 @@ <div> <h4>Return Value</h4> <p>a SDLDeviceLevelStatus with value of <em>NOT_PROVIDED</em></p> - </div> </section> diff --git a/docs/Classes/SDLDeviceStatus.html b/docs/Classes/SDLDeviceStatus.html index 1128c14c3..53c22214e 100644 --- a/docs/Classes/SDLDeviceStatus.html +++ b/docs/Classes/SDLDeviceStatus.html @@ -150,8 +150,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use to construct the object</p> -</dd> + <dd><p>The dictionary to use to construct the object</p></dd> </dl> <h3 id="section-voiceRecOn"> @@ -259,7 +258,6 @@ </h3> <p>@abstract Battery level status</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeviceLevelStatus @@ -325,7 +323,6 @@ </h3> <p>@abstract Signal level status</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeviceLevelStatus @@ -351,7 +348,6 @@ </h3> <p>@abstract The current primary audio source of SDL (if selected).</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLPrimaryAudioSource diff --git a/docs/Classes/SDLDiagnosticMessage.html b/docs/Classes/SDLDiagnosticMessage.html index 518caba84..7e5d76068 100644 --- a/docs/Classes/SDLDiagnosticMessage.html +++ b/docs/Classes/SDLDiagnosticMessage.html @@ -28,7 +28,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessage</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -43,7 +43,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessage</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -58,7 +58,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessage</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLDiagnosticMessageResponse.html b/docs/Classes/SDLDiagnosticMessageResponse.html index 51b45dc61..6edd4732e 100644 --- a/docs/Classes/SDLDiagnosticMessageResponse.html +++ b/docs/Classes/SDLDiagnosticMessageResponse.html @@ -10,8 +10,11 @@ <h3>Overview</h3> -<p>SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called. - * Since<b>SmartDeviceLink 3.0</b></p> +<p>SDLDiagnosticMessageResponse is sent, when SDLDiagnosticMessage has been called.</p> + +<ul> +<li>Since<b>SmartDeviceLink 3.0</b></li> +</ul> <section class="section task-group-section"> @@ -24,7 +27,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessageResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessageResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +42,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessageResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessageResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -54,7 +57,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessageResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDiagnosticMessageResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLDialNumber.html b/docs/Classes/SDLDialNumber.html index bd51c8c06..c81a3b74d 100644 --- a/docs/Classes/SDLDialNumber.html +++ b/docs/Classes/SDLDialNumber.html @@ -26,7 +26,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumber</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumber</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -41,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumber</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumber</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -56,7 +56,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumber</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumber</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -66,7 +66,7 @@ number </h3> - <p>Up to 40 character string representing the phone number. All characters stripped except for ‘0’-‘9’, ’*’, ’#’, ’,’, ’;’, and ’+’</p> + <p>Up to 40 character string representing the phone number. All characters stripped except for ‘0’-'9’, ’*’, ’#’, ’,’, ’;’, and ’+’</p> diff --git a/docs/Classes/SDLDialNumberResponse.html b/docs/Classes/SDLDialNumberResponse.html index d20451914..478c3e37d 100644 --- a/docs/Classes/SDLDialNumberResponse.html +++ b/docs/Classes/SDLDialNumberResponse.html @@ -24,7 +24,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumberResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumberResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +39,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumberResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDialNumberResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLDimension.html b/docs/Classes/SDLDimension.html index c6386805a..395317141 100644 --- a/docs/Classes/SDLDimension.html +++ b/docs/Classes/SDLDimension.html @@ -38,13 +38,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLDimension</p> - </div> <h3 id="section-+values"> @@ -67,15 +65,13 @@ <div> <h4>Return Value</h4> <p>An array that store all possible SDLDimension</p> - </div> <h3 id="section-+NO_FIX"> +NO_FIX </h3> - <p>@abstract No GPS at all -- returns: the dimension with value of <em>NO_FIX</em></p> + <p>@abstract No GPS at all</p> @@ -91,15 +87,13 @@ <div> <h4>Return Value</h4> <p>the dimension with value of <em>NO_FIX</em></p> - </div> <h3 id="section-+_2D"> +_2D </h3> - <p>@abstract Longitude and latitude of the GPS -- returns: the dimension with value of <em>2D</em></p> + <p>@abstract Longitude and latitude of the GPS</p> @@ -115,15 +109,13 @@ <div> <h4>Return Value</h4> <p>the dimension with value of <em>2D</em></p> - </div> <h3 id="section-+_3D"> +_3D </h3> - <p>@abstract Longitude and latitude and altitude of the GPS -- returns: the dimension with value of <em>3D</em></p> + <p>@abstract Longitude and latitude and altitude of the GPS</p> @@ -139,7 +131,6 @@ <div> <h4>Return Value</h4> <p>the dimension with value of <em>3D</em></p> - </div> </section> diff --git a/docs/Classes/SDLDisplayCapabilities.html b/docs/Classes/SDLDisplayCapabilities.html index 15f8ab79f..631611e82 100644 --- a/docs/Classes/SDLDisplayCapabilities.html +++ b/docs/Classes/SDLDisplayCapabilities.html @@ -61,8 +61,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-displayType"> @@ -92,7 +91,6 @@ <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>@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"> <p class="aside-title">See</p> SDLTextField @@ -120,7 +118,6 @@ <p>@abstract An array of SDLImageField elements</p> <p>@discussion A set of all fields that support images.</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLImageField @@ -146,7 +143,6 @@ </h3> <p>@abstract 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 diff --git a/docs/Classes/SDLDisplayType.html b/docs/Classes/SDLDisplayType.html index e2ff220b5..5e9d30202 100644 --- a/docs/Classes/SDLDisplayType.html +++ b/docs/Classes/SDLDisplayType.html @@ -46,13 +46,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLDisplayType</p> - </div> <h3 id="section-+values"> @@ -75,7 +73,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLDisplayType</p> - </div> <h3 id="section-+CID"> @@ -98,7 +95,6 @@ <div> <h4>Return Value</h4> <p>SDLDisplayType with value of <em>CID</em></p> - </div> <h3 id="section-+TYPE2"> @@ -110,7 +106,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -125,7 +121,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -151,7 +147,6 @@ <div> <h4>Return Value</h4> <p>SDLDisplayType with value of <em>NGN</em></p> - </div> <h3 id="section-+GEN2_8_DMA"> @@ -163,7 +158,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -178,7 +173,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -193,7 +188,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -208,7 +203,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -223,7 +218,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -238,7 +233,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -253,7 +248,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDisplayType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLDriverDistractionState.html b/docs/Classes/SDLDriverDistractionState.html index ea7d06013..e67231f8a 100644 --- a/docs/Classes/SDLDriverDistractionState.html +++ b/docs/Classes/SDLDriverDistractionState.html @@ -37,13 +37,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLDisplayType</p> - </div> <h3 id="section-+values"> @@ -66,7 +64,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLDriverDistractionState</p> - </div> <h3 id="section-+DD_ON"> @@ -89,7 +86,6 @@ <div> <h4>Return Value</h4> <p>a SDLDriverDistractionState with value of <em>DD_ON</em></p> - </div> <h3 id="section-+DD_OFF"> @@ -112,7 +108,6 @@ <div> <h4>Return Value</h4> <p>a SDLDriverDistractionState with value of <em>DD_OFF</em></p> - </div> </section> diff --git a/docs/Classes/SDLECallConfirmationStatus.html b/docs/Classes/SDLECallConfirmationStatus.html index 26b67e654..12fe68ec4 100644 --- a/docs/Classes/SDLECallConfirmationStatus.html +++ b/docs/Classes/SDLECallConfirmationStatus.html @@ -31,7 +31,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLECallConfirmationStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLECallConfirmationStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -46,7 +46,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLECallConfirmationStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLECallConfirmationStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLEmergencyEventType.html b/docs/Classes/SDLEmergencyEventType.html index 3668c7186..cd5805cd8 100644 --- a/docs/Classes/SDLEmergencyEventType.html +++ b/docs/Classes/SDLEmergencyEventType.html @@ -31,7 +31,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEmergencyEventType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEmergencyEventType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -46,7 +46,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEmergencyEventType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEmergencyEventType</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLEndAudioPassThru.html b/docs/Classes/SDLEndAudioPassThru.html index 2fe2f95be..f56ce3736 100644 --- a/docs/Classes/SDLEndAudioPassThru.html +++ b/docs/Classes/SDLEndAudioPassThru.html @@ -9,7 +9,8 @@ <h3>Overview</h3> -<p>When this request is invoked, the audio capture stops +<p>When this request is invoked, the audio capture stops</p> + <p> Function Group: AudioPassThru <p> @@ -17,7 +18,7 @@ Function Group: AudioPassThru </p> <p>Since <b>SmartDeviceLink 2.0</b><br> -see SDLPerformAudioPassThru</p></p> +see SDLPerformAudioPassThru</p> <section class="section task-group-section"> @@ -61,8 +62,7 @@ see SDLPerformAudioPassThru</p></p> <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLEndAudioPassThruResponse.html b/docs/Classes/SDLEndAudioPassThruResponse.html index 40e25686c..687c94bae 100644 --- a/docs/Classes/SDLEndAudioPassThruResponse.html +++ b/docs/Classes/SDLEndAudioPassThruResponse.html @@ -24,7 +24,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEndAudioPassThruResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEndAudioPassThruResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +39,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEndAudioPassThruResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEndAudioPassThruResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLFile.html b/docs/Classes/SDLFile.html index af15542f5..3b5f63606 100644 --- a/docs/Classes/SDLFile.html +++ b/docs/Classes/SDLFile.html @@ -165,19 +165,15 @@ <h4>Parameters</h4> <dl> <dt>url</dt> - <dd><p>The file URL pointing to the local data that will be pushed to the remote system.</p> -</dd> + <dd><p>The file URL pointing to the local data that will be pushed to the remote system.</p></dd> <dt>name</dt> - <dd><p>The name that the file will be stored under on the remote system and how it will be referenced from the local system.</p> -</dd> + <dd><p>The name that the file will be stored under on the remote system and how it will be referenced from the local system. The max file name length may vary based on remote filesystem limitations.</p></dd> <dt>persistent</dt> - <dd><p>Whether or not the file will persist between ignition cycles.</p> -</dd> + <dd><p>Whether or not the file will persist between ignition cycles.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An SDLFile object.</p> - </div> <h3 id="section-+persistentFileAtFileURL:name:"> @@ -189,7 +185,6 @@ <p>This is a persistent file, it will be persisted through sessions / ignition cycles. You will only have a limited space for all files, so be sure to only persist files that are required for all or most sessions. For example, menu artwork should be persistent.</p> <p>Ephemeral files should be created using ephemeralFileAtURL:name:</p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> <p>If this is not a readable file, this will return nil</p> @@ -211,16 +206,13 @@ <h4>Parameters</h4> <dl> <dt>url</dt> - <dd><p>The url to the file that should be uploaded.</p> -</dd> + <dd><p>The url to the file that should be uploaded.</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote filesystem limitations.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class, or nil if a readable file at the path could not be found.</p> - </div> <h3 id="section-+fileAtFileURL:name:"> @@ -232,7 +224,6 @@ <p>This is an ephemeral file, it will not be persisted through sessions / ignition cycles. Any files that you do not <em>know</em> you will use in future sessions should be created through this method. For example, album / artist artwork should be ephemeral.</p> <p>Persistent files should be created using persistentFileAtURL:name:</p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> <p>If this is not a readable file, this will return nil</p> @@ -254,16 +245,13 @@ <h4>Parameters</h4> <dl> <dt>url</dt> - <dd><p>The url to the file on disk that will be uploaded</p> -</dd> + <dd><p>The url to the file on disk that will be uploaded</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class, or nil if a readable file at the url could not be found.</p> - </div> <h3 id="section--initWithData:name:fileExtension:persistent:"> @@ -289,22 +277,17 @@ <h4>Parameters</h4> <dl> <dt>data</dt> - <dd><p>The raw data to be used for the file</p> -</dd> + <dd><p>The raw data to be used for the file</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> <dt>extension</dt> - <dd><p>The file extension. For example <q>png</q>. Currently supported file extensions are: <q>bmp</q>, <q>jpg</q>, <q>jpeg</q>, <q>png</q>, <q>wav</q>, <q>mp3</q>, <q>aac</q>, <q>json</q>. All others will be sent as binary files.</p> -</dd> + <dd><p>The file extension. For example <q>png</q>. Currently supported file extensions are: <q>bmp</q>, <q>jpg</q>, <q>jpeg</q>, <q>png</q>, <q>wav</q>, <q>mp3</q>, <q>aac</q>, <q>json</q>. All others will be sent as binary files.</p></dd> <dt>persistent</dt> - <dd><p>Whether or not the remote file with this data should be persistent</p> -</dd> + <dd><p>Whether or not the remote file with this data should be persistent</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class</p> - </div> <h3 id="section-+persistentFileWithData:name:fileExtension:"> @@ -331,19 +314,15 @@ <h4>Parameters</h4> <dl> <dt>data</dt> - <dd><p>The raw data to be used for the file</p> -</dd> + <dd><p>The raw data to be used for the file</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> <dt>extension</dt> - <dd><p>The file extension. For example <q>png</q>. Currently supported file extensions are: <q>bmp</q>, <q>jpg</q>, <q>jpeg</q>, <q>png</q>, <q>wav</q>, <q>mp3</q>, <q>aac</q>, <q>json</q>. All others will be sent as binary files.</p> -</dd> + <dd><p>The file extension. For example <q>png</q>. Currently supported file extensions are: <q>bmp</q>, <q>jpg</q>, <q>jpeg</q>, <q>png</q>, <q>wav</q>, <q>mp3</q>, <q>aac</q>, <q>json</q>. All others will be sent as binary files.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class</p> - </div> <h3 id="section-+fileWithData:name:fileExtension:"> @@ -370,19 +349,15 @@ <h4>Parameters</h4> <dl> <dt>data</dt> - <dd><p>The raw data to be used for the file</p> -</dd> + <dd><p>The raw data to be used for the file</p></dd> <dt>name</dt> - <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system).</p> -</dd> + <dd><p>The name of the file that will be used to reference the file in the future (for example on the remote file system). The max file name length may vary based on remote file system limitations.</p></dd> <dt>extension</dt> - <dd><p>The file extension. For example <q>png</q>. Currently supported file extensions are: <q>bmp</q>, <q>jpg</q>, <q>jpeg</q>, <q>png</q>, <q>wav</q>, <q>mp3</q>, <q>aac</q>, <q>json</q>. All others will be sent as binary files.</p> -</dd> + <dd><p>The file extension. For example <q>png</q>. Currently supported file extensions are: <q>bmp</q>, <q>jpg</q>, <q>jpeg</q>, <q>png</q>, <q>wav</q>, <q>mp3</q>, <q>aac</q>, <q>json</q>. All others will be sent as binary files.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of this class</p> - </div> </section> diff --git a/docs/Classes/SDLFileManager.html b/docs/Classes/SDLFileManager.html index 6d611a647..c32f1ce0d 100644 --- a/docs/Classes/SDLFileManager.html +++ b/docs/Classes/SDLFileManager.html @@ -132,7 +132,6 @@ <div> <h4>Return Value</h4> <p>nil</p> - </div> <h3 id="section--initWithConnectionManager:"> @@ -153,13 +152,11 @@ <h4>Parameters</h4> <dl> <dt>manager</dt> - <dd><p>A connection manager to use to forward on RPCs</p> -</dd> + <dd><p>A connection manager to use to forward on RPCs</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of SDLFileManager</p> - </div> <h3 id="section--startWithCompletionHandler:"> @@ -183,8 +180,7 @@ <h4>Parameters</h4> <dl> <dt>completionHandler</dt> - <dd><p>The handler called when the manager is set up or failed to set up with an error. Use weak self when accessing self from the completion handler.</p> -</dd> + <dd><p>The handler called when the manager is set up or failed to set up with an error. Use weak self when accessing self from the completion handler.</p></dd> </dl> <h3 id="section--stop"> @@ -227,11 +223,9 @@ <h4>Parameters</h4> <dl> <dt>name</dt> - <dd><p>The name of the remote file. It should be a name currently stored in remoteFileNames</p> -</dd> + <dd><p>The name of the remote file. It should be a name currently stored in remoteFileNames</p></dd> <dt>completion</dt> - <dd><p>An optional completion handler that sends an error should one occur.</p> -</dd> + <dd><p>An optional completion handler that sends an error should one occur.</p></dd> </dl> <h3 id="section--uploadFile:completionHandler:"> @@ -256,11 +250,9 @@ <h4>Parameters</h4> <dl> <dt>file</dt> - <dd><p>An SDLFile that contains metadata about the file to be sent</p> -</dd> + <dd><p>An SDLFile that contains metadata about the file to be sent</p></dd> <dt>completion</dt> - <dd><p>An optional completion handler that sends an error should one occur.</p> -</dd> + <dd><p>An optional completion handler that sends an error should one occur.</p></dd> </dl> <h3 id="section-+temporaryFileDirectory"> @@ -285,7 +277,6 @@ <div> <h4>Return Value</h4> <p>An NSURL pointing to the location on disk where SDL’s temporary files are stored.</p> - </div> </section> diff --git a/docs/Classes/SDLFileType.html b/docs/Classes/SDLFileType.html index 8f93fe009..3a05ad87d 100644 --- a/docs/Classes/SDLFileType.html +++ b/docs/Classes/SDLFileType.html @@ -43,13 +43,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String value to retrieve the object for</p> -</dd> + <dd><p>String value to retrieve the object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLFileType</p> - </div> <h3 id="section-+values"> @@ -72,7 +70,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLFileType</p> - </div> <h3 id="section-+GRAPHIC_BMP"> @@ -95,7 +92,6 @@ <div> <h4>Return Value</h4> <p>SDLFileType with value of <em>GRAPHIC_BMP</em></p> - </div> <h3 id="section-+GRAPHIC_JPEG"> @@ -118,7 +114,6 @@ <div> <h4>Return Value</h4> <p>SDLFileType with value of <em>GRAPHIC_JPEG</em></p> - </div> <h3 id="section-+GRAPHIC_PNG"> @@ -141,7 +136,6 @@ <div> <h4>Return Value</h4> <p>SDLFileType with value of <em>GRAPHIC_PNG</em></p> - </div> <h3 id="section-+AUDIO_WAVE"> @@ -164,7 +158,6 @@ <div> <h4>Return Value</h4> <p>SDLFileType with value of <em>AUDIO_WAVE</em></p> - </div> <h3 id="section-+AUDIO_MP3"> @@ -187,7 +180,6 @@ <div> <h4>Return Value</h4> <p>SDLFileType with value of <em>AUDIO_MP3</em></p> - </div> <h3 id="section-+AUDIO_AAC"> @@ -210,7 +202,6 @@ <div> <h4>Return Value</h4> <p>SDLFileType with value of <em>AUDIO_AAC</em></p> - </div> <h3 id="section-+BINARY"> @@ -233,7 +224,6 @@ <div> <h4>Return Value</h4> <p>SDLFileType with value of <em>BINARY</em></p> - </div> <h3 id="section-+JSON"> @@ -256,7 +246,6 @@ <div> <h4>Return Value</h4> <p>SDLFileType with value of <em>JSON</em></p> - </div> </section> diff --git a/docs/Classes/SDLFuelCutoffStatus.html b/docs/Classes/SDLFuelCutoffStatus.html index c705169cc..e247b3c58 100644 --- a/docs/Classes/SDLFuelCutoffStatus.html +++ b/docs/Classes/SDLFuelCutoffStatus.html @@ -39,13 +39,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String value to retrieve the object for</p> -</dd> + <dd><p>String value to retrieve the object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLFuelCutoffStatus</p> - </div> <h3 id="section-+values"> @@ -68,15 +66,13 @@ <div> <h4>Return Value</h4> <p>an array that stores all possible SDLFuelCutoffStatus</p> - </div> <h3 id="section-+TERMINATE_FUEL"> +TERMINATE_FUEL </h3> - <p>@abstract Fuel is cut off -- returns: the fuel cutoff status: <em>TERMINATE_FUEL</em></p> + <p>@abstract Fuel is cut off</p> @@ -92,15 +88,13 @@ <div> <h4>Return Value</h4> <p>the fuel cutoff status: <em>TERMINATE_FUEL</em></p> - </div> <h3 id="section-+NORMAL_OPERATION"> +NORMAL_OPERATION </h3> - <p>@abstract Fuel is not cut off -- returns: the fuel cutoff status: <em>NORMAL_OPERATION</em></p> + <p>@abstract Fuel is not cut off</p> @@ -116,15 +110,13 @@ <div> <h4>Return Value</h4> <p>the fuel cutoff status: <em>NORMAL_OPERATION</em></p> - </div> <h3 id="section-+FAULT"> +FAULT </h3> - <p>@abstract Status of the fuel pump cannot be determined -- returns: the fuel cutoff status: <em>FAULT</em></p> + <p>@abstract Status of the fuel pump cannot be determined</p> @@ -140,7 +132,6 @@ <div> <h4>Return Value</h4> <p>the fuel cutoff status: <em>FAULT</em></p> - </div> </section> diff --git a/docs/Classes/SDLGPSData.html b/docs/Classes/SDLGPSData.html index c54482b2c..d2f32091c 100644 --- a/docs/Classes/SDLGPSData.html +++ b/docs/Classes/SDLGPSData.html @@ -55,8 +55,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLGPSData object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLGPSData object indicated by the dictionary parameter</p> @@ -72,8 +71,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-longitudeDegrees"> diff --git a/docs/Classes/SDLGenericResponse.html b/docs/Classes/SDLGenericResponse.html index 62d1fdbc2..43b57c10d 100644 --- a/docs/Classes/SDLGenericResponse.html +++ b/docs/Classes/SDLGenericResponse.html @@ -24,7 +24,7 @@ INVALID_DATA is used.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGenericResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGenericResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -39,7 +39,7 @@ INVALID_DATA is used.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGenericResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGenericResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLGetDTCs.html b/docs/Classes/SDLGetDTCs.html index 6e6b9cb24..94359cf16 100644 --- a/docs/Classes/SDLGetDTCs.html +++ b/docs/Classes/SDLGetDTCs.html @@ -62,8 +62,7 @@ Function Group: ProprietaryData <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithECUName:"> @@ -75,7 +74,7 @@ Function Group: ProprietaryData <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCs</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCs</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -90,7 +89,7 @@ Function Group: ProprietaryData <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCs</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCs</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLGetDTCsResponse.html b/docs/Classes/SDLGetDTCsResponse.html index 1a4cbe10b..f31b4491d 100644 --- a/docs/Classes/SDLGetDTCsResponse.html +++ b/docs/Classes/SDLGetDTCsResponse.html @@ -26,7 +26,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCsResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCsResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -41,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCsResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCsResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -56,7 +56,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCsResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCsResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -71,7 +71,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCsResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetDTCsResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLGetSystemCapability.html b/docs/Classes/SDLGetSystemCapability.html new file mode 100644 index 000000000..42efb9862 --- /dev/null +++ b/docs/Classes/SDLGetSystemCapability.html @@ -0,0 +1,72 @@ +<h1>SDLGetSystemCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section--initWithType:">-initWithType:</a></li> + <li><a href="#section-systemCapabilityType">systemCapabilityType</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section--initWithType:"> + -initWithType: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-systemCapabilityType"> + systemCapabilityType + </h3> + + <p>They type of capability you’d like to receive in the response.</p> + +<p>Mandatory</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLSystemCapabilityType.html">SDLSystemCapabilityType</a></span> <span class="o">*</span><span class="n">systemCapabilityType</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">systemCapabilityType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSystemCapabilityType.html">SDLSystemCapabilityType</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLGetSystemCapabilityResponse.html b/docs/Classes/SDLGetSystemCapabilityResponse.html new file mode 100644 index 000000000..da728aa56 --- /dev/null +++ b/docs/Classes/SDLGetSystemCapabilityResponse.html @@ -0,0 +1,50 @@ +<h1>SDLGetSystemCapabilityResponse Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section-systemCapability">systemCapability</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-systemCapability"> + systemCapability + </h3> + + <p>Undocumented</p> + + + + + + +</section> diff --git a/docs/Classes/SDLGetVehicleData.html b/docs/Classes/SDLGetVehicleData.html index 405ebc637..7ab58125c 100644 --- a/docs/Classes/SDLGetVehicleData.html +++ b/docs/Classes/SDLGetVehicleData.html @@ -70,8 +70,7 @@ </h3> <p>@abstract Constructs a new SDLGetVehicleData object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -87,8 +86,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:vin:wiperStatus:"> @@ -100,7 +98,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -477,7 +475,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -492,7 +490,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -507,7 +505,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -522,7 +520,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -537,7 +535,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLGetVehicleDataResponse.html b/docs/Classes/SDLGetVehicleDataResponse.html index d8316b77c..fae4b1052 100644 --- a/docs/Classes/SDLGetVehicleDataResponse.html +++ b/docs/Classes/SDLGetVehicleDataResponse.html @@ -63,8 +63,7 @@ </h3> <p>@abstract Constructs a new SDLGetVehicleDataResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -80,8 +79,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-gps"> @@ -453,7 +451,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -468,7 +466,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -483,7 +481,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -498,7 +496,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -513,7 +511,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLGetWaypointsResponse.html b/docs/Classes/SDLGetWaypointsResponse.html index b485b1739..8484c00b4 100644 --- a/docs/Classes/SDLGetWaypointsResponse.html +++ b/docs/Classes/SDLGetWaypointsResponse.html @@ -17,7 +17,6 @@ </h3> <p>@abstract Array of waypoints</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLLocationDetails diff --git a/docs/Classes/SDLGlobalProperty.html b/docs/Classes/SDLGlobalProperty.html index 59b6d62fa..5455d0b8f 100644 --- a/docs/Classes/SDLGlobalProperty.html +++ b/docs/Classes/SDLGlobalProperty.html @@ -26,9 +26,7 @@ +valueOf: </h3> - <p>Convert String to SDLGlobalProperty -- parameter: value The value of the string to get an object for -- returns: SDLGlobalProperty</p> + <p>Convert String to SDLGlobalProperty</p> @@ -44,21 +42,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLGlobalProperty</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLGlobalProperty -- returns: An array that store all possible SDLGlobalProperty</p> + <p>@abstract Store the enumeration of all possible SDLGlobalProperty</p> @@ -74,15 +69,13 @@ <div> <h4>Return Value</h4> <p>An array that store all possible SDLGlobalProperty</p> - </div> <h3 id="section-+HELPPROMPT"> +HELPPROMPT </h3> - <p>@abstract The help prompt to be spoken if the user needs assistance during a user-initiated interaction. -- returns: A SDLGlobalProperty with value of <em>HELPPROMPT</em></p> + <p>@abstract The help prompt to be spoken if the user needs assistance during a user-initiated interaction.</p> @@ -98,15 +91,13 @@ <div> <h4>Return Value</h4> <p>A SDLGlobalProperty with value of <em>HELPPROMPT</em></p> - </div> <h3 id="section-+TIMEOUTPROMPT"> +TIMEOUTPROMPT </h3> - <p>@abstract The prompt to be spoken if the user-initiated interaction times out waiting for the user’s verbal input. -- returns: A SDLGlobalProperty with value of <em>TIMEOUTPROMPT</em></p> + <p>@abstract The prompt to be spoken if the user-initiated interaction times out waiting for the user’s verbal input.</p> @@ -122,7 +113,6 @@ <div> <h4>Return Value</h4> <p>A SDLGlobalProperty with value of <em>TIMEOUTPROMPT</em></p> - </div> <h3 id="section-+VRHELPTITLE"> @@ -134,7 +124,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -149,7 +139,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -164,7 +154,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -179,7 +169,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -194,7 +184,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGlobalProperty</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLHMICapabilities.html b/docs/Classes/SDLHMICapabilities.html index 0375ca4c9..25a517918 100644 --- a/docs/Classes/SDLHMICapabilities.html +++ b/docs/Classes/SDLHMICapabilities.html @@ -7,6 +7,7 @@ <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> <li><a href="#section-navigation">navigation</a></li> <li><a href="#section-phoneCall">phoneCall</a></li> + <li><a href="#section-videoStreaming">videoStreaming</a></li> </ul> <h3>Overview</h3> @@ -77,4 +78,24 @@ + <h3 id="section-videoStreaming"> + videoStreaming + </h3> + + <p>Availability of build in video streaming. True: Available, False: Not Available</p> + +<p>Boolean value. Optional.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">videoStreaming</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">videoStreaming</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + </section> diff --git a/docs/Classes/SDLHMILevel.html b/docs/Classes/SDLHMILevel.html index 0fb78035b..221a3a55c 100644 --- a/docs/Classes/SDLHMILevel.html +++ b/docs/Classes/SDLHMILevel.html @@ -39,13 +39,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String value to retrieve the object for</p> -</dd> + <dd><p>String value to retrieve the object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>Current HMI level</p> - </div> <h3 id="section-+values"> @@ -68,7 +66,6 @@ <div> <h4>Return Value</h4> <p>an array with all possible HMILevel values inside</p> - </div> <h3 id="section-+FULL"> @@ -91,7 +88,6 @@ <div> <h4>Return Value</h4> <p>the HMILevel with value of <em>FULL</em></p> - </div> <h3 id="section-+LIMITED"> @@ -114,7 +110,6 @@ <div> <h4>Return Value</h4> <p>the HMILevel with value of <em>LIMITED</em></p> - </div> <h3 id="section-+BACKGROUND"> @@ -152,7 +147,6 @@ <div> <h4>Return Value</h4> <p>the HMILevel with value of <em>BACKGROUND</em></p> - </div> <h3 id="section-+NONE"> @@ -177,7 +171,6 @@ <div> <h4>Return Value</h4> <p>the HMILevel with value of <em>NONE</em></p> - </div> </section> diff --git a/docs/Classes/SDLHMIPermissions.html b/docs/Classes/SDLHMIPermissions.html index 0cb9c69eb..027842ead 100644 --- a/docs/Classes/SDLHMIPermissions.html +++ b/docs/Classes/SDLHMIPermissions.html @@ -39,8 +39,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLHMIPermissions object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLHMIPermissions object indicated by the dictionary parameter</p> @@ -56,8 +55,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-allowed"> @@ -65,7 +63,6 @@ </h3> <p>@abstract 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 @@ -91,7 +88,6 @@ </h3> <p>@abstract 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/SDLHMIZoneCapabilities.html b/docs/Classes/SDLHMIZoneCapabilities.html index 58fe12f38..b657bb484 100644 --- a/docs/Classes/SDLHMIZoneCapabilities.html +++ b/docs/Classes/SDLHMIZoneCapabilities.html @@ -21,9 +21,7 @@ +valueOf: </h3> - <p>@abstract SDLHMIZoneCapabilities -- parameter: value The value of the string to get an object for -- returns: SDLHMIZoneCapabilities</p> + <p>@abstract SDLHMIZoneCapabilities</p> @@ -39,21 +37,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLHMIZoneCapabilities</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract store all possible SDLHMIZoneCapabilities values -- returns: an array with all possible SDLHMIZoneCapabilities values inside</p> + <p>@abstract store all possible SDLHMIZoneCapabilities values</p> @@ -69,15 +64,13 @@ <div> <h4>Return Value</h4> <p>an array with all possible SDLHMIZoneCapabilities values inside</p> - </div> <h3 id="section-+FRONT"> +FRONT </h3> - <p>@abstract Indicates HMI available for front seat passengers. -- returns: a SDLHMIZoneCapabilities with value of <em>FRONT</em></p> + <p>@abstract Indicates HMI available for front seat passengers.</p> @@ -93,15 +86,13 @@ <div> <h4>Return Value</h4> <p>a SDLHMIZoneCapabilities with value of <em>FRONT</em></p> - </div> <h3 id="section-+BACK"> +BACK </h3> - <p>@abstract Indicates HMI available for rear seat passengers. -- returns: a SDLHMIZoneCapabilities with value of <em>BACK</em></p> + <p>@abstract Indicates HMI available for rear seat passengers.</p> @@ -117,7 +108,6 @@ <div> <h4>Return Value</h4> <p>a SDLHMIZoneCapabilities with value of <em>BACK</em></p> - </div> </section> diff --git a/docs/Classes/SDLHapticRect.html b/docs/Classes/SDLHapticRect.html new file mode 100644 index 000000000..0287c2587 --- /dev/null +++ b/docs/Classes/SDLHapticRect.html @@ -0,0 +1,128 @@ +<h1>SDLHapticRect Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section--initWithId:rect:">-initWithId:rect:</a></li> + <li><a href="#section-id">id</a></li> + <li><a href="#section-rect">rect</a></li> +</ul> + +<h3>Overview</h3> + +<p>Defines spatial for each user control object for video streaming application</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>@abstract Constructs a newly allocated SDLHapticRect object</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>@abstract Constructs a newly allocated SDLHapticRect object indicated by the dictionary parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use</p></dd> + </dl> + + <h3 id="section--initWithId:rect:"> + -initWithId:rect: + </h3> + + <p>Create a SpatialStruct</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n">NSNumber</span> <span class="o">*</span><span class="p">)</span><span class="nv">id</span> <span class="nf">rect</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLRectangle.html">SDLRectangle</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">rect</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="nv">id</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span><span class="p">,</span> <span class="nv">rect</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRectangle.html">SDLRectangle</a></span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>id</dt> + <dd><p>The id of the rectangle</p></dd> + <dt>rect</dt> + <dd><p>The SDLRectangle to use as the bounding rectangle</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An new SDLHapticRect object</p> + </div> + + <h3 id="section-id"> + id + </h3> + + <p>A user control spatial identifier +Required, Integer, 0 - 2,000,000,000</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">id</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">id</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-rect"> + rect + </h3> + + <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"><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">rect</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rect</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRectangle.html">SDLRectangle</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLHeadLampStatus.html b/docs/Classes/SDLHeadLampStatus.html index f096caa7b..9875df892 100644 --- a/docs/Classes/SDLHeadLampStatus.html +++ b/docs/Classes/SDLHeadLampStatus.html @@ -39,8 +39,7 @@ </h3> <p>@abstract Constructs a new SDLHeadLampStatus object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -56,8 +55,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-lowBeamsOn"> @@ -105,7 +103,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLHeadLampStatus</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLHeadLampStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> diff --git a/docs/Classes/SDLIgnitionStableStatus.html b/docs/Classes/SDLIgnitionStableStatus.html index c4f6395c1..f252072ed 100644 --- a/docs/Classes/SDLIgnitionStableStatus.html +++ b/docs/Classes/SDLIgnitionStableStatus.html @@ -22,9 +22,7 @@ +valueOf: </h3> - <p>@abstract return SDLIgnitionStableStatus -- parameter: value The value of the string to get an object for -- returns: SDLIgnitionStableStatus</p> + <p>@abstract return SDLIgnitionStableStatus</p> @@ -40,21 +38,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLIgnitionStableStatus</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract store all possible SDLIgnitionStableStatus values -- returns: an array with all possible SDLIgnitionStableStatus values inside</p> + <p>@abstract store all possible SDLIgnitionStableStatus values</p> @@ -70,15 +65,13 @@ <div> <h4>Return Value</h4> <p>an array with all possible SDLIgnitionStableStatus values inside</p> - </div> <h3 id="section-+IGNITION_SWITCH_NOT_STABLE"> +IGNITION_SWITCH_NOT_STABLE </h3> - <p>@abstract The current ignition switch status is considered not to be stable. -- returns: the Ignition Stable Status with value of <em>IGNITION_SWITCH_NOT_STABLE</em></p> + <p>@abstract The current ignition switch status is considered not to be stable.</p> @@ -94,15 +87,13 @@ <div> <h4>Return Value</h4> <p>the Ignition Stable Status with value of <em>IGNITION_SWITCH_NOT_STABLE</em></p> - </div> <h3 id="section-+IGNITION_SWITCH_STABLE"> +IGNITION_SWITCH_STABLE </h3> - <p>@abstract The current ignition switch status is considered to be stable. -- returns: the Ignition Stable Status with value of <em>IGNITION_SWITCH_STABLE</em></p> + <p>@abstract The current ignition switch status is considered to be stable.</p> @@ -118,7 +109,6 @@ <div> <h4>Return Value</h4> <p>the Ignition Stable Status with value of <em>IGNITION_SWITCH_STABLE</em></p> - </div> <h3 id="section-+MISSING_FROM_TRANSMITTER"> @@ -130,7 +120,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLIgnitionStableStatus</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLIgnitionStableStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLIgnitionStatus.html b/docs/Classes/SDLIgnitionStatus.html index 6e775c9ad..957fca4b2 100644 --- a/docs/Classes/SDLIgnitionStatus.html +++ b/docs/Classes/SDLIgnitionStatus.html @@ -25,9 +25,7 @@ +valueOf: </h3> - <p>@abstract return SDLIgnitionStatus -- parameter: value The value of the string to get an object for -- returns: SDLIgnitionStatus object</p> + <p>@abstract return SDLIgnitionStatus</p> @@ -43,21 +41,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLIgnitionStatus object</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract store all possible SDLIgnitionStatus values -- returns: an array with all possible SDLIgnitionStatus values inside</p> + <p>@abstract store all possible SDLIgnitionStatus values</p> @@ -73,15 +68,13 @@ <div> <h4>Return Value</h4> <p>an array with all possible SDLIgnitionStatus values inside</p> - </div> <h3 id="section-+UNKNOWN"> +UNKNOWN </h3> - <p>@abstract Ignition status currently unknown -- returns: Ignition Status with value of <em>UNKNOWN</em></p> + <p>@abstract Ignition status currently unknown</p> @@ -97,15 +90,13 @@ <div> <h4>Return Value</h4> <p>Ignition Status with value of <em>UNKNOWN</em></p> - </div> <h3 id="section-+OFF"> +OFF </h3> - <p>@abstract Ignition is off -- returns: Ignition Status with value of <em>OFF</em></p> + <p>@abstract Ignition is off</p> @@ -121,15 +112,13 @@ <div> <h4>Return Value</h4> <p>Ignition Status with value of <em>OFF</em></p> - </div> <h3 id="section-+ACCESSORY"> +ACCESSORY </h3> - <p>@abstract Ignition is in mode accessory -- returns: Ignition Status with value of <em>ACCESSORY</em></p> + <p>@abstract Ignition is in mode accessory</p> @@ -145,15 +134,13 @@ <div> <h4>Return Value</h4> <p>Ignition Status with value of <em>ACCESSORY</em></p> - </div> <h3 id="section-+RUN"> +RUN </h3> - <p>@abstract Ignition is in mode run -- returns: Ignition Status with value of <em>RUN</em></p> + <p>@abstract Ignition is in mode run</p> @@ -169,15 +156,13 @@ <div> <h4>Return Value</h4> <p>Ignition Status with value of <em>RUN</em></p> - </div> <h3 id="section-+START"> +START </h3> - <p>@abstract Ignition is in mode start -- returns: Ignition Status with value of <em>START</em></p> + <p>@abstract Ignition is in mode start</p> @@ -193,15 +178,13 @@ <div> <h4>Return Value</h4> <p>Ignition Status with value of <em>START</em></p> - </div> <h3 id="section-+INVALID"> +INVALID </h3> - <p>@abstract Signal is invalid -- returns: Ignition Status with value of <em>INVALID</em></p> + <p>@abstract Signal is invalid</p> @@ -217,7 +200,6 @@ <div> <h4>Return Value</h4> <p>Ignition Status with value of <em>INVALID</em></p> - </div> </section> diff --git a/docs/Classes/SDLImage.html b/docs/Classes/SDLImage.html index fc3817204..f0fa034ac 100644 --- a/docs/Classes/SDLImage.html +++ b/docs/Classes/SDLImage.html @@ -40,8 +40,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLImage object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLImage object indicated by the dictionary parameter</p> @@ -57,8 +56,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithName:ofType:"> @@ -70,7 +68,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLImage</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLImage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> diff --git a/docs/Classes/SDLImageFieldName.html b/docs/Classes/SDLImageFieldName.html index c41c06c35..37ba5958e 100644 --- a/docs/Classes/SDLImageFieldName.html +++ b/docs/Classes/SDLImageFieldName.html @@ -23,10 +23,13 @@ <p>The name that identifies the filed. * - * - * @since SmartDeviceLink 3.0 *</p> +<ul> +<li>@since SmartDeviceLink 3.0 +*</li> +</ul> + <section class="section task-group-section"> <h3 id="section-+valueOf:"> @@ -38,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLImageFieldName</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLImageFieldName</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -53,7 +56,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLImageFieldName</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLImageFieldName</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLImageType.html b/docs/Classes/SDLImageType.html index f66196979..6790ca19b 100644 --- a/docs/Classes/SDLImageType.html +++ b/docs/Classes/SDLImageType.html @@ -37,13 +37,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>An SDLImageType</p> - </div> <h3 id="section-+values"> @@ -66,7 +64,6 @@ <div> <h4>Return Value</h4> <p>An array with all possible SDLImageType values inside</p> - </div> <h3 id="section-+STATIC"> @@ -89,7 +86,6 @@ <div> <h4>Return Value</h4> <p>The Image Type with value <em>STATIC</em></p> - </div> <h3 id="section-+DYNAMIC"> @@ -97,7 +93,6 @@ </h3> <p>@abstract Binary image file to be used (identifier to be sent by SDLPutFile)</p> - <div class="aside aside-see"> <p class="aside-title">See</p> <p>SDLPutFile</p> @@ -118,7 +113,6 @@ <div> <h4>Return Value</h4> <p>The Image Type with value <em>DYNAMIC</em></p> - </div> </section> diff --git a/docs/Classes/SDLInteractionMode.html b/docs/Classes/SDLInteractionMode.html index e3e3b7c9f..750b2ef8e 100644 --- a/docs/Classes/SDLInteractionMode.html +++ b/docs/Classes/SDLInteractionMode.html @@ -22,9 +22,7 @@ +valueOf: </h3> - <p>@abstract SDLInteractionMode -- parameter: value The value of the string to get an object for -- returns: SDLInteractionMode</p> + <p>@abstract SDLInteractionMode</p> @@ -40,21 +38,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLInteractionMode</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract store all possible SDLInteractionMode values -- returns: an array with all possible SDLInteractionMode values inside</p> + <p>@abstract store all possible SDLInteractionMode values</p> @@ -70,7 +65,6 @@ <div> <h4>Return Value</h4> <p>an array with all possible SDLInteractionMode values inside</p> - </div> <h3 id="section-+MANUAL_ONLY"> @@ -94,7 +88,6 @@ <div> <h4>Return Value</h4> <p>Current Interaction Mode with value of <em>MANUAL_ONLY</em></p> - </div> <h3 id="section-+VR_ONLY"> @@ -118,7 +111,6 @@ <div> <h4>Return Value</h4> <p>Current Interaction Mode with value of <em>VR_ONLY</em></p> - </div> <h3 id="section-+BOTH"> @@ -146,7 +138,6 @@ <div> <h4>Return Value</h4> <p>Current Interaction Mode with value of <em>BOTH</em></p> - </div> </section> diff --git a/docs/Classes/SDLKeyboardEvent.html b/docs/Classes/SDLKeyboardEvent.html index 1ca8cc9e0..6045bff77 100644 --- a/docs/Classes/SDLKeyboardEvent.html +++ b/docs/Classes/SDLKeyboardEvent.html @@ -15,10 +15,13 @@ <h3>Overview</h3> <p>Enumeration listing possible keyboard events. - * - * @since SmartDeviceLink 3.0 *</p> +<ul> +<li>@since SmartDeviceLink 3.0 +*</li> +</ul> + <section class="section task-group-section"> <h3 id="section-+valueOf:"> @@ -30,7 +33,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardEvent</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardEvent</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -45,7 +48,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardEvent</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardEvent</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLKeyboardLayout.html b/docs/Classes/SDLKeyboardLayout.html index 8f939e873..cde06447f 100644 --- a/docs/Classes/SDLKeyboardLayout.html +++ b/docs/Classes/SDLKeyboardLayout.html @@ -28,7 +28,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardLayout</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardLayout</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -43,7 +43,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardLayout</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardLayout</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLKeypressMode.html b/docs/Classes/SDLKeypressMode.html index 615484c04..186512fb5 100644 --- a/docs/Classes/SDLKeypressMode.html +++ b/docs/Classes/SDLKeypressMode.html @@ -12,12 +12,15 @@ <h3>Overview</h3> -<p>Enumeration listing possible keyboard events. - * <p> - * <b>Note:</b> Depending on keypressMode value (from keyboardProperties structure of UI.SetGlobalProperties),<br>HMI must send the onKeyboardInput notification with the following data:<br> - SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY. - * @since SmartDeviceLink 3.0 - *</p> +<p>Enumeration listing possible keyboard events.</p> + +<ul> +<li><p></li> +<li><b>Note:</b> Depending on keypressMode value (from keyboardProperties structure of UI.SetGlobalProperties),<br>HMI must send the onKeyboardInput notification with the following data:<br> +SINGLE_KEYPRESS,QUEUE_KEYPRESSES,RESEND_CURRENT_ENTRY.</li> +<li>@since SmartDeviceLink 3.0 +*</li> +</ul> <section class="section task-group-section"> @@ -30,7 +33,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeypressMode</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeypressMode</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -45,7 +48,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeypressMode</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeypressMode</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLLanguage.html b/docs/Classes/SDLLanguage.html index b478166e5..04ccbe36f 100644 --- a/docs/Classes/SDLLanguage.html +++ b/docs/Classes/SDLLanguage.html @@ -5,7 +5,22 @@ <ul> <li><a href="#section-+valueOf:">+valueOf:</a></li> <li><a href="#section-+values">+values</a></li> + <li><a href="#section-+EN_SA">+EN_SA</a></li> + <li><a href="#section-+HE_IL">+HE_IL</a></li> + <li><a href="#section-+RO_RO">+RO_RO</a></li> + <li><a href="#section-+UK_UA">+UK_UA</a></li> + <li><a href="#section-+ID_ID">+ID_ID</a></li> + <li><a href="#section-+VI_VN">+VI_VN</a></li> + <li><a href="#section-+MS_MY">+MS_MY</a></li> + <li><a href="#section-+HI_IN">+HI_IN</a></li> + <li><a href="#section-+NL_BE">+NL_BE</a></li> + <li><a href="#section-+EL_GR">+EL_GR</a></li> + <li><a href="#section-+HU_HU">+HU_HU</a></li> + <li><a href="#section-+FI_FI">+FI_FI</a></li> + <li><a href="#section-+SK_SK">+SK_SK</a></li> <li><a href="#section-+EN_US">+EN_US</a></li> + <li><a href="#section-+EN_IN">+EN_IN</a></li> + <li><a href="#section-+TH_TH">+TH_TH</a></li> <li><a href="#section-+ES_MX">+ES_MX</a></li> <li><a href="#section-+FR_CA">+FR_CA</a></li> <li><a href="#section-+DE_DE">+DE_DE</a></li> @@ -59,13 +74,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>The Language</p> - </div> <h3 id="section-+values"> @@ -88,9 +101,203 @@ <div> <h4>Return Value</h4> <p>an array with all possible Language values inside</p> - </div> + <h3 id="section-+EN_SA"> + +EN_SA + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+HE_IL"> + +HE_IL + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+RO_RO"> + +RO_RO + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+UK_UA"> + +UK_UA + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+ID_ID"> + +ID_ID + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+VI_VN"> + +VI_VN + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+MS_MY"> + +MS_MY + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+HI_IN"> + +HI_IN + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+NL_BE"> + +NL_BE + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+EL_GR"> + +EL_GR + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+HU_HU"> + +HU_HU + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+FI_FI"> + +FI_FI + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+SK_SK"> + +SK_SK + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + <h3 id="section-+EN_US"> +EN_US </h3> @@ -100,7 +307,37 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+EN_IN"> + +EN_IN + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> + + + + + + <h3 id="section-+TH_TH"> + +TH_TH + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLanguage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLLayoutMode.html b/docs/Classes/SDLLayoutMode.html index ddc0311d1..6fa61cc8e 100644 --- a/docs/Classes/SDLLayoutMode.html +++ b/docs/Classes/SDLLayoutMode.html @@ -29,7 +29,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLayoutMode</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLayoutMode</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> @@ -44,7 +44,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLayoutMode</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLayoutMode</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLLifecycleConfiguration.html b/docs/Classes/SDLLifecycleConfiguration.html index dd5713f27..a2f02a81b 100644 --- a/docs/Classes/SDLLifecycleConfiguration.html +++ b/docs/Classes/SDLLifecycleConfiguration.html @@ -60,23 +60,20 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">defaultConfiguration</span><span class="p">(</span><span class="n">withAppName</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLLifecycleConfiguration</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">defaultConfiguration</span><span class="p">(</span><span class="n">withAppName</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">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="o">-></span> <span class="kt">SDLLifecycleConfiguration</span></code></pre> <h4>Parameters</h4> <dl> <dt>appName</dt> - <dd><p>The name of the app.</p> -</dd> + <dd><p>The name of the app.</p></dd> <dt>appId</dt> - <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p> -</dd> + <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p></dd> </dl> <div> <h4>Return Value</h4> <p>The lifecycle configuration</p> - </div> <h3 id="section-+debugConfigurationWithAppName:appId:ipAddress:port:"> @@ -96,29 +93,24 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">debugConfiguration</span><span class="p">(</span><span class="n">withAppName</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">ipAddress</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLLifecycleConfiguration</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">debugConfiguration</span><span class="p">(</span><span class="n">withAppName</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">ipAddress</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLLifecycleConfiguration</span></code></pre> <h4>Parameters</h4> <dl> <dt>appName</dt> - <dd><p>The name of the app.</p> -</dd> + <dd><p>The name of the app.</p></dd> <dt>appId</dt> - <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p> -</dd> + <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p></dd> <dt>ipAddress</dt> - <dd><p>The ip address of the server to connect to</p> -</dd> + <dd><p>The ip address of the server to connect to</p></dd> <dt>port</dt> - <dd><p>The port of the server to connect to</p> -</dd> + <dd><p>The port of the server to connect to</p></dd> </dl> <div> <h4>Return Value</h4> <p>The lifecycle configuration</p> - </div> <h3 id="section-tcpDebugMode"> @@ -134,7 +126,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugMode</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugMode</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -152,6 +144,9 @@ <span class="n">NSString</span> <span class="o">*</span><span class="n">tcpDebugIPAddress</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugIPAddress</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -168,7 +163,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugPort</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugPort</span><span class="p">:</span> <span class="kt">UInt16</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -185,6 +180,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appName</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -200,6 +198,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appId</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -215,6 +216,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">resumeHash</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">resumeHash</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -231,7 +235,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">isMedia</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isMedia</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -267,7 +271,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -285,6 +289,9 @@ <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">languagesSupported</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">languagesSupported</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -318,6 +325,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">shortAppName</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">shortAppName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -333,6 +343,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">ttsName</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ttsName</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -349,6 +362,9 @@ <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">voiceRecognitionCommandNames</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">voiceRecognitionCommandNames</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -381,7 +397,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">logFlags</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">logFlags</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogOutput.html">SDLLogOutput</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> diff --git a/docs/Classes/SDLListFiles.html b/docs/Classes/SDLListFiles.html index 1d77efcae..555405db2 100644 --- a/docs/Classes/SDLListFiles.html +++ b/docs/Classes/SDLListFiles.html @@ -56,8 +56,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLListFilesResponse.html b/docs/Classes/SDLListFilesResponse.html index c9fefa8f1..9b2157794 100644 --- a/docs/Classes/SDLListFilesResponse.html +++ b/docs/Classes/SDLListFilesResponse.html @@ -26,7 +26,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLListFilesResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLListFilesResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -41,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLListFilesResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLListFilesResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -56,7 +56,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLListFilesResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLListFilesResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -71,7 +71,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLListFilesResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLListFilesResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLLocationDetails.html b/docs/Classes/SDLLocationDetails.html index 7107c4743..45b5c0a9d 100644 --- a/docs/Classes/SDLLocationDetails.html +++ b/docs/Classes/SDLLocationDetails.html @@ -23,7 +23,6 @@ </h3> <p>@abstract Latitude/Longitude of the location</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLLocationCoordinate @@ -129,7 +128,6 @@ </h3> <p>@abstract Image / icon of intended location.</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLImage @@ -155,7 +153,6 @@ </h3> <p>@abstract 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/SDLLockScreenConfiguration.html b/docs/Classes/SDLLockScreenConfiguration.html index f91586320..419ea68cb 100644 --- a/docs/Classes/SDLLockScreenConfiguration.html +++ b/docs/Classes/SDLLockScreenConfiguration.html @@ -34,7 +34,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">showInOptionalState</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">showInOptionalState</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -52,7 +52,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">enableAutomaticLockScreen</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">enableAutomaticLockScreen</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -69,6 +69,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UIColor</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">backgroundColor</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt">UIColor</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -84,6 +87,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIImage</span> <span class="o">*</span><span class="n">appIcon</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">appIcon</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -100,6 +106,9 @@ <span class="n">UIViewController</span> <span class="o">*</span><span class="n">customViewController</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">customViewController</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -127,14 +136,13 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">disabled</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">disabled</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre> <div> <h4>Return Value</h4> <p>The configuration</p> - </div> <h3 id="section-+enabledConfiguration"> @@ -150,14 +158,13 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">enabled</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">enabled</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre> <div> <h4>Return Value</h4> <p>The configuration</p> - </div> <h3 id="section-+enabledConfigurationWithAppIcon:backgroundColor:"> @@ -175,23 +182,20 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">enabledConfiguration</span><span class="p">(</span><span class="n">withAppIcon</span> <span class="nv">lockScreenAppIcon</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)backgroundColor">backgroundColor</a></span> <span class="nv">lockScreenBackgroundColor</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">enabledConfiguration</span><span class="p">(</span><span class="n">withAppIcon</span> <span class="nv">lockScreenAppIcon</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">,</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html#/c:objc(cs)SDLLockScreenConfiguration(py)backgroundColor">backgroundColor</a></span> <span class="nv">lockScreenBackgroundColor</span><span class="p">:</span> <span class="kt">UIColor</span><span class="p">?)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> <h4>Parameters</h4> <dl> <dt>lockScreenAppIcon</dt> - <dd><p>The app icon to be shown on the lock screen</p> -</dd> + <dd><p>The app icon to be shown on the lock screen</p></dd> <dt>lockScreenBackgroundColor</dt> - <dd><p>The color of the lock screen background</p> -</dd> + <dd><p>The color of the lock screen background</p></dd> </dl> <div> <h4>Return Value</h4> <p>The configuration</p> - </div> <h3 id="section-+enabledConfigurationWithViewController:"> @@ -208,20 +212,18 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">enabledConfiguration</span><span class="p">(</span><span class="n">withViewController</span> <span class="nv">viewController</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">enabledConfiguration</span><span class="p">(</span><span class="n">with</span> <span class="nv">viewController</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> <h4>Parameters</h4> <dl> <dt>viewController</dt> - <dd><p>The view controller to be managed</p> -</dd> + <dd><p>The view controller to be managed</p></dd> </dl> <div> <h4>Return Value</h4> <p>The configuration</p> - </div> </section> diff --git a/docs/Classes/SDLLockScreenViewController.html b/docs/Classes/SDLLockScreenViewController.html index fac5b3e94..da3cf7465 100644 --- a/docs/Classes/SDLLockScreenViewController.html +++ b/docs/Classes/SDLLockScreenViewController.html @@ -26,6 +26,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIImage</span> <span class="o">*</span><span class="n">appIcon</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">appIcon</span><span class="p">:</span> <span class="kt">UIImage</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> + @@ -41,6 +44,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIImage</span> <span class="o">*</span><span class="n">vehicleIcon</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">vehicleIcon</span><span class="p">:</span> <span class="kt">UIImage</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> + @@ -56,6 +62,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIColor</span> <span class="o">*</span><span class="n">backgroundColor</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">backgroundColor</span><span class="p">:</span> <span class="kt">UIColor</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> + diff --git a/docs/Classes/SDLMaintenanceModeStatus.html b/docs/Classes/SDLMaintenanceModeStatus.html index 406bb7d0a..d5773a333 100644 --- a/docs/Classes/SDLMaintenanceModeStatus.html +++ b/docs/Classes/SDLMaintenanceModeStatus.html @@ -21,9 +21,7 @@ +valueOf: </h3> - <p>@abstract Maintenance Mode Status -- parameter: value The value of the string to get an object for -- returns: SDLMaintenanceModeStatus</p> + <p>@abstract Maintenance Mode Status</p> @@ -39,21 +37,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLMaintenanceModeStatus</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract declare an array that store all possible Maintenance Mode Status inside -- returns: the array</p> + <p>@abstract declare an array that store all possible Maintenance Mode Status inside</p> @@ -69,15 +64,13 @@ <div> <h4>Return Value</h4> <p>the array</p> - </div> <h3 id="section-+NORMAL"> +NORMAL </h3> - <p>@abstract Maintenance Mode Status : Normal -- returns: the object with value of <em>NORMAL</em></p> + <p>@abstract Maintenance Mode Status : Normal</p> @@ -93,15 +86,13 @@ <div> <h4>Return Value</h4> <p>the object with value of <em>NORMAL</em></p> - </div> <h3 id="section-+NEAR"> +NEAR </h3> - <p>@abstract Maintenance Mode Status : Near -- returns: the object with value of <em>NEAR</em></p> + <p>@abstract Maintenance Mode Status : Near</p> @@ -117,15 +108,13 @@ <div> <h4>Return Value</h4> <p>the object with value of <em>NEAR</em></p> - </div> <h3 id="section-+ACTIVE"> +ACTIVE </h3> - <p>@abstract Maintenance Mode Status : Active -- returns: the object with value of <em>ACTIVE</em></p> + <p>@abstract Maintenance Mode Status : Active</p> @@ -141,15 +130,13 @@ <div> <h4>Return Value</h4> <p>the object with value of <em>ACTIVE</em></p> - </div> <h3 id="section-+FEATURE_NOT_PRESENT"> +FEATURE_NOT_PRESENT </h3> - <p>@abstract Maintenance Mode Status : Feature not present -- returns: the object with value of <em>FEATURE_NOT_PRESENT</em></p> + <p>@abstract Maintenance Mode Status : Feature not present</p> @@ -165,7 +152,6 @@ <div> <h4>Return Value</h4> <p>the object with value of <em>FEATURE_NOT_PRESENT</em></p> - </div> </section> diff --git a/docs/Classes/SDLManager.html b/docs/Classes/SDLManager.html index 4987c3567..9c78435f5 100644 --- a/docs/Classes/SDLManager.html +++ b/docs/Classes/SDLManager.html @@ -180,16 +180,13 @@ <h4>Parameters</h4> <dl> <dt>configuration</dt> - <dd><p>Your app’s unique configuration for setup.</p> -</dd> + <dd><p>Your app’s unique configuration for setup.</p></dd> <dt>delegate</dt> - <dd><p>An optional delegate to be notified of hmi level changes and startup and shutdown. It is recommended that you implement this.</p> -</dd> + <dd><p>An optional delegate to be notified of hmi level changes and startup and shutdown. It is recommended that you implement this.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An instance of SDLManager</p> - </div> <h3 id="section--startWithReadyHandler:"> @@ -212,8 +209,7 @@ <h4>Parameters</h4> <dl> <dt>readyHandler</dt> - <dd><p>The block called when the manager is ready to be used or an error occurs while attempting to become ready.</p> -</dd> + <dd><p>The block called when the manager is ready to be used or an error occurs while attempting to become ready.</p></dd> </dl> <h3 id="section--stop"> @@ -256,8 +252,7 @@ <h4>Parameters</h4> <dl> <dt>request</dt> - <dd><p>The RPC request to send</p> -</dd> + <dd><p>The RPC request to send</p></dd> </dl> <h3 id="section--sendRequest:withResponseHandler:"> @@ -281,11 +276,9 @@ <h4>Parameters</h4> <dl> <dt>request</dt> - <dd><p>The RPC request to send</p> -</dd> + <dd><p>The RPC request to send</p></dd> <dt>handler</dt> - <dd><p>The handler that will be called when the response returns</p> -</dd> + <dd><p>The handler that will be called when the response returns</p></dd> </dl> </section> diff --git a/docs/Classes/SDLMediaClockFormat.html b/docs/Classes/SDLMediaClockFormat.html index 77de53323..fa4447faa 100644 --- a/docs/Classes/SDLMediaClockFormat.html +++ b/docs/Classes/SDLMediaClockFormat.html @@ -47,13 +47,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLMediaClockFormat</p> - </div> <h3 id="section-+values"> @@ -76,7 +74,6 @@ <div> <h4>Return Value</h4> <p>the array</p> - </div> <h3 id="section-+CLOCK1"> @@ -107,11 +104,6 @@ - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCK1</em></p> - - </div> <h3 id="section-+CLOCK2"> +CLOCK2 @@ -140,7 +132,6 @@ <div> <h4>Return Value</h4> <p>The SDLMediaClockFormat object with value <em>CLOCK2</em></p> - </div> <h3 id="section-+CLOCK3"> @@ -156,8 +147,7 @@ <li>maxSeconds = 59</li> </ul></p> -<p>@since SDL 2.0 - - returns: The SDLMediaClockFormat object with value <em>CLOCK3</em></p> +<p>@since SDL 2.0</p> @@ -173,7 +163,6 @@ <div> <h4>Return Value</h4> <p>The SDLMediaClockFormat object with value <em>CLOCK3</em></p> - </div> <h3 id="section-+CLOCKTEXT1"> @@ -207,7 +196,6 @@ <div> <h4>Return Value</h4> <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT1</em></p> - </div> <h3 id="section-+CLOCKTEXT2"> @@ -243,7 +231,6 @@ <div> <h4>Return Value</h4> <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT2</em></p> - </div> <h3 id="section-+CLOCKTEXT3"> @@ -279,7 +266,6 @@ <div> <h4>Return Value</h4> <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT3</em></p> - </div> <h3 id="section-+CLOCKTEXT4"> @@ -297,8 +283,7 @@ <li>used for MFD3/4/5 headunits</li> </ul></p> -<p>@since SDL 2.0 - - returns: The SDLMediaClockFormat object with value <em>CLOCKTEXT4</em></p> +<p>@since SDL 2.0</p> @@ -314,7 +299,6 @@ <div> <h4>Return Value</h4> <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT4</em></p> - </div> </section> diff --git a/docs/Classes/SDLMenuParams.html b/docs/Classes/SDLMenuParams.html index c33e4b647..f4d86003e 100644 --- a/docs/Classes/SDLMenuParams.html +++ b/docs/Classes/SDLMenuParams.html @@ -42,8 +42,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLMenuParams object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLMenuParams object indicated by the dictionary parameter</p> @@ -59,8 +58,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithMenuName:"> @@ -72,7 +70,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLMenuParams</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLMenuParams</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> @@ -87,7 +85,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLMenuParams</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLMenuParams</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> diff --git a/docs/Classes/SDLMetadataTags.html b/docs/Classes/SDLMetadataTags.html new file mode 100644 index 000000000..932a086dc --- /dev/null +++ b/docs/Classes/SDLMetadataTags.html @@ -0,0 +1,185 @@ +<h1>SDLMetadataTags Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section--initWithTextFieldTypes:mainField2:">-initWithTextFieldTypes:mainField2:</a></li> + <li><a href="#section--initWithTextFieldTypes:mainField2:mainField3:mainField4:">-initWithTextFieldTypes:mainField2:mainField3:mainField4:</a></li> + <li><a href="#section-mainField1">mainField1</a></li> + <li><a href="#section-mainField2">mainField2</a></li> + <li><a href="#section-mainField3">mainField3</a></li> + <li><a href="#section-mainField4">mainField4</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>@abstract Constructs a newly allocated SDLMetadataTags object</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>@abstract Constructs a newly allocated SDLMetadataTags object indicated by the dictionary parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use to construct the object</p></dd> + </dl> + + <h3 id="section--initWithTextFieldTypes:mainField2:"> + -initWithTextFieldTypes:mainField2: + </h3> + + <p>@abstract Constructs a newly allocated SDLMetadataTags object with NSArrays</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTextFieldTypes</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLMetadataType.html">SDLMetadataType</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">mainField1</span> + <span class="nf">mainField2</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLMetadataType.html">SDLMetadataType</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">mainField2</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">textFieldTypes</span> <span class="nv">mainField1</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLMetadataType.html">SDLMetadataType</a></span><span class="p">]</span><span class="o">!</span><span class="p">,</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLMetadataType.html">SDLMetadataType</a></span><span class="p">]</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + + <h3 id="section--initWithTextFieldTypes:mainField2:mainField3:mainField4:"> + -initWithTextFieldTypes:mainField2:mainField3:mainField4: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-mainField1"> + mainField1 + </h3> + + <p>@abstract The type of data contained in the <q>mainField1</q> text field, Optional.</p> + +<p>minsize= 0</p> + +<p>maxsize= 5</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSMutableArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLMetadataType.html">SDLMetadataType</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">mainField1</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">mainField1</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-mainField2"> + mainField2 + </h3> + + <p>@abstract The type of data contained in the <q>mainField2</q> text field, Optional.</p> + +<p>minsize= 0</p> + +<p>maxsize= 5</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSMutableArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLMetadataType.html">SDLMetadataType</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">mainField2</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-mainField3"> + mainField3 + </h3> + + <p>@abstract The type of data contained in the <q>mainField3</q> text field, Optional.</p> + +<p>minsize= 0</p> + +<p>maxsize= 5</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSMutableArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLMetadataType.html">SDLMetadataType</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">mainField3</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">mainField3</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-mainField4"> + mainField4 + </h3> + + <p>@abstract The type of data contained in the <q>mainField4</q> text field, Optional.</p> + +<p>minsize= 0</p> + +<p>maxsize= 5</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSMutableArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLMetadataType.html">SDLMetadataType</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">mainField4</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">mainField4</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLMetadataType.html b/docs/Classes/SDLMetadataType.html new file mode 100644 index 000000000..c7cd6ec99 --- /dev/null +++ b/docs/Classes/SDLMetadataType.html @@ -0,0 +1,343 @@ +<h1>SDLMetadataType Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-+valueOf:">+valueOf:</a></li> + <li><a href="#section-+values">+values</a></li> + <li><a href="#section-+MEDIA_TITLE">+MEDIA_TITLE</a></li> + <li><a href="#section-+MEDIA_ARTIST">+MEDIA_ARTIST</a></li> + <li><a href="#section-+MEDIA_ALBUM">+MEDIA_ALBUM</a></li> + <li><a href="#section-+MEDIA_YEAR">+MEDIA_YEAR</a></li> + <li><a href="#section-+MEDIA_GENRE">+MEDIA_GENRE</a></li> + <li><a href="#section-+MEDIA_STATION">+MEDIA_STATION</a></li> + <li><a href="#section-+RATING">+RATING</a></li> + <li><a href="#section-+CURRENT_TEMPERATURE">+CURRENT_TEMPERATURE</a></li> + <li><a href="#section-+MAXIMUM_TEMPERATURE">+MAXIMUM_TEMPERATURE</a></li> + <li><a href="#section-+MINIMUM_TEMPERATURE">+MINIMUM_TEMPERATURE</a></li> + <li><a href="#section-+WEATHER_TERM">+WEATHER_TERM</a></li> + <li><a href="#section-+HUMIDITY">+HUMIDITY</a></li> +</ul> + +<h3>Overview</h3> + +<p>The list of possible metadata for text fields</p> + +<p>@since SDL 4.7.0</p> + + +<section class="section task-group-section"> + <h3 id="section-+valueOf:"> + +valueOf: + </h3> + + <p>Convert String to SDLTextAlignment</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">(</span><span class="n">of</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>value</dt> + <dd><p>The value of the string to get an object for</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>SDLTextAlignment</p> + </div> + + <h3 id="section-+values"> + +values + </h3> + + <p>@abstract Store the enumeration of all possible SDLTextFieldType</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>an array that store all possible SDLTextFieldType</p> + </div> + + <h3 id="section-+MEDIA_TITLE"> + +MEDIA_TITLE + </h3> + + <p>@abstract The data in this field contains the title of the currently playing audio track.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">MEDIA_TITLE</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">media_TITLE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>MEDIA_TITLE</em></p> + </div> + + <h3 id="section-+MEDIA_ARTIST"> + +MEDIA_ARTIST + </h3> + + <p>@abstract The data in this field contains the artist or creator of the currently playing audio track.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">MEDIA_ARTIST</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">media_ARTIST</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>MEDIA_ARTIST</em></p> + </div> + + <h3 id="section-+MEDIA_ALBUM"> + +MEDIA_ALBUM + </h3> + + <p>@abstract The data in this field contains the album title of the currently playing audio track.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">MEDIA_ALBUM</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">media_ALBUM</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>MEDIA_ALBUM</em></p> + </div> + + <h3 id="section-+MEDIA_YEAR"> + +MEDIA_YEAR + </h3> + + <p>@abstract The data in this field contains the creation year of the currently playing audio track.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">MEDIA_YEAR</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">media_YEAR</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>MEDIA_YEAR</em></p> + </div> + + <h3 id="section-+MEDIA_GENRE"> + +MEDIA_GENRE + </h3> + + <p>@abstract The data in this field contains the genre of the currently playing audio track.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">MEDIA_GENRE</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">media_GENRE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>MEDIA_GENRE</em></p> + </div> + + <h3 id="section-+MEDIA_STATION"> + +MEDIA_STATION + </h3> + + <p>@abstract The data in this field contains the name of the current source for the media.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">MEDIA_STATION</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">media_STATION</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>MEDIA_STATION</em></p> + </div> + + <h3 id="section-+RATING"> + +RATING + </h3> + + <p>@abstract The data in this field is a rating.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">RATING</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">rating</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>RATING</em></p> + </div> + + <h3 id="section-+CURRENT_TEMPERATURE"> + +CURRENT_TEMPERATURE + </h3> + + <p>@abstract The data in this field is the current temperature.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">CURRENT_TEMPERATURE</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">current_TEMPERATURE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>CURRENT_TEMPERATURE</em></p> + </div> + + <h3 id="section-+MAXIMUM_TEMPERATURE"> + +MAXIMUM_TEMPERATURE + </h3> + + <p>@abstract The data in this field is the maximum temperature for the day.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">MAXIMUM_TEMPERATURE</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">maximum_TEMPERATURE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>MAXIMUM_TEMPERATURE</em></p> + </div> + + <h3 id="section-+MINIMUM_TEMPERATURE"> + +MINIMUM_TEMPERATURE + </h3> + + <p>@abstract The data in this field is the minimum temperature for the day.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">MINIMUM_TEMPERATURE</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">minimum_TEMPERATURE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>MINIMUM_TEMPERATURE</em></p> + </div> + + <h3 id="section-+WEATHER_TERM"> + +WEATHER_TERM + </h3> + + <p>@abstract The data in this field describes the current weather (ex. cloudy, clear, etc.).</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">WEATHER_TERM</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">weather_TERM</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>WEATHER_TERM</em></p> + </div> + + <h3 id="section-+HUMIDITY"> + +HUMIDITY + </h3> + + <p>@abstract The data in this field describes the current humidity value.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMetadataType</span> <span class="o">*</span><span class="p">)</span><span class="n">HUMIDITY</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">humidity</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMetadataType</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A SDLTextFieldType object with value of <em>HUMIDITY</em></p> + </div> + +</section> diff --git a/docs/Classes/SDLNavigationCapability.html b/docs/Classes/SDLNavigationCapability.html new file mode 100644 index 000000000..86573be7a --- /dev/null +++ b/docs/Classes/SDLNavigationCapability.html @@ -0,0 +1,109 @@ +<h1>SDLNavigationCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section--initWithSendLocation:waypoints:">-initWithSendLocation:waypoints:</a></li> + <li><a href="#section-sendLocationEnabled">sendLocationEnabled</a></li> + <li><a href="#section-getWayPointsEnabled">getWayPointsEnabled</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>@abstract Constructs a newly allocated SDLNavigationCapability struct</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>@abstract Constructs a newly allocated SDLNavigationCapability struct indicated by the dictionary parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use</p></dd> + </dl> + + <h3 id="section--initWithSendLocation:waypoints:"> + -initWithSendLocation:waypoints: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-sendLocationEnabled"> + sendLocationEnabled + </h3> + + <p>Whether or not the SendLocation RPC is enabled. +Boolean, optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">sendLocationEnabled</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">sendLocationEnabled</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-getWayPointsEnabled"> + getWayPointsEnabled + </h3> + + <p>Whether or not Waypoint related RPCs are enabled. +Boolean, optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">getWayPointsEnabled</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">getWayPointsEnabled</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLOnAppInterfaceUnregistered.html b/docs/Classes/SDLOnAppInterfaceUnregistered.html index 2e8bcfdb9..787d52812 100644 --- a/docs/Classes/SDLOnAppInterfaceUnregistered.html +++ b/docs/Classes/SDLOnAppInterfaceUnregistered.html @@ -14,8 +14,12 @@ <p>For more information about SDL resources related to an interface registration, see <i>SDLRegisterAppInterface</i>.</p> -<p>@since SDL 1.0 - - see: SDLRegisterAppInterface</p> +<p>@since SDL 1.0</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLRegisterAppInterface + +</div> <section class="section task-group-section"> @@ -41,8 +45,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLOnAppInterfaceUnregistered object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLOnAppInterfaceUnregistered object indicated by the dictionary parameter</p> @@ -58,8 +61,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-reason"> diff --git a/docs/Classes/SDLOnAudioPassThru.html b/docs/Classes/SDLOnAudioPassThru.html index 7e9a97520..db59ea22e 100644 --- a/docs/Classes/SDLOnAudioPassThru.html +++ b/docs/Classes/SDLOnAudioPassThru.html @@ -51,8 +51,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLOnAudioPassThru object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLOnAudioPassThru object indicated by the dictionary parameter</p> @@ -68,8 +67,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLOnButtonEvent.html b/docs/Classes/SDLOnButtonEvent.html index 469b99be6..ac44b9145 100644 --- a/docs/Classes/SDLOnButtonEvent.html +++ b/docs/Classes/SDLOnButtonEvent.html @@ -19,8 +19,7 @@ and button-presses can be found at SDLSubscribeButton. <p> </p> - -<p><b>HMI Status Requirements:</b> + <b>HMI Status Requirements:</b> <ul> HMILevel: <ul> @@ -46,9 +45,9 @@ <p></p> <div class="aside aside-see"> <p class="aside-title">See</p> - SDLSubscribeButton</p> + SDLSubscribeButton -<p></div></p> +</div> <p>@since SDL 1.0</p> @@ -92,8 +91,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-buttonName"> diff --git a/docs/Classes/SDLOnButtonPress.html b/docs/Classes/SDLOnButtonPress.html index 9f2df2ccd..d9748f0ea 100644 --- a/docs/Classes/SDLOnButtonPress.html +++ b/docs/Classes/SDLOnButtonPress.html @@ -47,13 +47,11 @@ 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 @@ -102,8 +100,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-buttonName"> @@ -111,7 +108,6 @@ </h3> <p>@abstract the button’s name</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLButtonName @@ -137,7 +133,6 @@ </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 diff --git a/docs/Classes/SDLOnCommand.html b/docs/Classes/SDLOnCommand.html index 035d537b4..aaeaa18ed 100644 --- a/docs/Classes/SDLOnCommand.html +++ b/docs/Classes/SDLOnCommand.html @@ -16,8 +16,12 @@ <p><b>Note:</b> The sequence of <em>SDLOnHMIStatus</em> and <em>SDLOnCommand</em> notifications for user-initiated interactions is indeterminate.</p> -<p>@since SDL 1.0 - - see: SDLAddCommand SDLDeleteCommand SDLDeleteSubMenu</p> +<p>@since SDL 1.0</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAddCommand SDLDeleteCommand SDLDeleteSubMenu + +</div> <section class="section task-group-section"> @@ -43,8 +47,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLRPCNotification object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLRPCNotification object indicated by the dictionary parameter</p> @@ -60,8 +63,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-cmdID"> diff --git a/docs/Classes/SDLOnDriverDistraction.html b/docs/Classes/SDLOnDriverDistraction.html index e055186c2..95756c227 100644 --- a/docs/Classes/SDLOnDriverDistraction.html +++ b/docs/Classes/SDLOnDriverDistraction.html @@ -66,8 +66,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-state"> diff --git a/docs/Classes/SDLOnHMIStatus.html b/docs/Classes/SDLOnHMIStatus.html index 59622b448..4e4048e31 100644 --- a/docs/Classes/SDLOnHMIStatus.html +++ b/docs/Classes/SDLOnHMIStatus.html @@ -66,8 +66,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-hmiLevel"> diff --git a/docs/Classes/SDLOnLanguageChange.html b/docs/Classes/SDLOnLanguageChange.html index 4ec9d4517..290dec8c8 100644 --- a/docs/Classes/SDLOnLanguageChange.html +++ b/docs/Classes/SDLOnLanguageChange.html @@ -39,8 +39,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLOnLanguageChange object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLOnLanguageChange object indicated by the dictionary parameter</p> @@ -56,8 +55,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-language"> diff --git a/docs/Classes/SDLOnLockScreenStatus.html b/docs/Classes/SDLOnLockScreenStatus.html index 62df091a5..3a31b66b5 100644 --- a/docs/Classes/SDLOnLockScreenStatus.html +++ b/docs/Classes/SDLOnLockScreenStatus.html @@ -32,7 +32,7 @@ The call back also includes details regarding the current HMI_Status level, driv <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnLockScreenStatus</span> <span class="p">:</span> <span class="nc">SDLRPCNotification</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnLockScreenStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCNotification.html">SDLRPCNotification</a></span></code></pre> @@ -47,7 +47,7 @@ The call back also includes details regarding the current HMI_Status level, driv <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnLockScreenStatus</span> <span class="p">:</span> <span class="nc">SDLRPCNotification</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnLockScreenStatus</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCNotification.html">SDLRPCNotification</a></span></code></pre> @@ -73,7 +73,6 @@ The call back also includes details regarding the current HMI_Status level, driv <div> <h4>Return Value</h4> <p>String</p> - </div> <h3 id="section-userSelected"> @@ -96,7 +95,6 @@ The call back also includes details regarding the current HMI_Status level, driv <div> <h4>Return Value</h4> <p>Boolean the current user selection status</p> - </div> <h3 id="section-lockScreenStatus"> @@ -118,9 +116,7 @@ The call back also includes details regarding the current HMI_Status level, driv <div> <h4>Return Value</h4> - <p>{@linkplain -LockScreenStatus}</p> - + <p>{@linkplain LockScreenStatus}</p> </div> <h3 id="section-hmiLevel"> @@ -142,9 +138,7 @@ LockScreenStatus}</p> <div> <h4>Return Value</h4> - <p>{@linkplain -HMILevel} the current HMI Level in effect for the application</p> - + <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 cfd36d0b3..a5a62b6b5 100644 --- a/docs/Classes/SDLOnPermissionsChange.html +++ b/docs/Classes/SDLOnPermissionsChange.html @@ -38,8 +38,7 @@ -initWithDictionary: </h3> - <p>Constructs a newly allocated SDLOnPermissionsChange object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Constructs a newly allocated SDLOnPermissionsChange object indicated by the dictionary parameter</p> @@ -55,8 +54,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-permissionItem"> @@ -66,7 +64,6 @@ <p>@abstract 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 diff --git a/docs/Classes/SDLOnVehicleData.html b/docs/Classes/SDLOnVehicleData.html index 33cde85d5..8ee256d1b 100644 --- a/docs/Classes/SDLOnVehicleData.html +++ b/docs/Classes/SDLOnVehicleData.html @@ -63,8 +63,7 @@ </h3> <p>@abstract Constructs a new SDLOnVehicleData object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -80,8 +79,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-gps"> @@ -453,7 +451,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCNotification</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCNotification.html">SDLRPCNotification</a></span></code></pre> @@ -468,7 +466,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCNotification</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCNotification.html">SDLRPCNotification</a></span></code></pre> @@ -483,7 +481,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCNotification</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCNotification.html">SDLRPCNotification</a></span></code></pre> @@ -498,7 +496,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCNotification</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCNotification.html">SDLRPCNotification</a></span></code></pre> @@ -513,7 +511,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCNotification</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCNotification.html">SDLRPCNotification</a></span></code></pre> diff --git a/docs/Classes/SDLPRNDL.html b/docs/Classes/SDLPRNDL.html index 93f0a51fa..07810ec3e 100644 --- a/docs/Classes/SDLPRNDL.html +++ b/docs/Classes/SDLPRNDL.html @@ -51,13 +51,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLPRNDL object</p> - </div> <h3 id="section-+values"> @@ -80,7 +78,6 @@ <div> <h4>Return Value</h4> <p>the array</p> - </div> <h3 id="section-+PARK"> @@ -103,7 +100,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>PARK</em></p> - </div> <h3 id="section-+REVERSE"> @@ -126,7 +122,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>REVERSE</em></p> - </div> <h3 id="section-+NEUTRAL"> @@ -149,7 +144,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>NEUTRAL</em></p> - </div> <h3 id="section-+DRIVE"> @@ -172,7 +166,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>DRIVE</em></p> - </div> <h3 id="section-+SPORT"> @@ -195,7 +188,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>SPORT</em></p> - </div> <h3 id="section-+LOWGEAR"> @@ -218,7 +210,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>LOWGEAR</em></p> - </div> <h3 id="section-+FIRST"> @@ -241,7 +232,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>FIRST</em></p> - </div> <h3 id="section-+SECOND"> @@ -264,7 +254,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>SECOND</em></p> - </div> <h3 id="section-+THIRD"> @@ -287,7 +276,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>THIRD</em></p> - </div> <h3 id="section-+FOURTH"> @@ -310,7 +298,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>FOURTH</em></p> - </div> <h3 id="section-+FIFTH"> @@ -333,7 +320,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>FIFTH</em></p> - </div> <h3 id="section-+SIXTH"> @@ -356,7 +342,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>SIXTH</em></p> - </div> <h3 id="section-+SEVENTH"> @@ -379,7 +364,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>SEVENTH</em></p> - </div> <h3 id="section-+EIGHTH"> @@ -402,7 +386,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>EIGHTH</em></p> - </div> <h3 id="section-+UNKNOWN"> @@ -425,7 +408,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>UNKNOWN</em></p> - </div> <h3 id="section-+FAULT"> @@ -448,7 +430,6 @@ <div> <h4>Return Value</h4> <p>SDLPRNDL: <em>FAULT</em></p> - </div> </section> diff --git a/docs/Classes/SDLParameterPermissions.html b/docs/Classes/SDLParameterPermissions.html index 720b6da24..1d25b87b5 100644 --- a/docs/Classes/SDLParameterPermissions.html +++ b/docs/Classes/SDLParameterPermissions.html @@ -55,8 +55,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-allowed"> diff --git a/docs/Classes/SDLPerformAudioPassThru.html b/docs/Classes/SDLPerformAudioPassThru.html index dcedb7973..8d3e82958 100644 --- a/docs/Classes/SDLPerformAudioPassThru.html +++ b/docs/Classes/SDLPerformAudioPassThru.html @@ -28,8 +28,7 @@ </p></p> <p><p>Since SmartDeviceLink 2.0</p> - -<p><p>See SDLEndAudioPassThru</p></p></p> + <p>See SDLEndAudioPassThru</p></p> <section class="section task-group-section"> @@ -55,8 +54,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLPerformAudioPassThru object indicated by the NSMutableDictionary -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLPerformAudioPassThru object indicated by the NSMutableDictionary</p> @@ -72,8 +70,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithSamplingRate:bitsPerSample:audioType:maxDuration:"> @@ -85,7 +82,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformAudioPassThru</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformAudioPassThru</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -100,7 +97,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformAudioPassThru</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformAudioPassThru</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLPerformAudioPassThruResponse.html b/docs/Classes/SDLPerformAudioPassThruResponse.html index d026d698e..d93154f17 100644 --- a/docs/Classes/SDLPerformAudioPassThruResponse.html +++ b/docs/Classes/SDLPerformAudioPassThruResponse.html @@ -37,8 +37,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLPerformAudioPassThruResponse object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLPerformAudioPassThruResponse object indicated by the dictionary parameter</p> @@ -54,8 +53,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLPerformInteraction.html b/docs/Classes/SDLPerformInteraction.html index b0927195e..3c1cf1f3f 100644 --- a/docs/Classes/SDLPerformInteraction.html +++ b/docs/Classes/SDLPerformInteraction.html @@ -64,8 +64,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLPerformInteraction object indicated by the NSMutableDictionary -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLPerformInteraction object indicated by the NSMutableDictionary</p> @@ -81,8 +80,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithInteractionChoiceSetId:"> @@ -94,7 +92,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -109,7 +107,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -124,7 +122,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -139,7 +137,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -154,7 +152,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -169,7 +167,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -184,7 +182,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -199,7 +197,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -370,7 +368,7 @@ display on-screen during Perform Interaction <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPerformInteraction</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLPerformInteractionResponse.html b/docs/Classes/SDLPerformInteractionResponse.html index 2fafb9ae1..6a49fcd99 100644 --- a/docs/Classes/SDLPerformInteractionResponse.html +++ b/docs/Classes/SDLPerformInteractionResponse.html @@ -40,8 +40,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLPerformInteractionResponse object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLPerformInteractionResponse object indicated by the dictionary parameter</p> @@ -57,8 +56,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-choiceID"> diff --git a/docs/Classes/SDLPermissionManager.html b/docs/Classes/SDLPermissionManager.html index 608e88a4a..443153914 100644 --- a/docs/Classes/SDLPermissionManager.html +++ b/docs/Classes/SDLPermissionManager.html @@ -40,8 +40,7 @@ <h4>Parameters</h4> <dl> <dt>completionHandler</dt> - <dd><p>The block to be called when the manager’s setup is complete.</p> -</dd> + <dd><p>The block to be called when the manager’s setup is complete.</p></dd> </dl> <h3 id="section--stop"> @@ -82,13 +81,11 @@ <h4>Parameters</h4> <dl> <dt>rpcName</dt> - <dd><p>The name of the RPC to be tested, for example, SDLShow</p> -</dd> + <dd><p>The name of the RPC to be tested, for example, SDLShow</p></dd> </dl> <div> <h4>Return Value</h4> <p>YES if the RPC is allowed at the current HMI level, NO if not</p> - </div> <h3 id="section--groupStatusOfRPCs:"> @@ -112,13 +109,11 @@ <h4>Parameters</h4> <dl> <dt>rpcNames</dt> - <dd><p>The RPCs to check</p> -</dd> + <dd><p>The RPCs to check</p></dd> </dl> <div> <h4>Return Value</h4> <p>AllAllowed if all of the permissions are allowed, AllDisallowed if all the permissions are disallowed, Any if some are allowed, and some are disallowed</p> - </div> <h3 id="section--statusOfRPCs:"> @@ -142,13 +137,11 @@ <h4>Parameters</h4> <dl> <dt>rpcNames</dt> - <dd><p>An array of RPC names to check</p> -</dd> + <dd><p>An array of RPC names to check</p></dd> </dl> <div> <h4>Return Value</h4> <p>A dictionary specifying if the passed in RPC names are currently allowed or not</p> - </div> <h3 id="section--addObserverForRPCs:groupType:withHandler:"> @@ -156,13 +149,11 @@ </h3> <p>Add an observer for specified RPC names, with a callback that will be called whenever the value changes, as well as immediately with the current status.</p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> <p>This block will be captured by the SDLPermissionsManager, be sure to use <a href="http://www.logicsector.com/ios/avoiding-objc-retain-cycles-with-weakself-and-strongself-the-easy-way/">weakself/strongself</a> if you are referencing self within your observer block.</p> </div> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> <p>The observer may be called before this method returns, do not attempt to remove the observer from within the observer. That could send <code>nil</code> to removeObserverForIdentifier:. If you want functionality like that, call groupStatusOfRPCs: instead.</p> @@ -186,19 +177,15 @@ <h4>Parameters</h4> <dl> <dt>rpcNames</dt> - <dd><p>The RPCs to be observed</p> -</dd> + <dd><p>The RPCs to be observed</p></dd> <dt>groupType</dt> - <dd><p>Affects the times that the observer block will be called. If Any, any change to any RPC in rpcNames will cause the observer block to be called. If AllAllowed, the block will be called when: 1. Every RPC in rpcNames becomes allowed 2. The group of rpcNames goes from all being allowed to some or all being disallowed.</p> -</dd> + <dd><p>Affects the times that the observer block will be called. If Any, any change to any RPC in rpcNames will cause the observer block to be called. If AllAllowed, the block will be called when: 1. Every RPC in rpcNames becomes allowed 2. The group of rpcNames goes from all being allowed to some or all being disallowed.</p></dd> <dt>handler</dt> - <dd><p>The block that will be called whenever permissions change.</p> -</dd> + <dd><p>The block that will be called whenever permissions change.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An identifier that can be passed to removeObserverForIdentifer: to remove the observer</p> - </div> <h3 id="section--removeAllObservers"> @@ -240,8 +227,7 @@ <h4>Parameters</h4> <dl> <dt>identifier</dt> - <dd><p>The identifier specifying which observer to remove</p> -</dd> + <dd><p>The identifier specifying which observer to remove</p></dd> </dl> </section> diff --git a/docs/Classes/SDLPermissionStatus.html b/docs/Classes/SDLPermissionStatus.html index 8d9633934..9e886d288 100644 --- a/docs/Classes/SDLPermissionStatus.html +++ b/docs/Classes/SDLPermissionStatus.html @@ -39,21 +39,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>a SDLPermissionStatus object</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract declare an array to store all possible SDLPermissionStatus values -- returns: the array</p> + <p>@abstract declare an array to store all possible SDLPermissionStatus values</p> @@ -69,15 +66,13 @@ <div> <h4>Return Value</h4> <p>the array</p> - </div> <h3 id="section-+ALLOWED"> +ALLOWED </h3> - <p>@abstract permission: allowed -- returns: permission status: <em>ALLOWED</em></p> + <p>@abstract permission: allowed</p> @@ -93,15 +88,13 @@ <div> <h4>Return Value</h4> <p>permission status: <em>ALLOWED</em></p> - </div> <h3 id="section-+DISALLOWED"> +DISALLOWED </h3> - <p>@abstract permission: disallowed -- returns: permission status: <em>DISALLOWED</em></p> + <p>@abstract permission: disallowed</p> @@ -117,15 +110,13 @@ <div> <h4>Return Value</h4> <p>permission status: <em>DISALLOWED</em></p> - </div> <h3 id="section-+USER_DISALLOWED"> +USER_DISALLOWED </h3> - <p>@abstract permission: user disallowed -- returns: permission status: <em>USER_DISALLOWED</em></p> + <p>@abstract permission: user disallowed</p> @@ -141,15 +132,13 @@ <div> <h4>Return Value</h4> <p>permission status: <em>USER_DISALLOWED</em></p> - </div> <h3 id="section-+USER_CONSENT_PENDING"> +USER_CONSENT_PENDING </h3> - <p>@abstract permission: user consent pending -- returns: permission status: <em>USER_CONSENT_PENDING</em></p> + <p>@abstract permission: user consent pending</p> @@ -165,7 +154,6 @@ <div> <h4>Return Value</h4> <p>permission status: <em>USER_CONSENT_PENDING</em></p> - </div> </section> diff --git a/docs/Classes/SDLPhoneCapability.html b/docs/Classes/SDLPhoneCapability.html new file mode 100644 index 000000000..367bfd994 --- /dev/null +++ b/docs/Classes/SDLPhoneCapability.html @@ -0,0 +1,89 @@ +<h1>SDLPhoneCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section--initWithDialNumber:">-initWithDialNumber:</a></li> + <li><a href="#section-dialNumberEnabled">dialNumberEnabled</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>@abstract Constructs a newly allocated SDLPhoneCapability struct</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>@abstract Constructs a newly allocated SDLPhoneCapability struct indicated by the dictionary parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use</p></dd> + </dl> + + <h3 id="section--initWithDialNumber:"> + -initWithDialNumber: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-dialNumberEnabled"> + dialNumberEnabled + </h3> + + <p>Whether or not the DialNumber RPC is enabled. +Boolean, optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">dialNumberEnabled</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">dialNumberEnabled</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLPresetBankCapabilities.html b/docs/Classes/SDLPresetBankCapabilities.html index 61cff40a5..2cb903327 100644 --- a/docs/Classes/SDLPresetBankCapabilities.html +++ b/docs/Classes/SDLPresetBankCapabilities.html @@ -38,8 +38,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a newly allocated SDLPresetBankCapabilities object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a newly allocated SDLPresetBankCapabilities object indicated by the dictionary parameter</p> @@ -55,8 +54,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-onScreenPresetsAvailable"> diff --git a/docs/Classes/SDLPrimaryAudioSource.html b/docs/Classes/SDLPrimaryAudioSource.html index c868fc0ac..fd61c8ff9 100644 --- a/docs/Classes/SDLPrimaryAudioSource.html +++ b/docs/Classes/SDLPrimaryAudioSource.html @@ -42,21 +42,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String value to retrieve the object enum for</p> -</dd> + <dd><p>String value to retrieve the object enum for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLPrimaryAudioSource object</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract declare an array to store all possible SDLPrimaryAudioSource values -- returns: the array</p> + <p>@abstract declare an array to store all possible SDLPrimaryAudioSource values</p> @@ -72,15 +69,13 @@ <div> <h4>Return Value</h4> <p>the array</p> - </div> <h3 id="section-+NO_SOURCE_SELECTED"> +NO_SOURCE_SELECTED </h3> - <p>@abstract Currently no source selected -- returns: the current primary audio source: <em>NO_SOURCE_SELECTED</em></p> + <p>@abstract Currently no source selected</p> @@ -96,15 +91,13 @@ <div> <h4>Return Value</h4> <p>the current primary audio source: <em>NO_SOURCE_SELECTED</em></p> - </div> <h3 id="section-+USB"> +USB </h3> - <p>@abstract USB is current source -- returns: the current primary audio source: <em>USB</em></p> + <p>@abstract USB is current source</p> @@ -120,15 +113,13 @@ <div> <h4>Return Value</h4> <p>the current primary audio source: <em>USB</em></p> - </div> <h3 id="section-+USB2"> +USB2 </h3> - <p>@abstract USB2 is current source -- returns: the current primary audio source: <em>USB2</em></p> + <p>@abstract USB2 is current source</p> @@ -144,15 +135,13 @@ <div> <h4>Return Value</h4> <p>the current primary audio source: <em>USB2</em></p> - </div> <h3 id="section-+BLUETOOTH_STEREO_BTST"> +BLUETOOTH_STEREO_BTST </h3> - <p>@abstract Bluetooth Stereo is current source -- returns: the current primary audio source: <em>BLUETOOTH_STEREO_BTST</em></p> + <p>@abstract Bluetooth Stereo is current source</p> @@ -168,15 +157,13 @@ <div> <h4>Return Value</h4> <p>the current primary audio source: <em>BLUETOOTH_STEREO_BTST</em></p> - </div> <h3 id="section-+LINE_IN"> +LINE_IN </h3> - <p>@abstract Line in is current source -- returns: the current primary audio source: <em>LINE_IN</em></p> + <p>@abstract Line in is current source</p> @@ -192,15 +179,13 @@ <div> <h4>Return Value</h4> <p>the current primary audio source: <em>LINE_IN</em></p> - </div> <h3 id="section-+IPOD"> +IPOD </h3> - <p>@abstract iPod is current source -- returns: the current primary audio source: <em>IPOD</em></p> + <p>@abstract iPod is current source</p> @@ -216,15 +201,13 @@ <div> <h4>Return Value</h4> <p>the current primary audio source: <em>IPOD</em></p> - </div> <h3 id="section-+MOBILE_APP"> +MOBILE_APP </h3> - <p>@abstract Mobile app is current source -- returns: the current primary audio source: <em>MOBILE_APP</em></p> + <p>@abstract Mobile app is current source</p> @@ -240,7 +223,6 @@ <div> <h4>Return Value</h4> <p>the current primary audio source: <em>MOBILE_APP</em></p> - </div> </section> diff --git a/docs/Classes/SDLProtocol.html b/docs/Classes/SDLProtocol.html index 1ad890b61..a71f0ea2f 100644 --- a/docs/Classes/SDLProtocol.html +++ b/docs/Classes/SDLProtocol.html @@ -5,7 +5,9 @@ <ul> <li><a href="#section--sendStartSessionWithType:">-sendStartSessionWithType:</a></li> <li><a href="#section--startServiceWithType:">-startServiceWithType:</a></li> + <li><a href="#section--startServiceWithType:payload:">-startServiceWithType:payload:</a></li> <li><a href="#section--startSecureServiceWithType:completionHandler:">-startSecureServiceWithType:completionHandler:</a></li> + <li><a href="#section--startSecureServiceWithType:payload:completionHandler:">-startSecureServiceWithType:payload:completionHandler:</a></li> <li><a href="#section--sendEndSessionWithType:">-sendEndSessionWithType:</a></li> <li><a href="#section--endServiceWithType:">-endServiceWithType:</a></li> <li><a href="#section--sendRPC:">-sendRPC:</a></li> @@ -44,6 +46,17 @@ + <h3 id="section--startServiceWithType:payload:"> + -startServiceWithType:payload: + </h3> + + <p>Undocumented</p> + + + + + + <h3 id="section--startSecureServiceWithType:completionHandler:"> -startSecureServiceWithType:completionHandler: </h3> @@ -55,6 +68,17 @@ + <h3 id="section--startSecureServiceWithType:payload:completionHandler:"> + -startSecureServiceWithType:payload:completionHandler: + </h3> + + <p>Undocumented</p> + + + + + + <h3 id="section--sendEndSessionWithType:"> -sendEndSessionWithType: </h3> diff --git a/docs/Classes/SDLProtocolHeader.html b/docs/Classes/SDLProtocolHeader.html index 666fd1185..b091813c4 100644 --- a/docs/Classes/SDLProtocolHeader.html +++ b/docs/Classes/SDLProtocolHeader.html @@ -19,6 +19,7 @@ <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> @@ -203,4 +204,15 @@ + <h3 id="section-+determineVersion:"> + +determineVersion: + </h3> + + <p>Undocumented</p> + + + + + + </section> diff --git a/docs/Classes/SDLProxy.html b/docs/Classes/SDLProxy.html index 10cab7bc6..254430d34 100644 --- a/docs/Classes/SDLProxy.html +++ b/docs/Classes/SDLProxy.html @@ -293,12 +293,7 @@ </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. -- parameter: inputStream A stream containing the data to put to the module. -- parameter: putFileRPCRequest 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> +@abstract Performs a putFile for a given input stream, performed in chunks, for handling very large files.</p> @@ -315,11 +310,12 @@ Note: the length parameter of the putFileRPCRequest will be ignored. The proxy w <h4>Parameters</h4> <dl> <dt>inputStream</dt> - <dd><p>A stream containing the data to put to the module.</p> -</dd> + <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)</p> -</dd> + <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/SDLPutFile.html b/docs/Classes/SDLPutFile.html index b266be650..36e9b05ac 100644 --- a/docs/Classes/SDLPutFile.html +++ b/docs/Classes/SDLPutFile.html @@ -21,9 +21,17 @@ <p>Used to push a binary data onto the SDL module from a mobile device, such as icons and album art</p> -<p>Since SmartDeviceLink 2.0 - - see: SDLDeleteFile - - see: SDLListFiles</p> +<p>Since SmartDeviceLink 2.0</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLDeleteFile + +</div> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLListFiles + +</div> <section class="section task-group-section"> @@ -65,8 +73,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithFileName:fileType:"> @@ -78,7 +85,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPutFile</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPutFile</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -93,7 +100,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPutFile</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPutFile</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -108,7 +115,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPutFile</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPutFile</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLPutFileResponse.html b/docs/Classes/SDLPutFileResponse.html index dbab7dffd..1f53a1591 100644 --- a/docs/Classes/SDLPutFileResponse.html +++ b/docs/Classes/SDLPutFileResponse.html @@ -38,8 +38,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLPutFileResponse object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLPutFileResponse object indicated by the dictionary parameter</p> @@ -55,8 +54,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-spaceAvailable"> @@ -68,7 +66,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPutFileResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPutFileResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLReadDID.html b/docs/Classes/SDLReadDID.html index 92f196740..ab4e25b69 100644 --- a/docs/Classes/SDLReadDID.html +++ b/docs/Classes/SDLReadDID.html @@ -47,8 +47,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLReadDID object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLReadDID object indicated by the dictionary parameter</p> @@ -64,8 +63,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithECUName:didLocation:"> @@ -77,7 +75,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLReadDID</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLReadDID</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLReadDIDResponse.html b/docs/Classes/SDLReadDIDResponse.html index 1bd6eb9b4..10e0a86e8 100644 --- a/docs/Classes/SDLReadDIDResponse.html +++ b/docs/Classes/SDLReadDIDResponse.html @@ -25,7 +25,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLReadDIDResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLReadDIDResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -40,7 +40,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLReadDIDResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLReadDIDResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -55,7 +55,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLReadDIDResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLReadDIDResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLRectangle.html b/docs/Classes/SDLRectangle.html new file mode 100644 index 000000000..d3e20c790 --- /dev/null +++ b/docs/Classes/SDLRectangle.html @@ -0,0 +1,202 @@ +<h1>SDLRectangle Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section--initWithX:y:width:height:">-initWithX:y:width:height:</a></li> + <li><a href="#section--initWithCGRect:">-initWithCGRect:</a></li> + <li><a href="#section-x">x</a></li> + <li><a href="#section-y">y</a></li> + <li><a href="#section-width">width</a></li> + <li><a href="#section-height">height</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>@abstract Constructs a newly allocated SDLRectangle object</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>@abstract Constructs a newly allocated SDLRectangle object indicated by the dictionary parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use</p></dd> + </dl> + + <h3 id="section--initWithX:y:width:height:"> + -initWithX:y:width:height: + </h3> + + <p>Create a Rectangle</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithX</span><span class="p">:(</span><span class="n">NSNumber</span> <span class="o">*</span><span class="p">)</span><span class="nv">x</span> + <span class="nf">y</span><span class="p">:(</span><span class="n">NSNumber</span> <span class="o">*</span><span class="p">)</span><span class="nv">y</span> + <span class="nf">width</span><span class="p">:(</span><span class="n">NSNumber</span> <span class="o">*</span><span class="p">)</span><span class="nv">width</span> + <span class="nf">height</span><span class="p">:(</span><span class="n">NSNumber</span> <span class="o">*</span><span class="p">)</span><span class="nv">height</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="nv">x</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span><span class="p">,</span> <span class="nv">y</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span><span class="p">,</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span><span class="p">,</span> <span class="nv">height</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>x</dt> + <dd><p>The top-left x value</p></dd> + <dt>y</dt> + <dd><p>The top-left y value</p></dd> + <dt>width</dt> + <dd><p>The width</p></dd> + <dt>height</dt> + <dd><p>The height</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An new SDLRectangle object</p> + </div> + + <h3 id="section--initWithCGRect:"> + -initWithCGRect: + </h3> + + <p>Create a Rectangle from a CGRect</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithCGRect</span><span class="p">:(</span><span class="n">CGRect</span><span class="p">)</span><span class="nv">rect</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">cgRect</span> <span class="nv">rect</span><span class="p">:</span> <span class="kt">CGRect</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>rect</dt> + <dd><p>The rectangle to use</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An new SDLRectangle object</p> + </div> + + <h3 id="section-x"> + x + </h3> + + <p>The upper left X-coordinate of the rectangle +Required, Float</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">x</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">x</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-y"> + y + </h3> + + <p>The upper left Y-coordinate of the rectangle +Required, Float</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">y</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">y</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-width"> + width + </h3> + + <p>The width of the rectangle +Required, Float</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">width</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-height"> + height + </h3> + + <p>The height of the rectangle +Required, Float</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">height</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">height</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLRegisterAppInterface.html b/docs/Classes/SDLRegisterAppInterface.html index bd39e42f9..58f170469 100644 --- a/docs/Classes/SDLRegisterAppInterface.html +++ b/docs/Classes/SDLRegisterAppInterface.html @@ -93,7 +93,6 @@ </p></p> <p>@since SDL 1.0</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLUnregisterAppInterface SDLOnAppInterfaceUnregistered @@ -140,8 +139,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithLifecycleConfiguration:"> @@ -153,7 +151,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRegisterAppInterface</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRegisterAppInterface</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -168,7 +166,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRegisterAppInterface</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRegisterAppInterface</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -183,7 +181,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRegisterAppInterface</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRegisterAppInterface</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -198,7 +196,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRegisterAppInterface</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRegisterAppInterface</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -264,8 +262,12 @@ <p>Optional, Array of SDLTTSChunk, Array size 1 - 100</p> -<p>@since SDL 2.0 - - see: SDLTTSChunk</p> +<p>@since SDL 2.0</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLTTSChunk + +</div> @@ -399,8 +401,12 @@ <p>Optional, Array of SDLAppHMIType, Array size 1 - 100</p> -<p>@since SDL 2.0 - - see: SDLAppHMIType</p> +<p>@since SDL 2.0</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAppHMIType + +</div> diff --git a/docs/Classes/SDLRegisterAppInterfaceResponse.html b/docs/Classes/SDLRegisterAppInterfaceResponse.html index 0e6952057..9928173ce 100644 --- a/docs/Classes/SDLRegisterAppInterfaceResponse.html +++ b/docs/Classes/SDLRegisterAppInterfaceResponse.html @@ -55,8 +55,7 @@ </h3> <p>Constructs a new SDLRegisterAppInterfaceResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -72,8 +71,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-syncMsgVersion"> @@ -105,7 +103,6 @@ parameter </h3> <p>The currently active VR+TTS language on Sync.</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLLanguage @@ -131,7 +128,6 @@ parameter </h3> <p>The currently active display language on Sync</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLLanguage @@ -207,7 +203,6 @@ parameter </h3> <p>If returned, the platform supports on-screen SoftButtons</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLSoftButtonCapabilities @@ -233,7 +228,6 @@ parameter </h3> <p>If returned, the platform supports custom on-screen Presets</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLPresetBankCapabilities @@ -380,7 +374,6 @@ parameter </h3> <p>Specifies the vehicle’s type</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLVehicleType diff --git a/docs/Classes/SDLResetGlobalProperties.html b/docs/Classes/SDLResetGlobalProperties.html index 6b7927a57..6bb8ad9ef 100644 --- a/docs/Classes/SDLResetGlobalProperties.html +++ b/docs/Classes/SDLResetGlobalProperties.html @@ -51,8 +51,7 @@ </h3> <p>@abstract Constructs a new SDLResetGlobalProperties object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -68,8 +67,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithProperties:"> @@ -81,7 +79,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLResetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLResetGlobalProperties</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLResetGlobalPropertiesResponse.html b/docs/Classes/SDLResetGlobalPropertiesResponse.html index 70436d317..3482bdbf1 100644 --- a/docs/Classes/SDLResetGlobalPropertiesResponse.html +++ b/docs/Classes/SDLResetGlobalPropertiesResponse.html @@ -38,8 +38,7 @@ </h3> <p>@abstract Constructs a new SDLResetGlobalPropertiesResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -55,8 +54,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLResult.html b/docs/Classes/SDLResult.html index 84ddc5bf3..1a955089c 100644 --- a/docs/Classes/SDLResult.html +++ b/docs/Classes/SDLResult.html @@ -52,9 +52,7 @@ +valueOf: </h3> - <p>@abstract get SDLResult according value string -- parameter: value The value of the string to get an object for -- returns: SDLResult object</p> + <p>@abstract get SDLResult according value string</p> @@ -70,21 +68,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLResult object</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract declare an array to store all possible SDLResult values -- returns: the array</p> + <p>@abstract declare an array to store all possible SDLResult values</p> @@ -100,7 +95,6 @@ <div> <h4>Return Value</h4> <p>the array</p> - </div> <h3 id="section-+SUCCESS"> @@ -156,7 +150,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLResult</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLResult</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLEnum.html">SDLEnum</a></span></code></pre> diff --git a/docs/Classes/SDLSamplingRate.html b/docs/Classes/SDLSamplingRate.html index 4ff708fbc..014ff96cd 100644 --- a/docs/Classes/SDLSamplingRate.html +++ b/docs/Classes/SDLSamplingRate.html @@ -39,13 +39,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLSamplingRate object</p> - </div> <h3 id="section-+values"> @@ -68,7 +66,6 @@ <div> <h4>Return Value</h4> <p>the array</p> - </div> <h3 id="section-+_8KHZ"> @@ -91,7 +88,6 @@ <div> <h4>Return Value</h4> <p>SamplingRate of <em>8KHZ</em></p> - </div> <h3 id="section-+_16KHZ"> @@ -114,7 +110,6 @@ <div> <h4>Return Value</h4> <p>SamplingRate of <em>16KHZ</em></p> - </div> <h3 id="section-+_22KHZ"> @@ -137,7 +132,6 @@ <div> <h4>Return Value</h4> <p>SamplingRate of <em>22KHZ</em></p> - </div> <h3 id="section-+_44KHZ"> @@ -160,7 +154,6 @@ <div> <h4>Return Value</h4> <p>SamplingRate of <em>44KHZ</em></p> - </div> </section> diff --git a/docs/Classes/SDLScrollableMessage.html b/docs/Classes/SDLScrollableMessage.html index 18b0a9fc8..366d0cfdb 100644 --- a/docs/Classes/SDLScrollableMessage.html +++ b/docs/Classes/SDLScrollableMessage.html @@ -47,8 +47,7 @@ Function Group: ScrollableMessage </h3> <p>@abstract Constructs a new SDLScrollableMessage object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -64,8 +63,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithMessage:"> @@ -77,7 +75,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLScrollableMessage</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLScrollableMessage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -92,7 +90,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLScrollableMessage</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLScrollableMessage</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLScrollableMessageResponse.html b/docs/Classes/SDLScrollableMessageResponse.html index 72aa85c97..9e9777f8d 100644 --- a/docs/Classes/SDLScrollableMessageResponse.html +++ b/docs/Classes/SDLScrollableMessageResponse.html @@ -38,8 +38,7 @@ </h3> <p>@abstract Constructs a new SDLScrollableMessageResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -55,8 +54,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLSendHapticData.html b/docs/Classes/SDLSendHapticData.html new file mode 100644 index 000000000..0e3559a70 --- /dev/null +++ b/docs/Classes/SDLSendHapticData.html @@ -0,0 +1,102 @@ +<h1>SDLSendHapticData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section--initWithHapticRectData:">-initWithHapticRectData:</a></li> + <li><a href="#section-hapticRectData">hapticRectData</a></li> +</ul> + +<h3>Overview</h3> + +<p>Sends the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI. This data will be utilized by the HMI to determine how and when haptic events should occur.</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>Constructs a new SDLSendHapticData object</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>Constructs a new SDLSendHapticData object indicated by the dictionary parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use</p></dd> + </dl> + + <h3 id="section--initWithHapticRectData:"> + -initWithHapticRectData: + </h3> + + <p>Constructs a new SDLSendHapticData object indicated by the hapticSpatialData parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHapticRectData</span><span class="p">:(</span><span class="n">NSMutableArray</span> <span class="o">*</span><span class="p">)</span><span class="nv">hapticSpatialData</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n"><a href="../Classes/SDLSendHapticData.html#/c:objc(cs)SDLSendHapticData(py)hapticRectData">hapticRectData</a></span> <span class="nv">hapticSpatialData</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>hapticSpatialData</dt> + <dd><p>Array of spatial data structures</p></dd> + </dl> + + <h3 id="section-hapticRectData"> + hapticRectData + </h3> + + <p>Array of spatial data structures that represent the locations of all user controls present on the HMI. This data should be updated if/when the application presents a new screen. When a request is sent, if successful, it will replace all spatial data previously sent through RPC. If an empty array is sent, the existing spatial data will be cleared</p> + +<p>Optional, Array of SDLHapticRect, Array size 0 - 1,000</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">hapticRectData</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">hapticRectData</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLSendHapticDataResponse.html b/docs/Classes/SDLSendHapticDataResponse.html new file mode 100644 index 000000000..2b6eb13c5 --- /dev/null +++ b/docs/Classes/SDLSendHapticDataResponse.html @@ -0,0 +1,38 @@ +<h1>SDLSendHapticDataResponse Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>Undocumented</p> + + + + + + +</section> diff --git a/docs/Classes/SDLSetAppIcon.html b/docs/Classes/SDLSetAppIcon.html index c6eb454c7..1a19b46a9 100644 --- a/docs/Classes/SDLSetAppIcon.html +++ b/docs/Classes/SDLSetAppIcon.html @@ -41,8 +41,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLSetAppIcon object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLSetAppIcon object indicated by the dictionary parameter</p> @@ -58,8 +57,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithFileName:"> @@ -71,7 +69,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetAppIcon</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetAppIcon</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLSetAppIconResponse.html b/docs/Classes/SDLSetAppIconResponse.html index 81ee865eb..6e408f997 100644 --- a/docs/Classes/SDLSetAppIconResponse.html +++ b/docs/Classes/SDLSetAppIconResponse.html @@ -9,8 +9,11 @@ <h3>Overview</h3> -<p>SDLSetAppIconResponse is sent, when SDLSetAppIcon has been called. - * Since<b>SmartDeviceLink 2.0</b></p> +<p>SDLSetAppIconResponse is sent, when SDLSetAppIcon has been called.</p> + +<ul> +<li>Since<b>SmartDeviceLink 2.0</b></li> +</ul> <section class="section task-group-section"> @@ -23,7 +26,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetAppIconResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetAppIconResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -38,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetAppIconResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetAppIconResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLSetDisplayLayout.html b/docs/Classes/SDLSetDisplayLayout.html index 96828e60f..a202dd0c3 100644 --- a/docs/Classes/SDLSetDisplayLayout.html +++ b/docs/Classes/SDLSetDisplayLayout.html @@ -42,8 +42,7 @@ </h3> <p>@abstract Constructs a new SDLSetDisplayLayout object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -59,8 +58,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithPredefinedLayout:"> @@ -72,7 +70,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayout</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayout</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -87,7 +85,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayout</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayout</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLSetDisplayLayoutResponse.html b/docs/Classes/SDLSetDisplayLayoutResponse.html index cf7eece72..7439cf73f 100644 --- a/docs/Classes/SDLSetDisplayLayoutResponse.html +++ b/docs/Classes/SDLSetDisplayLayoutResponse.html @@ -46,7 +46,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -61,7 +61,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -76,7 +76,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -91,7 +91,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -106,7 +106,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetDisplayLayoutResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLSetGlobalProperties.html b/docs/Classes/SDLSetGlobalProperties.html index ee6bcdb7f..a1ae8bff8 100644 --- a/docs/Classes/SDLSetGlobalProperties.html +++ b/docs/Classes/SDLSetGlobalProperties.html @@ -53,8 +53,7 @@ </h3> <p>@abstract Constructs a new SDLSetGlobalProperties object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -70,8 +69,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithHelpText:timeoutText:"> @@ -83,7 +81,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -98,7 +96,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -113,7 +111,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -241,7 +239,7 @@ started by PTT <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -256,7 +254,7 @@ started by PTT <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -271,7 +269,7 @@ started by PTT <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetGlobalProperties</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLSetGlobalPropertiesResponse.html b/docs/Classes/SDLSetGlobalPropertiesResponse.html index 1f1a78ea6..65bee87e5 100644 --- a/docs/Classes/SDLSetGlobalPropertiesResponse.html +++ b/docs/Classes/SDLSetGlobalPropertiesResponse.html @@ -38,8 +38,7 @@ </h3> <p>@abstract Constructs a new SDLSetGlobalPropertiesResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -55,8 +54,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLSetMediaClockTimer.html b/docs/Classes/SDLSetMediaClockTimer.html index 0c69cbe6d..d2bf0f025 100644 --- a/docs/Classes/SDLSetMediaClockTimer.html +++ b/docs/Classes/SDLSetMediaClockTimer.html @@ -48,8 +48,7 @@ </h3> <p>@abstract Constructs a new SDLSetMediaClockTimer object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -65,8 +64,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithUpdateMode:hours:minutes:seconds:"> @@ -78,7 +76,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetMediaClockTimer</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetMediaClockTimer</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -93,7 +91,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetMediaClockTimer</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetMediaClockTimer</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLSetMediaClockTimerResponse.html b/docs/Classes/SDLSetMediaClockTimerResponse.html index 427d2b9de..1deb0854c 100644 --- a/docs/Classes/SDLSetMediaClockTimerResponse.html +++ b/docs/Classes/SDLSetMediaClockTimerResponse.html @@ -55,8 +55,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLShow.html b/docs/Classes/SDLShow.html index 4bbbe2185..5ffdbe7b1 100644 --- a/docs/Classes/SDLShow.html +++ b/docs/Classes/SDLShow.html @@ -6,9 +6,12 @@ <li><a href="#section--init">-init</a></li> <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> <li><a href="#section--initWithMainField1:mainField2:alignment:">-initWithMainField1:mainField2:alignment:</a></li> + <li><a href="#section--initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:">-initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:</a></li> <li><a href="#section--initWithMainField1:mainField2:mainField3:mainField4:alignment:">-initWithMainField1:mainField2:mainField3:mainField4:alignment:</a></li> + <li><a href="#section--initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:">-initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:</a></li> <li><a href="#section--initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:">-initWithMainField1:mainField2:alignment:statusBar:mediaClock:mediaTrack:</a></li> <li><a href="#section--initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:">-initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:</a></li> + <li><a href="#section--initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:">-initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:</a></li> <li><a href="#section-mainField1">mainField1</a></li> <li><a href="#section-mainField2">mainField2</a></li> <li><a href="#section-mainField3">mainField3</a></li> @@ -21,6 +24,7 @@ <li><a href="#section-secondaryGraphic">secondaryGraphic</a></li> <li><a href="#section-softButtons">softButtons</a></li> <li><a href="#section-customPresets">customPresets</a></li> + <li><a href="#section-metadataTags">metadataTags</a></li> </ul> <h3>Overview</h3> @@ -70,8 +74,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLShow object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLShow object indicated by the dictionary parameter</p> @@ -87,8 +90,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithMainField1:mainField2:alignment:"> @@ -100,7 +102,22 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + + + + + + <h3 id="section--initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:"> + -initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -115,7 +132,22 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + + + + + + <h3 id="section--initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment:"> + -initWithMainField1:mainField1Type:mainField2:mainField2Type:mainField3:mainField3Type:mainField4:mainField4Type:alignment: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -130,7 +162,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -145,7 +177,22 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + + + + + + <h3 id="section--initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata:"> + -initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets:textFieldMetadata: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShow</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -506,4 +553,30 @@ line in a two-line display + <h3 id="section-metadataTags"> + metadataTags + </h3> + + <p>@abstract 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> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMetadataTags.html">SDLMetadataTags</a></span> <span class="o">*</span><span class="n">metadataTags</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">metadataTags</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLMetadataTags.html">SDLMetadataTags</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + </section> diff --git a/docs/Classes/SDLShowConstantTBT.html b/docs/Classes/SDLShowConstantTBT.html index 6e19d631e..15b8af5bc 100644 --- a/docs/Classes/SDLShowConstantTBT.html +++ b/docs/Classes/SDLShowConstantTBT.html @@ -21,11 +21,14 @@ <h3>Overview</h3> -<p>This RPC is used to update the user with navigation information<br> - * for the constantly shown screen (base screen),but also for the<br> - * alert type screen. - *<p> - * @since SmartDeviceLink 2.0</p> +<p>This RPC is used to update the user with navigation information<br></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> <section class="section task-group-section"> @@ -38,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -53,7 +56,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -68,7 +71,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -83,7 +86,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -98,7 +101,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -113,7 +116,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -128,7 +131,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -143,7 +146,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -158,7 +161,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -173,7 +176,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -188,7 +191,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -203,7 +206,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -218,7 +221,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -233,7 +236,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBT</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLShowConstantTBTResponse.html b/docs/Classes/SDLShowConstantTBTResponse.html index d80b92985..441168934 100644 --- a/docs/Classes/SDLShowConstantTBTResponse.html +++ b/docs/Classes/SDLShowConstantTBTResponse.html @@ -9,8 +9,11 @@ <h3>Overview</h3> -<p>SDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been called. - * Since<b>SmartDeviceLink 2.0</b></p> +<p>SDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been called.</p> + +<ul> +<li>Since<b>SmartDeviceLink 2.0</b></li> +</ul> <section class="section task-group-section"> @@ -23,7 +26,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBTResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBTResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -38,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBTResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLShowConstantTBTResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLShowResponse.html b/docs/Classes/SDLShowResponse.html index 9cc9d6d86..43f0e38ab 100644 --- a/docs/Classes/SDLShowResponse.html +++ b/docs/Classes/SDLShowResponse.html @@ -38,8 +38,7 @@ </h3> <p>@abstract Constructs a new SDLShowResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -55,8 +54,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLSingleTireStatus.html b/docs/Classes/SDLSingleTireStatus.html index 039c901f3..49f2080b9 100644 --- a/docs/Classes/SDLSingleTireStatus.html +++ b/docs/Classes/SDLSingleTireStatus.html @@ -38,8 +38,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a newly allocated SDLSingleTireStatus object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a newly allocated SDLSingleTireStatus object indicated by the dictionary parameter</p> @@ -55,8 +54,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-status"> diff --git a/docs/Classes/SDLSlider.html b/docs/Classes/SDLSlider.html index 5e5f76893..4147815a7 100644 --- a/docs/Classes/SDLSlider.html +++ b/docs/Classes/SDLSlider.html @@ -47,8 +47,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLSlider object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLSlider object indicated by the dictionary parameter</p> @@ -64,8 +63,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithNumTicks:position:"> @@ -77,7 +75,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSlider</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSlider</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -92,7 +90,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSlider</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSlider</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -107,7 +105,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSlider</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSlider</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLSliderResponse.html b/docs/Classes/SDLSliderResponse.html index 7f3620d54..be4795ef9 100644 --- a/docs/Classes/SDLSliderResponse.html +++ b/docs/Classes/SDLSliderResponse.html @@ -39,8 +39,7 @@ </h3> <p>@abstract Constructs a new SDLSliderResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -56,8 +55,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-sliderPosition"> diff --git a/docs/Classes/SDLSoftButtonCapabilities.html b/docs/Classes/SDLSoftButtonCapabilities.html index 00068c945..c323ea567 100644 --- a/docs/Classes/SDLSoftButtonCapabilities.html +++ b/docs/Classes/SDLSoftButtonCapabilities.html @@ -41,8 +41,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a newly allocated SDLSoftButtonCapabilities object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a newly allocated SDLSoftButtonCapabilities object indicated by the dictionary parameter</p> @@ -58,8 +57,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-shortPressAvailable"> diff --git a/docs/Classes/SDLSoftButtonType.html b/docs/Classes/SDLSoftButtonType.html index e2c3a7a29..ed127e3d5 100644 --- a/docs/Classes/SDLSoftButtonType.html +++ b/docs/Classes/SDLSoftButtonType.html @@ -20,9 +20,7 @@ +valueOf: </h3> - <p>@abstract get SDLSoftButtonType according value string -- parameter: value NSString -- returns: SDLSoftButtonType object</p> + <p>@abstract get SDLSoftButtonType according value string</p> @@ -38,21 +36,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>NSString</p> -</dd> + <dd><p>NSString</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLSoftButtonType object</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract declare an array to store all possible SDLSoftButtonType values -- returns: the array</p> + <p>@abstract declare an array to store all possible SDLSoftButtonType values</p> @@ -68,15 +63,13 @@ <div> <h4>Return Value</h4> <p>the array</p> - </div> <h3 id="section-+TEXT"> +TEXT </h3> - <p>@abstract Text kind Softbutton -- returns: SDLSoftButtonType object with string value <em>TEXT</em></p> + <p>@abstract Text kind Softbutton</p> @@ -92,15 +85,13 @@ <div> <h4>Return Value</h4> <p>SDLSoftButtonType object with string value <em>TEXT</em></p> - </div> <h3 id="section-+IMAGE"> +IMAGE </h3> - <p>@abstract Image kind Softbutton -- returns: SDLSoftButtonType object with string value <em>IMAGE</em></p> + <p>@abstract Image kind Softbutton</p> @@ -116,15 +107,13 @@ <div> <h4>Return Value</h4> <p>SDLSoftButtonType object with string value <em>IMAGE</em></p> - </div> <h3 id="section-+BOTH"> +BOTH </h3> - <p>@abstract Both (Text & Image) kind Softbutton -- returns: SDLSoftButtonType object with string value <em>BOTH</em></p> + <p>@abstract Both (Text & Image) kind Softbutton</p> @@ -140,7 +129,6 @@ <div> <h4>Return Value</h4> <p>SDLSoftButtonType object with string value <em>BOTH</em></p> - </div> </section> diff --git a/docs/Classes/SDLSpeak.html b/docs/Classes/SDLSpeak.html index 5b3099ef1..b27fa22d5 100644 --- a/docs/Classes/SDLSpeak.html +++ b/docs/Classes/SDLSpeak.html @@ -41,8 +41,12 @@ <li>Chunks are limited to 500 characters; however you can have multiple TTS chunks.</li> <li>On old systems there is a total character limit of 500 characters across all chunks. This could vary according to the VCA.</li></p> -<p>@since SmartDeviceLink 1.0 - - see: SDLAlert</p> +<p>@since SmartDeviceLink 1.0</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAlert + +</div> <section class="section task-group-section"> @@ -68,8 +72,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a new SDLSpeak object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a new SDLSpeak object indicated by the dictionary parameter</p> @@ -85,8 +88,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithTTS:"> @@ -98,7 +100,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSpeak</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSpeak</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -113,7 +115,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSpeak</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSpeak</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -128,7 +130,6 @@ <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> <p>Required, Array of SDLTTSChunk, Array size 1 - 100</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLTTSChunk diff --git a/docs/Classes/SDLSpeakResponse.html b/docs/Classes/SDLSpeakResponse.html index cf65e3a78..56625b5df 100644 --- a/docs/Classes/SDLSpeakResponse.html +++ b/docs/Classes/SDLSpeakResponse.html @@ -38,8 +38,7 @@ </h3> <p>@abstract Constructs a new SDLSpeakResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -55,8 +54,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLSpeechCapabilities.html b/docs/Classes/SDLSpeechCapabilities.html index e8500ced3..26e5b56cd 100644 --- a/docs/Classes/SDLSpeechCapabilities.html +++ b/docs/Classes/SDLSpeechCapabilities.html @@ -38,13 +38,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLSpeechCapabilities object</p> - </div> <h3 id="section-+values"> @@ -67,7 +65,6 @@ <div> <h4>Return Value</h4> <p>the array of all possible values</p> - </div> <h3 id="section-+TEXT"> @@ -90,7 +87,6 @@ <div> <h4>Return Value</h4> <p>SDLSpeechCapabilities of value: <em>TEXT</em></p> - </div> <h3 id="section-+SAPI_PHONEMES"> diff --git a/docs/Classes/SDLStartTime.html b/docs/Classes/SDLStartTime.html index 8fa5d4936..a96c73c0c 100644 --- a/docs/Classes/SDLStartTime.html +++ b/docs/Classes/SDLStartTime.html @@ -41,8 +41,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a newly allocated SDLStartTime object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a newly allocated SDLStartTime object indicated by the dictionary parameter</p> @@ -58,8 +57,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithHours:minutes:seconds:"> @@ -71,7 +69,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLStartTime</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLStartTime</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> diff --git a/docs/Classes/SDLStreamingMediaManager.html b/docs/Classes/SDLStreamingMediaManager.html index 2ebb4b0b2..db0d4863f 100644 --- a/docs/Classes/SDLStreamingMediaManager.html +++ b/docs/Classes/SDLStreamingMediaManager.html @@ -16,7 +16,9 @@ <li><a href="#section--initWithProtocol:">-initWithProtocol:</a></li> <li><a href="#section--initWithProtocol:displayCapabilities:">-initWithProtocol:displayCapabilities:</a></li> <li><a href="#section--startVideoSessionWithStartBlock:">-startVideoSessionWithStartBlock:</a></li> + <li><a href="#section--startVideoSessionWithHeight:width:startBlock:">-startVideoSessionWithHeight:width:startBlock:</a></li> <li><a href="#section--startVideoSessionWithTLS:startBlock:">-startVideoSessionWithTLS:startBlock:</a></li> + <li><a href="#section--startVideoSessionWithTLS:height:width:startBlock:">-startVideoSessionWithTLS:height:width:startBlock:</a></li> <li><a href="#section--stopVideoSession">-stopVideoSession</a></li> <li><a href="#section--sendVideoData:">-sendVideoData:</a></li> <li><a href="#section--startAudioSessionWithStartBlock:">-startAudioSessionWithStartBlock:</a></li> @@ -98,7 +100,6 @@ </h3> <p>The settings used in a VTCompressionSessionRef encoder. These will be verified when the video stream is started. Acceptable properties for this are located in VTCompressionProperties. If set to nil, the defaultVideoEncoderSettings will be used.</p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> Video streaming must not be connected to update the encoder properties. If it is running, issue a stopVideoSession before updating. @@ -123,7 +124,6 @@ </h3> <p>Display capabilties that will set the screenSize property. If set to nil, the SDLDefaultScreenSize will be used.</p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> Video streaming must not be connected to update the encoder properties. If it is running, issue a stopVideoSession before updating. @@ -185,7 +185,6 @@ </h3> <p>The pixel buffer pool reference returned back from an active VTCompressionSessionRef encoder.</p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> This will only return a valid pixel buffer pool after the encoder has been initialized (when the video session has started). @@ -232,8 +231,7 @@ -startVideoSessionWithStartBlock: </h3> - <p>This method will attempt to start a streaming video session. It will set up iOS’s video encoder, and call out to the head unit asking if it will start a video session. This will not use encryption.</p> - + <p>This method will attempt to start a streaming video session. It will set up iOS’s video encoder, and call out to the head unit asking if it will start a video session. This will not use encryption.</p> <div class="aside aside-warning"> <p class="aside-title">Warning</p> <p>If this method is called on an 8.0 device, it will assert (in debug), or return a failure immediately to your block (in release).</p> @@ -255,8 +253,41 @@ <h4>Parameters</h4> <dl> <dt>startBlock</dt> - <dd><p>A block that will be called with the result of attempting to start a video session</p> -</dd> + <dd><p>A block that will be called with the result of attempting to start a video session</p></dd> + </dl> + + <h3 id="section--startVideoSessionWithHeight:width:startBlock:"> + -startVideoSessionWithHeight:width:startBlock: + </h3> + + <p>This method will attempt to start a streaming video session. It will set up iOS’s video encoder, and call out to the head unit asking if it will start a video session. This will not use encryption. To get proper values for height and width. If the remote system does not support GetSystemCapabilities, then call <code>startVideoSessionWithStartBlock:</code> instead.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>If this method is called on an 8.0 device, it will assert (in debug), or return a failure immediately to your block (in release).</p> + +</div> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startVideoSessionWithHeight</span><span class="p">:(</span><span class="kt">int32_t</span><span class="p">)</span><span class="nv">height</span> + <span class="nf">width</span><span class="p">:(</span><span class="kt">int32_t</span><span class="p">)</span><span class="nv">width</span> + <span class="nf">startBlock</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLStreamingMediaManager.h@T@SDLStreamingStartBlock">SDLStreamingStartBlock</a></span><span class="p">)</span><span class="nv">startBlock</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">startVideoSession</span><span class="p">(</span><span class="n">withHeight</span> <span class="nv">height</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">,</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">,</span> <span class="n">start</span> <span class="nv">startBlock</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLStreamingMediaManager.h@T@SDLStreamingStartBlock">SDLStreamingStartBlock</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>height</dt> + <dd><p>The height requested to be used</p></dd> + <dt>width</dt> + <dd><p>The width requested to be used</p></dd> + <dt>startBlock</dt> + <dd><p>A block that will be called with the result of attempting to start a video session</p></dd> </dl> <h3 id="section--startVideoSessionWithTLS:startBlock:"> @@ -281,11 +312,42 @@ <h4>Parameters</h4> <dl> <dt>encryptionFlag</dt> - <dd><p>Whether and how much security to apply to the video session.</p> -</dd> + <dd><p>Whether and how much security to apply to the video session.</p></dd> + <dt>startBlock</dt> + <dd><p>A block that will be called with the result of attempting to start a video session</p></dd> + </dl> + + <h3 id="section--startVideoSessionWithTLS:height:width:startBlock:"> + -startVideoSessionWithTLS:height:width:startBlock: + </h3> + + <p>Start a video session either with with no encryption (the default), with authentication but no encryption (this will attempt a TLS authentication with the other side, but will not physically encrypt the data after that), or authentication and encryption, which will encrypt all video data being sent. To get proper values for height, width, protocol, and codec, call GetSystemCapabilities. If the remote system does not support GetSystemCapabilities, then call <code>startVideoSessionWithStartBlock:</code> instead.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startVideoSessionWithTLS</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLEncryptionFlag.html">SDLEncryptionFlag</a></span><span class="p">)</span><span class="nv">encryptionFlag</span> + <span class="nf">height</span><span class="p">:(</span><span class="kt">int32_t</span><span class="p">)</span><span class="nv">height</span> + <span class="nf">width</span><span class="p">:(</span><span class="kt">int32_t</span><span class="p">)</span><span class="nv">width</span> + <span class="nf">startBlock</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLStreamingMediaManager.h@T@SDLStreamingEncryptionStartBlock">SDLStreamingEncryptionStartBlock</a></span><span class="p">)</span><span class="nv">startBlock</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">startVideoSession</span><span class="p">(</span><span class="n">withTLS</span> <span class="nv">encryptionFlag</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLEncryptionFlag.html">SDLEncryptionFlag</a></span><span class="p">,</span> <span class="nv">height</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">,</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">,</span> <span class="n">start</span> <span class="nv">startBlock</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLStreamingMediaManager.h@T@SDLStreamingEncryptionStartBlock">SDLStreamingEncryptionStartBlock</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>encryptionFlag</dt> + <dd><p>Whether and how much security to apply to the video session.</p></dd> + <dt>height</dt> + <dd><p>The height requested to be used</p></dd> + <dt>width</dt> + <dd><p>The width requested to be used</p></dd> <dt>startBlock</dt> - <dd><p>A block that will be called with the result of attempting to start a video session</p> -</dd> + <dd><p>A block that will be called with the result of attempting to start a video session</p></dd> </dl> <h3 id="section--stopVideoSession"> @@ -326,13 +388,11 @@ <h4>Parameters</h4> <dl> <dt>imageBuffer</dt> - <dd><p>A CVImageBufferRef to be encoded by Video Toolbox</p> -</dd> + <dd><p>A CVImageBufferRef to be encoded by Video Toolbox</p></dd> </dl> <div> <h4>Return Value</h4> <p>Whether or not the data was successfully encoded and sent.</p> - </div> <h3 id="section--startAudioSessionWithStartBlock:"> @@ -356,8 +416,7 @@ <h4>Parameters</h4> <dl> <dt>startBlock</dt> - <dd><p>A block that will be called with the result of attempting to start an audio session</p> -</dd> + <dd><p>A block that will be called with the result of attempting to start an audio session</p></dd> </dl> <h3 id="section--startAudioSessionWithTLS:startBlock:"> @@ -409,13 +468,11 @@ <h4>Parameters</h4> <dl> <dt>pcmAudioData</dt> - <dd><p>The data in PCM audio format, to be played</p> -</dd> + <dd><p>The data in PCM audio format, to be played</p></dd> </dl> <div> <h4>Return Value</h4> <p>Whether or not the data was successfully sent.</p> - </div> </section> diff --git a/docs/Classes/SDLSubscribeButton.html b/docs/Classes/SDLSubscribeButton.html index 31e68cf5c..631663d5f 100644 --- a/docs/Classes/SDLSubscribeButton.html +++ b/docs/Classes/SDLSubscribeButton.html @@ -84,7 +84,6 @@ <div> <h4>Return Value</h4> <p>An SDLSubscribeButton object</p> - </div> <h3 id="section--initWithHandler:"> @@ -107,13 +106,11 @@ <h4>Parameters</h4> <dl> <dt>handler</dt> - <dd><p>A callback that will be called when a button event occurs for the subscribed button.</p> -</dd> + <dd><p>A callback that will be called when a button event occurs for the subscribed button.</p></dd> </dl> <div> <h4>Return Value</h4> <p>An SDLSubscribeButton object</p> - </div> <h3 id="section--initWithDictionary:"> @@ -121,8 +118,7 @@ </h3> <p>@abstract Constructs a new SDLSubscribeButton object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -138,8 +134,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithButtonName:handler:"> @@ -151,7 +146,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeButton</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span> <span class="o"><</span><span class="n"><a href="../Protocols/SDLRequestHandler.html">SDLRequestHandler</a></span><span class="o">></span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeButton</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o"><</span><span class="n"><a href="../Protocols/SDLRequestHandler.html">SDLRequestHandler</a></span><span class="o">></span></code></pre> @@ -162,7 +157,6 @@ parameter </h3> <p>A handler that will let you know when the button you subscribed to is selected.</p> - <div class="aside aside-warning"> <p class="aside-title">Warning</p> This will only work if you use SDLManager. diff --git a/docs/Classes/SDLSubscribeButtonResponse.html b/docs/Classes/SDLSubscribeButtonResponse.html index c53b27aa7..4a9cbb86c 100644 --- a/docs/Classes/SDLSubscribeButtonResponse.html +++ b/docs/Classes/SDLSubscribeButtonResponse.html @@ -38,8 +38,7 @@ </h3> <p>@abstract Constructs a new SDLSubscribeButtonResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -55,8 +54,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLSubscribeVehicleData.html b/docs/Classes/SDLSubscribeVehicleData.html index 4497a7bd9..4b0f97ce2 100644 --- a/docs/Classes/SDLSubscribeVehicleData.html +++ b/docs/Classes/SDLSubscribeVehicleData.html @@ -73,8 +73,7 @@ </h3> <p>@abstract Constructs a new SDLSubscribeVehicleData object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -90,8 +89,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:"> @@ -103,7 +101,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -462,7 +460,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -477,7 +475,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -492,7 +490,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -507,7 +505,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -522,7 +520,7 @@ subscribed.</p> <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLSubscribeVehicleDataResponse.html b/docs/Classes/SDLSubscribeVehicleDataResponse.html index ca4e9fa84..a0b83ba66 100644 --- a/docs/Classes/SDLSubscribeVehicleDataResponse.html +++ b/docs/Classes/SDLSubscribeVehicleDataResponse.html @@ -62,8 +62,7 @@ </h3> <p>@abstract Constructs a new SDLSubscribeVehicleDataResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -79,8 +78,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-gps"> @@ -435,7 +433,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -450,7 +448,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -465,7 +463,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -480,7 +478,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -495,7 +493,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLSyncMsgVersion.html b/docs/Classes/SDLSyncMsgVersion.html index dbcb9bd33..10ea0fcde 100644 --- a/docs/Classes/SDLSyncMsgVersion.html +++ b/docs/Classes/SDLSyncMsgVersion.html @@ -6,8 +6,10 @@ <li><a href="#section--init">-init</a></li> <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> <li><a href="#section--initWithMajorVersion:minorVersion:">-initWithMajorVersion:minorVersion:</a></li> + <li><a href="#section--initWithMajorVersion:minorVersion:patchVersion:">-initWithMajorVersion:minorVersion:patchVersion:</a></li> <li><a href="#section-majorVersion">majorVersion</a></li> <li><a href="#section-minorVersion">minorVersion</a></li> + <li><a href="#section-patchVersion">patchVersion</a></li> </ul> <h3>Overview</h3> @@ -40,8 +42,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a newly allocated SDLSyncMsgVersion object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a newly allocated SDLSyncMsgVersion object indicated by the dictionary parameter</p> @@ -57,8 +58,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithMajorVersion:minorVersion:"> @@ -70,7 +70,22 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSyncMsgVersion</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSyncMsgVersion</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section--initWithMajorVersion:minorVersion:patchVersion:"> + -initWithMajorVersion:minorVersion:patchVersion: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSyncMsgVersion</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> @@ -116,4 +131,22 @@ + <h3 id="section-patchVersion"> + patchVersion + </h3> + + <p>@abstract Optional, allows backward-compatible fixes to the API without increasing the minor version of the interface</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">patchVersion</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">patchVersion</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + </section> diff --git a/docs/Classes/SDLSystemAction.html b/docs/Classes/SDLSystemAction.html index 373ef1a3b..ac021d35e 100644 --- a/docs/Classes/SDLSystemAction.html +++ b/docs/Classes/SDLSystemAction.html @@ -20,9 +20,7 @@ +valueOf: </h3> - <p>Convert String to SDLSystemAction -- parameter: value String -- returns: SDLSystemAction</p> + <p>Convert String to SDLSystemAction</p> @@ -38,21 +36,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String</p> -</dd> + <dd><p>String</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLSystemAction</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLSystemAction -- returns: an array that store all possible SDLSystemAction</p> + <p>@abstract Store the enumeration of all possible SDLSystemAction</p> @@ -68,7 +63,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLSystemAction</p> - </div> <h3 id="section-+DEFAULT_ACTION"> diff --git a/docs/Classes/SDLSystemCapability.html b/docs/Classes/SDLSystemCapability.html new file mode 100644 index 000000000..1f193b79d --- /dev/null +++ b/docs/Classes/SDLSystemCapability.html @@ -0,0 +1,173 @@ +<h1>SDLSystemCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section--initWithNavigationCapability:">-initWithNavigationCapability:</a></li> + <li><a href="#section--initWithPhoneCapability:">-initWithPhoneCapability:</a></li> + <li><a href="#section--initWithVideoStreamingCapability:">-initWithVideoStreamingCapability:</a></li> + <li><a href="#section-systemCapabilityType">systemCapabilityType</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> +</ul> + +<h3>Overview</h3> + +<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> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>@abstract Constructs a newly allocated SDLSystemCapability object</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>@abstract Constructs a newly allocated SDLSystemCapability object indicated by the dictionary parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use</p></dd> + </dl> + + <h3 id="section--initWithNavigationCapability:"> + -initWithNavigationCapability: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSystemCapability</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section--initWithPhoneCapability:"> + -initWithPhoneCapability: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSystemCapability</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section--initWithVideoStreamingCapability:"> + -initWithVideoStreamingCapability: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSystemCapability</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section-systemCapabilityType"> + systemCapabilityType + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSystemCapability</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section-navigationCapability"> + navigationCapability + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSystemCapability</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section-phoneCapability"> + phoneCapability + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSystemCapability</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section-videoStreamingCapability"> + videoStreamingCapability + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSystemCapability</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + +</section> diff --git a/docs/Classes/SDLSystemCapabilityType.html b/docs/Classes/SDLSystemCapabilityType.html new file mode 100644 index 000000000..704e402bc --- /dev/null +++ b/docs/Classes/SDLSystemCapabilityType.html @@ -0,0 +1,122 @@ +<h1>SDLSystemCapabilityType Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-+valueOf:">+valueOf:</a></li> + <li><a href="#section-+values">+values</a></li> + <li><a href="#section-+NAVIGATION">+NAVIGATION</a></li> + <li><a href="#section-+PHONE_CALL">+PHONE_CALL</a></li> + <li><a href="#section-+VIDEO_STREAMING">+VIDEO_STREAMING</a></li> +</ul> + +<h3>Overview</h3> + +<p>The type of system capability to get more information on</p> + + +<section class="section task-group-section"> + <h3 id="section-+valueOf:"> + +valueOf: + </h3> + + <p>Convert String to SDLSystemCapabilityType</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemCapabilityType</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">(</span><span class="n">of</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLSystemCapabilityType</span><span class="o">!</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>value</dt> + <dd><p>String</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>SDLSystemCapabilityType</p> + </div> + + <h3 id="section-+values"> + +values + </h3> + + <p>Returns an array of all possible SDLSystemCapabilityType values</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>an array that store all possible SDLSystemCapabilityType</p> + </div> + + <h3 id="section-+NAVIGATION"> + +NAVIGATION + </h3> + + <p>@abstract NAVIGATION</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemCapabilityType</span> <span class="o">*</span><span class="p">)</span><span class="n">NAVIGATION</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">navigation</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemCapabilityType</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+PHONE_CALL"> + +PHONE_CALL + </h3> + + <p>@abstract PHONE_CALL</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemCapabilityType</span> <span class="o">*</span><span class="p">)</span><span class="n">PHONE_CALL</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">phone_CALL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemCapabilityType</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+VIDEO_STREAMING"> + +VIDEO_STREAMING + </h3> + + <p>@abstract VIDEO_STREAMING</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemCapabilityType</span> <span class="o">*</span><span class="p">)</span><span class="n">VIDEO_STREAMING</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">video_STREAMING</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemCapabilityType</span><span class="o">!</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLSystemContext.html b/docs/Classes/SDLSystemContext.html index a2f9ea2f4..021e7885e 100644 --- a/docs/Classes/SDLSystemContext.html +++ b/docs/Classes/SDLSystemContext.html @@ -40,13 +40,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String value to retrieve the object for</p> -</dd> + <dd><p>String value to retrieve the object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLSystemContext</p> - </div> <h3 id="section-+values"> @@ -69,7 +67,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLSystemContext</p> - </div> <h3 id="section-+MAIN"> @@ -92,7 +89,6 @@ <div> <h4>Return Value</h4> <p>SDLSystemContext object of value <em>MAIN</em></p> - </div> <h3 id="section-+VRSESSION"> @@ -115,7 +111,6 @@ <div> <h4>Return Value</h4> <p>SDLSystemContext object of value <em>VRSESSION</em></p> - </div> <h3 id="section-+MENU"> @@ -138,7 +133,6 @@ <div> <h4>Return Value</h4> <p>SDLSystemContext object of value <em>MENU</em></p> - </div> <h3 id="section-+HMI_OBSCURED"> @@ -163,7 +157,6 @@ <div> <h4>Return Value</h4> <p>SDLSystemContext object of value <em>HMI_OBSCURED</em></p> - </div> <h3 id="section-+ALERT"> @@ -188,7 +181,6 @@ <div> <h4>Return Value</h4> <p>SDLSystemContext object of value <em>ALERT</em></p> - </div> </section> diff --git a/docs/Classes/SDLTTSChunk.html b/docs/Classes/SDLTTSChunk.html index 0fbbbb1d8..f9a25d3e1 100644 --- a/docs/Classes/SDLTTSChunk.html +++ b/docs/Classes/SDLTTSChunk.html @@ -87,8 +87,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithText:type:"> @@ -100,7 +99,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> @@ -115,7 +114,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> @@ -130,7 +129,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> @@ -145,7 +144,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> @@ -160,7 +159,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> @@ -175,7 +174,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc">SDLRPCStruct</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTTSChunk</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> diff --git a/docs/Classes/SDLTextAlignment.html b/docs/Classes/SDLTextAlignment.html index 926c7bb7e..c3cf07c7d 100644 --- a/docs/Classes/SDLTextAlignment.html +++ b/docs/Classes/SDLTextAlignment.html @@ -38,13 +38,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLTextAlignment</p> - </div> <h3 id="section-+values"> @@ -67,7 +65,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLTextAlignment</p> - </div> <h3 id="section-+LEFT_ALIGNED"> @@ -90,7 +87,6 @@ <div> <h4>Return Value</h4> <p>A SDLTextAlignment object with value of <em>LEFT_ALIGNED</em></p> - </div> <h3 id="section-+RIGHT_ALIGNED"> @@ -113,7 +109,6 @@ <div> <h4>Return Value</h4> <p>A SDLTextAlignment object with value of <em>RIGHT_ALIGNED</em></p> - </div> <h3 id="section-+CENTERED"> @@ -136,7 +131,6 @@ <div> <h4>Return Value</h4> <p>A SDLTextAlignment object with value of <em>CENTERED</em></p> - </div> </section> diff --git a/docs/Classes/SDLTextField.html b/docs/Classes/SDLTextField.html index b64cc222f..d659e76e5 100644 --- a/docs/Classes/SDLTextField.html +++ b/docs/Classes/SDLTextField.html @@ -101,8 +101,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use to construct the object</p> -</dd> + <dd><p>The dictionary to use to construct the object</p></dd> </dl> <h3 id="section-name"> @@ -110,7 +109,6 @@ </h3> <p>@abstract The enumeration identifying the field.</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLTextFieldName @@ -136,7 +134,6 @@ </h3> <p>@abstract The character set that is supported in this field.</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLCharacterSet diff --git a/docs/Classes/SDLTextFieldName.html b/docs/Classes/SDLTextFieldName.html index 19d9c9a5b..b193aebb7 100644 --- a/docs/Classes/SDLTextFieldName.html +++ b/docs/Classes/SDLTextFieldName.html @@ -63,13 +63,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String value to retrieve the object for</p> -</dd> + <dd><p>String value to retrieve the object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLTextFieldName</p> - </div> <h3 id="section-+values"> @@ -92,7 +90,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLTextFieldName</p> - </div> <h3 id="section-+mainField1"> @@ -115,7 +112,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>mainField1</em></p> - </div> <h3 id="section-+mainField2"> @@ -140,7 +136,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>mainField2</em></p> - </div> <h3 id="section-+mainField3"> @@ -165,7 +160,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>mainField3</em></p> - </div> <h3 id="section-+mainField4"> @@ -188,7 +182,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>mainField4</em></p> - </div> <h3 id="section-+statusBar"> @@ -211,7 +204,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>statusBar</em></p> - </div> <h3 id="section-+mediaClock"> @@ -236,7 +228,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>mediaClock</em></p> - </div> <h3 id="section-+mediaTrack"> @@ -261,7 +252,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>mediaTrack</em></p> - </div> <h3 id="section-+alertText1"> @@ -284,7 +274,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>alertText1</em></p> - </div> <h3 id="section-+alertText2"> @@ -309,7 +298,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>alertText2</em></p> - </div> <h3 id="section-+alertText3"> @@ -334,7 +322,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>alertText3</em></p> - </div> <h3 id="section-+scrollableMessageBody"> @@ -359,7 +346,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>scrollableMessageBody</em></p> - </div> <h3 id="section-+initialInteractionText"> @@ -384,7 +370,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>initialInteractionText</em></p> - </div> <h3 id="section-+navigationText1"> @@ -409,7 +394,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>navigationText1</em></p> - </div> <h3 id="section-+navigationText2"> @@ -434,7 +418,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>navigationText2</em></p> - </div> <h3 id="section-+ETA"> @@ -459,7 +442,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>ETA</em></p> - </div> <h3 id="section-+totalDistance"> @@ -484,7 +466,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>totalDistance</em></p> - </div> <h3 id="section-+audioPassThruDisplayText1"> @@ -509,7 +490,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>audioPassThruDisplayText1</em></p> - </div> <h3 id="section-+audioPassThruDisplayText2"> @@ -534,7 +514,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>audioPassThruDisplayText2</em></p> - </div> <h3 id="section-+sliderHeader"> @@ -559,7 +538,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>sliderHeader</em></p> - </div> <h3 id="section-+sliderFooter"> @@ -584,7 +562,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>sliderFooter</em></p> - </div> <h3 id="section-+menuName"> @@ -607,7 +584,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>menuName</em></p> - </div> <h3 id="section-+secondaryText"> @@ -630,7 +606,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>secondaryText</em></p> - </div> <h3 id="section-+tertiaryText"> @@ -653,7 +628,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>tertiaryText</em></p> - </div> <h3 id="section-+menuTitle"> @@ -676,7 +650,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>menuTitle</em></p> - </div> <h3 id="section-+locationName"> @@ -701,7 +674,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>locationName</em></p> - </div> <h3 id="section-+locationDescription"> @@ -726,7 +698,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>locationDescription</em></p> - </div> <h3 id="section-+addressLines"> @@ -751,7 +722,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>addressLines</em></p> - </div> <h3 id="section-+phoneNumber"> @@ -776,7 +746,6 @@ <div> <h4>Return Value</h4> <p>a SDLTextFieldName with value of <em>phoneNumber</em></p> - </div> </section> diff --git a/docs/Classes/SDLTouchManager.html b/docs/Classes/SDLTouchManager.html index 88f076596..8710a35ff 100644 --- a/docs/Classes/SDLTouchManager.html +++ b/docs/Classes/SDLTouchManager.html @@ -44,6 +44,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">CGFloat</span> <span class="n">tapDistanceThreshold</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tapDistanceThreshold</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -62,6 +65,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">CGFloat</span> <span class="n">tapTimeThreshold</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tapTimeThreshold</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -81,6 +87,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">CGFloat</span> <span class="n">movementTimeThreshold</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">movementTimeThreshold</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -101,6 +110,9 @@ <span class="n">BOOL</span> <span class="n">touchEnabled</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isTouchEnabled</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -119,6 +131,9 @@ <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">cancelPendingTouches</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">cancelPendingTouches</span><span class="p">()</span></code></pre> + diff --git a/docs/Classes/SDLTouchType.html b/docs/Classes/SDLTouchType.html index 2d2091a9f..2ff2574c6 100644 --- a/docs/Classes/SDLTouchType.html +++ b/docs/Classes/SDLTouchType.html @@ -8,6 +8,7 @@ <li><a href="#section-+BEGIN">+BEGIN</a></li> <li><a href="#section-+MOVE">+MOVE</a></li> <li><a href="#section-+END">+END</a></li> + <li><a href="#section-+CANCEL">+CANCEL</a></li> </ul> <h3>Overview</h3> @@ -71,4 +72,15 @@ + <h3 id="section-+CANCEL"> + +CANCEL + </h3> + + <p>Undocumented</p> + + + + + + </section> diff --git a/docs/Classes/SDLTriggerSource.html b/docs/Classes/SDLTriggerSource.html index 1c0dd6486..518dc19df 100644 --- a/docs/Classes/SDLTriggerSource.html +++ b/docs/Classes/SDLTriggerSource.html @@ -22,9 +22,7 @@ +valueOf: </h3> - <p>Convert String to SDLTriggerSource -- parameter: value The value of the string to get an object for -- returns: SDLTriggerSource</p> + <p>Convert String to SDLTriggerSource</p> @@ -40,21 +38,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLTriggerSource</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLTriggerSource -- returns: an array that store all possible SDLTriggerSource</p> + <p>@abstract Store the enumeration of all possible SDLTriggerSource</p> @@ -70,15 +65,13 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLTriggerSource</p> - </div> <h3 id="section-+MENU"> +MENU </h3> - <p>@abstract Selection made via menu -- returns: SDLTriggerSource with value of <em>MENU</em></p> + <p>@abstract Selection made via menu</p> @@ -94,15 +87,13 @@ <div> <h4>Return Value</h4> <p>SDLTriggerSource with value of <em>MENU</em></p> - </div> <h3 id="section-+VR"> +VR </h3> - <p>@abstract Selection made via Voice session -- returns: SDLTriggerSource with value of <em>VR</em></p> + <p>@abstract Selection made via Voice session</p> @@ -118,15 +109,13 @@ <div> <h4>Return Value</h4> <p>SDLTriggerSource with value of <em>VR</em></p> - </div> <h3 id="section-+KEYBOARD"> +KEYBOARD </h3> - <p>@abstract Selection made via Keyboard -- returns: SDLTriggerSource with value of <em>KEYBOARD</em></p> + <p>@abstract Selection made via Keyboard</p> @@ -142,7 +131,6 @@ <div> <h4>Return Value</h4> <p>SDLTriggerSource with value of <em>KEYBOARD</em></p> - </div> </section> diff --git a/docs/Classes/SDLUnregisterAppInterface.html b/docs/Classes/SDLUnregisterAppInterface.html index 53f609bf8..54949ef93 100644 --- a/docs/Classes/SDLUnregisterAppInterface.html +++ b/docs/Classes/SDLUnregisterAppInterface.html @@ -48,8 +48,7 @@ </h3> <p>@abstract Constructs a new SDLUnregisterAppInterface object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -65,8 +64,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLUnregisterAppInterfaceResponse.html b/docs/Classes/SDLUnregisterAppInterfaceResponse.html index 58aa335be..a8147164e 100644 --- a/docs/Classes/SDLUnregisterAppInterfaceResponse.html +++ b/docs/Classes/SDLUnregisterAppInterfaceResponse.html @@ -38,8 +38,7 @@ </h3> <p>@abstract Constructs a new SDLUnregisterAppInterfaceResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -55,8 +54,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLUnsubscribeButton.html b/docs/Classes/SDLUnsubscribeButton.html index 85090973c..8995e860d 100644 --- a/docs/Classes/SDLUnsubscribeButton.html +++ b/docs/Classes/SDLUnsubscribeButton.html @@ -48,8 +48,7 @@ See SDLSubscribeButton</p> </h3> <p>@abstract Constructs a new SDLUnsubscribeButton object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -65,8 +64,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithButtonName:"> @@ -78,7 +76,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeButton</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeButton</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLUnsubscribeButtonResponse.html b/docs/Classes/SDLUnsubscribeButtonResponse.html index 9242ae1d7..9e92c8215 100644 --- a/docs/Classes/SDLUnsubscribeButtonResponse.html +++ b/docs/Classes/SDLUnsubscribeButtonResponse.html @@ -38,8 +38,7 @@ </h3> <p>@abstract Constructs a new SDLUnsubscribeButtonResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -55,8 +54,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> </section> diff --git a/docs/Classes/SDLUnsubscribeVehicleData.html b/docs/Classes/SDLUnsubscribeVehicleData.html index 02cabae1b..588094c90 100644 --- a/docs/Classes/SDLUnsubscribeVehicleData.html +++ b/docs/Classes/SDLUnsubscribeVehicleData.html @@ -70,8 +70,7 @@ </h3> <p>@abstract Constructs a new SDLUnsubscribeVehicleData object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -87,8 +86,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section--initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:"> @@ -100,7 +98,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -439,7 +437,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -454,7 +452,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -469,7 +467,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -484,7 +482,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -499,7 +497,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -514,7 +512,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLUnsubscribeVehicleDataResponse.html b/docs/Classes/SDLUnsubscribeVehicleDataResponse.html index a1743ac4c..2b9432874 100644 --- a/docs/Classes/SDLUnsubscribeVehicleDataResponse.html +++ b/docs/Classes/SDLUnsubscribeVehicleDataResponse.html @@ -62,8 +62,7 @@ </h3> <p>@abstract Constructs a new SDLUnsubscribeVehicleDataResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</p> +parameter</p> @@ -79,8 +78,7 @@ parameter <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-gps"> @@ -435,7 +433,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -450,7 +448,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -465,7 +463,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -480,7 +478,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -495,7 +493,7 @@ parameter <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLUpdateMode.html b/docs/Classes/SDLUpdateMode.html index 47d168dd2..3e1a65fb8 100644 --- a/docs/Classes/SDLUpdateMode.html +++ b/docs/Classes/SDLUpdateMode.html @@ -24,9 +24,7 @@ +valueOf: </h3> - <p>Convert String to SDLUpdateMode -- parameter: value The value of the string to get an object for -- returns: SDLUpdateMode</p> + <p>Convert String to SDLUpdateMode</p> @@ -42,21 +40,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLUpdateMode</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLUpdateMode -- returns: an array that store all possible SDLUpdateMode</p> + <p>@abstract Store the enumeration of all possible SDLUpdateMode</p> @@ -72,15 +67,13 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLUpdateMode</p> - </div> <h3 id="section-+COUNTUP"> +COUNTUP </h3> - <p>@abstract Starts the media clock timer counting upward, in increments of 1 second. -- returns: SDLUpdateMode with value of <em>COUNTUP</em></p> + <p>@abstract Starts the media clock timer counting upward, in increments of 1 second.</p> @@ -96,15 +89,13 @@ <div> <h4>Return Value</h4> <p>SDLUpdateMode with value of <em>COUNTUP</em></p> - </div> <h3 id="section-+COUNTDOWN"> +COUNTDOWN </h3> - <p>@abstract Starts the media clock timer counting downward, in increments of 1 second. -- returns: SDLUpdateMode with value of <em>COUNTDOWN</em></p> + <p>@abstract Starts the media clock timer counting downward, in increments of 1 second.</p> @@ -120,15 +111,13 @@ <div> <h4>Return Value</h4> <p>SDLUpdateMode with value of <em>COUNTDOWN</em></p> - </div> <h3 id="section-+PAUSE"> +PAUSE </h3> - <p>@abstract Pauses the media clock timer. -- returns: SDLUpdateMode with value of <em>PAUSE</em></p> + <p>@abstract Pauses the media clock timer.</p> @@ -144,15 +133,13 @@ <div> <h4>Return Value</h4> <p>SDLUpdateMode with value of <em>PAUSE</em></p> - </div> <h3 id="section-+RESUME"> +RESUME </h3> - <p>@abstract Resumes the media clock timer. The timer resumes counting in whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN). -- returns: SDLUpdateMode with value of <em>RESUME</em></p> + <p>@abstract Resumes the media clock timer. The timer resumes counting in whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN).</p> @@ -168,7 +155,6 @@ <div> <h4>Return Value</h4> <p>SDLUpdateMode with value of <em>RESUME</em></p> - </div> <h3 id="section-+CLEAR"> diff --git a/docs/Classes/SDLUpdateTurnList.html b/docs/Classes/SDLUpdateTurnList.html index c17859838..92f4d5765 100644 --- a/docs/Classes/SDLUpdateTurnList.html +++ b/docs/Classes/SDLUpdateTurnList.html @@ -12,10 +12,13 @@ <h3>Overview</h3> -<p>Updates the list of next maneuvers, which can be requested by the user pressing the softbutton<br> - * “Turns” on the Navigation base screen. Three softbuttons are predefined by the system: Up, Down, Close. - *<p> - * @since SmartDeviceLink 2.0</p> +<p>Updates the list of next maneuvers, which can be requested by the user pressing the softbutton<br></p> + +<ul> +<li>“Turns” on the Navigation base screen. Three softbuttons are predefined by the system: Up, Down, Close. +*<p></li> +<li>@since SmartDeviceLink 2.0</li> +</ul> <section class="section task-group-section"> @@ -28,7 +31,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnList</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnList</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -43,7 +46,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnList</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnList</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> @@ -58,7 +61,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnList</span> <span class="p">:</span> <span class="nc">SDLRPCRequest</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnList</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> diff --git a/docs/Classes/SDLUpdateTurnListResponse.html b/docs/Classes/SDLUpdateTurnListResponse.html index 145817db3..0aa8fb172 100644 --- a/docs/Classes/SDLUpdateTurnListResponse.html +++ b/docs/Classes/SDLUpdateTurnListResponse.html @@ -9,8 +9,11 @@ <h3>Overview</h3> -<p>SDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called. - * Since<b>SmartDeviceLink 2.0</b></p> +<p>SDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called.</p> + +<ul> +<li>Since<b>SmartDeviceLink 2.0</b></li> +</ul> <section class="section task-group-section"> @@ -23,7 +26,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnListResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnListResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> @@ -38,7 +41,7 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnListResponse</span> <span class="p">:</span> <span class="nc">SDLRPCResponse</span></code></pre> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUpdateTurnListResponse</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> diff --git a/docs/Classes/SDLVRCapabilities.html b/docs/Classes/SDLVRCapabilities.html index 493f77a3d..650ea7b94 100644 --- a/docs/Classes/SDLVRCapabilities.html +++ b/docs/Classes/SDLVRCapabilities.html @@ -20,9 +20,7 @@ +valueOf: </h3> - <p>Convert String to SDLVRCapabilities -- parameter: value The value of the string to get an object for -- returns: SDLVRCapabilities</p> + <p>Convert String to SDLVRCapabilities</p> @@ -38,21 +36,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLVRCapabilities</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLVRCapabilities -- returns: an array that store all possible SDLVRCapabilities</p> + <p>@abstract Store the enumeration of all possible SDLVRCapabilities</p> @@ -68,15 +63,13 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLVRCapabilities</p> - </div> <h3 id="section-+TEXT"> +TEXT </h3> - <p>@abstract The SDL platform is capable of recognizing spoken text in the current language. -- returns: an SDLVRCapabilities instance pointer with value of <em>TEXT</em></p> + <p>@abstract The SDL platform is capable of recognizing spoken text in the current language.</p> @@ -92,7 +85,6 @@ <div> <h4>Return Value</h4> <p>an SDLVRCapabilities instance pointer with value of <em>TEXT</em></p> - </div> </section> diff --git a/docs/Classes/SDLVehicleDataActiveStatus.html b/docs/Classes/SDLVehicleDataActiveStatus.html index 976bd48de..d86de55a8 100644 --- a/docs/Classes/SDLVehicleDataActiveStatus.html +++ b/docs/Classes/SDLVehicleDataActiveStatus.html @@ -22,9 +22,7 @@ +valueOf: </h3> - <p>@abstract Convert String to SDLVehicleDataActiveStatus -- parameter: value NSString -- returns: SDLVehicleDataActiveStatus</p> + <p>@abstract Convert String to SDLVehicleDataActiveStatus</p> @@ -40,13 +38,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>NSString</p> -</dd> + <dd><p>NSString</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLVehicleDataActiveStatus</p> - </div> <h3 id="section-+values"> diff --git a/docs/Classes/SDLVehicleDataEventStatus.html b/docs/Classes/SDLVehicleDataEventStatus.html index e0aedc3b3..a5396f673 100644 --- a/docs/Classes/SDLVehicleDataEventStatus.html +++ b/docs/Classes/SDLVehicleDataEventStatus.html @@ -40,13 +40,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLVehicleDataEventStatus</p> - </div> <h3 id="section-+values"> @@ -69,7 +67,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLVehicleDataEventStatus</p> - </div> <h3 id="section-+NO_EVENT"> @@ -91,7 +88,6 @@ <div> <h4>Return Value</h4> <p>The SDLVehicleDataEventStatus instance with value of <em>NO_EVENT</em></p> - </div> <h3 id="section-+_NO"> @@ -113,7 +109,6 @@ <div> <h4>Return Value</h4> <p>The SDLVehicleDataEventStatus instance with value of <em>NO</em></p> - </div> <h3 id="section-+_YES"> @@ -135,7 +130,6 @@ <div> <h4>Return Value</h4> <p>The SDLVehicleDataEventStatus instance with value of <em>YES</em></p> - </div> <h3 id="section-+NOT_SUPPORTED"> @@ -158,7 +152,6 @@ <div> <h4>Return Value</h4> <p>the SDLVehicleDataEventStatus instance with value of <em>NOT_SUPPORTED</em></p> - </div> <h3 id="section-+FAULT"> diff --git a/docs/Classes/SDLVehicleDataNotificationStatus.html b/docs/Classes/SDLVehicleDataNotificationStatus.html index d166f696b..2bdee3c39 100644 --- a/docs/Classes/SDLVehicleDataNotificationStatus.html +++ b/docs/Classes/SDLVehicleDataNotificationStatus.html @@ -23,9 +23,7 @@ +valueOf: </h3> - <p>Convert String to SDLVehicleDataNotificationStatus -- parameter: value The value of the string to get an object for -- returns: SDLVehicleDataNotificationStatus</p> + <p>Convert String to SDLVehicleDataNotificationStatus</p> @@ -41,21 +39,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLVehicleDataNotificationStatus</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLVehicleDataNotificationStatus -- returns: an array that store all possible SDLVehicleDataNotificationStatus</p> + <p>@abstract Store the enumeration of all possible SDLVehicleDataNotificationStatus</p> @@ -71,7 +66,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLVehicleDataNotificationStatus</p> - </div> <h3 id="section-+NOT_SUPPORTED"> diff --git a/docs/Classes/SDLVehicleDataResultCode.html b/docs/Classes/SDLVehicleDataResultCode.html index 3b20200c0..1eb0ab0ca 100644 --- a/docs/Classes/SDLVehicleDataResultCode.html +++ b/docs/Classes/SDLVehicleDataResultCode.html @@ -26,9 +26,7 @@ +valueOf: </h3> - <p>Convert String to SDLVehicleDataResultCode -- parameter: value String -- returns: SDLVehicleDataResultCode</p> + <p>Convert String to SDLVehicleDataResultCode</p> @@ -44,21 +42,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String</p> -</dd> + <dd><p>String</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLVehicleDataResultCode</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLVehicleDataResultCode -- returns: an array that store all possible SDLVehicleDataResultCode</p> + <p>@abstract Store the enumeration of all possible SDLVehicleDataResultCode</p> @@ -74,7 +69,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLVehicleDataResultCode</p> - </div> <h3 id="section-+SUCCESS"> diff --git a/docs/Classes/SDLVehicleDataStatus.html b/docs/Classes/SDLVehicleDataStatus.html index b2d702e14..c422f5b2e 100644 --- a/docs/Classes/SDLVehicleDataStatus.html +++ b/docs/Classes/SDLVehicleDataStatus.html @@ -22,9 +22,7 @@ +valueOf: </h3> - <p>Convert String to SDLVehicleDataStatus -- parameter: value The value of the string to get an object for -- returns: SDLVehicleDataStatus</p> + <p>Convert String to SDLVehicleDataStatus</p> @@ -40,21 +38,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLVehicleDataStatus</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLVehicleDataStatus -- returns: an array that store all possible SDLVehicleDataStatus</p> + <p>@abstract Store the enumeration of all possible SDLVehicleDataStatus</p> @@ -70,15 +65,13 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLVehicleDataStatus</p> - </div> <h3 id="section-+NO_DATA_EXISTS"> +NO_DATA_EXISTS </h3> - <p>@abstract No data avaliable -- returns: SDLVehicleDataStatus: <em>NO_DATA_EXISTS</em></p> + <p>@abstract No data avaliable</p> @@ -94,7 +87,6 @@ <div> <h4>Return Value</h4> <p>SDLVehicleDataStatus: <em>NO_DATA_EXISTS</em></p> - </div> <h3 id="section-+OFF"> diff --git a/docs/Classes/SDLVehicleDataType.html b/docs/Classes/SDLVehicleDataType.html index bfb8f4e0c..98fc7f6cd 100644 --- a/docs/Classes/SDLVehicleDataType.html +++ b/docs/Classes/SDLVehicleDataType.html @@ -59,13 +59,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>String value to retrieve the object for</p> -</dd> + <dd><p>String value to retrieve the object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLVehicleDataType</p> - </div> <h3 id="section-+values"> @@ -88,7 +86,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLVehicleDataType</p> - </div> <h3 id="section-+VEHICLEDATA_GPS"> diff --git a/docs/Classes/SDLVehicleType.html b/docs/Classes/SDLVehicleType.html index f127c05d2..9aa6f71c4 100644 --- a/docs/Classes/SDLVehicleType.html +++ b/docs/Classes/SDLVehicleType.html @@ -41,8 +41,7 @@ -initWithDictionary: </h3> - <p>@abstract Constructs a newly allocated SDLVehicleType object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract Constructs a newly allocated SDLVehicleType object indicated by the dictionary parameter</p> @@ -58,8 +57,7 @@ <h4>Parameters</h4> <dl> <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> + <dd><p>The dictionary to use</p></dd> </dl> <h3 id="section-make"> diff --git a/docs/Classes/SDLVideoStreamingCapability.html b/docs/Classes/SDLVideoStreamingCapability.html new file mode 100644 index 000000000..3c320e6a5 --- /dev/null +++ b/docs/Classes/SDLVideoStreamingCapability.html @@ -0,0 +1,148 @@ +<h1>SDLVideoStreamingCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section--initWithVideoStreaming:maxBitrate:supportedFormats:hapticDataSupported:">-initWithVideoStreaming:maxBitrate:supportedFormats:hapticDataSupported:</a></li> + <li><a href="#section-preferredResolution">preferredResolution</a></li> + <li><a href="#section-maxBitrate">maxBitrate</a></li> + <li><a href="#section-supportedFormats">supportedFormats</a></li> + <li><a href="#section-hapticSpatialDataSupported">hapticSpatialDataSupported</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>@abstract Constructs a newly allocated SDLVideoStreamingCapability object</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>@abstract Constructs a newly allocated SDLVideoStreamingCapability object indicated by the dictionary parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use</p></dd> + </dl> + + <h3 id="section--initWithVideoStreaming:maxBitrate:supportedFormats:hapticDataSupported:"> + -initWithVideoStreaming:maxBitrate:supportedFormats:hapticDataSupported: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-preferredResolution"> + preferredResolution + </h3> + + <p>@abstract The preferred resolution of a video stream for decoding and rendering on HMI, optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">preferredResolution</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">preferredResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-maxBitrate"> + maxBitrate + </h3> + + <p>@abstract The maximum bitrate of video stream that is supported, in kbps, optional +minvalue= 0 +maxvalue= 2147483647</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">maxBitrate</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">maxBitrate</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-supportedFormats"> + supportedFormats + </h3> + + <p>@abstract Detailed information on each format supported by this system, in its preferred order, optional</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSMutableArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">supportedFormats</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">supportedFormats</span><span class="p">:</span> <span class="kt">NSMutableArray</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-hapticSpatialDataSupported"> + hapticSpatialDataSupported + </h3> + + <p>True if the system can utilize the haptic spatial data from the source being streamed.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">hapticSpatialDataSupported</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">hapticSpatialDataSupported</span><span class="p">:</span> <span class="kt">NSNumber</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLVideoStreamingCodec.html b/docs/Classes/SDLVideoStreamingCodec.html new file mode 100644 index 000000000..698be6d5d --- /dev/null +++ b/docs/Classes/SDLVideoStreamingCodec.html @@ -0,0 +1,162 @@ +<h1>SDLVideoStreamingCodec Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-+valueOf:">+valueOf:</a></li> + <li><a href="#section-+values">+values</a></li> + <li><a href="#section-+H264">+H264</a></li> + <li><a href="#section-+H265">+H265</a></li> + <li><a href="#section-+THEORA">+THEORA</a></li> + <li><a href="#section-+VP8">+VP8</a></li> + <li><a href="#section-+VP9">+VP9</a></li> +</ul> + +<h3>Overview</h3> + +<p>Enum for each type of video streaming codec</p> + +<p>@since SDL 4.7</p> + + +<section class="section task-group-section"> + <h3 id="section-+valueOf:"> + +valueOf: + </h3> + + <p>Convert String to SDLVideoStreamingCodec</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingCodec</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">(</span><span class="n">of</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingCodec</span><span class="o">!</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>value</dt> + <dd><p>String value to retrieve the object for</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>SDLVideoStreamingCodec</p> + </div> + + <h3 id="section-+values"> + +values + </h3> + + <p>@abstract Store the enumeration of all possible SDLVideoStreamingCodec</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>an array that store all possible SDLVideoStreamingCodec</p> + </div> + + <h3 id="section-+H264"> + +H264 + </h3> + + <p>@abstract SDLVideoStreamingCodec : H264</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingCodec</span> <span class="o">*</span><span class="p">)</span><span class="n">H264</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">h264</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingCodec</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+H265"> + +H265 + </h3> + + <p>@abstract SDLVideoStreamingCodec : H265</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingCodec</span> <span class="o">*</span><span class="p">)</span><span class="n">H265</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">h265</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingCodec</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+THEORA"> + +THEORA + </h3> + + <p>@abstract SDLVideoStreamingCodec : Theora</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingCodec</span> <span class="o">*</span><span class="p">)</span><span class="n">THEORA</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">theora</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingCodec</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+VP8"> + +VP8 + </h3> + + <p>@abstract SDLVideoStreamingCodec : VP8</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingCodec</span> <span class="o">*</span><span class="p">)</span><span class="n">VP8</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">vp8</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingCodec</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+VP9"> + +VP9 + </h3> + + <p>@abstract SDLVideoStreamingCodec : VP9</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingCodec</span> <span class="o">*</span><span class="p">)</span><span class="n">VP9</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">vp9</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingCodec</span><span class="o">!</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLVideoStreamingFormat.html b/docs/Classes/SDLVideoStreamingFormat.html new file mode 100644 index 000000000..a60724a59 --- /dev/null +++ b/docs/Classes/SDLVideoStreamingFormat.html @@ -0,0 +1,95 @@ +<h1>SDLVideoStreamingFormat Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> + <li><a href="#section-protocol">protocol</a></li> + <li><a href="#section-codec">codec</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--init"> + -init + </h3> + + <p>@abstract Constructs a newly allocated SDLVideoStreamingFormat object</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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"><code><span class="nf">init</span><span class="o">!</span><span class="p">()</span></code></pre> + + + + + <h3 id="section--initWithDictionary:"> + -initWithDictionary: + </h3> + + <p>@abstract Constructs a newly allocated SDLVideoStreamingFormat object indicated by the dictionary parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><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">NSMutableDictionary</span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="o">!</span><span class="p">(</span><span class="n">dictionary</span> <span class="nv">dict</span><span class="p">:</span> <span class="kt">NSMutableDictionary</span><span class="o">!</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>dict</dt> + <dd><p>The dictionary to use</p></dd> + </dl> + + <h3 id="section-protocol"> + protocol + </h3> + + <p>@abstract Protocol type, see VideoStreamingProtocol, mandatory</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVideoStreamingProtocol.html">SDLVideoStreamingProtocol</a></span> <span class="o">*</span><span class="n">protocol</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">var</span> <span class="err">`</span><span class="kd">protocol</span><span class="err">`</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVideoStreamingProtocol.html">SDLVideoStreamingProtocol</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-codec"> + codec + </h3> + + <p>@abstract Codec type, see VideoStreamingCodec, mandatory</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVideoStreamingCodec.html">SDLVideoStreamingCodec</a></span> <span class="o">*</span><span class="n">codec</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">codec</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVideoStreamingCodec.html">SDLVideoStreamingCodec</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLVideoStreamingProtocol.html b/docs/Classes/SDLVideoStreamingProtocol.html new file mode 100644 index 000000000..a4634647a --- /dev/null +++ b/docs/Classes/SDLVideoStreamingProtocol.html @@ -0,0 +1,162 @@ +<h1>SDLVideoStreamingProtocol Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-+valueOf:">+valueOf:</a></li> + <li><a href="#section-+values">+values</a></li> + <li><a href="#section-+RAW">+RAW</a></li> + <li><a href="#section-+RTP">+RTP</a></li> + <li><a href="#section-+RTSP">+RTSP</a></li> + <li><a href="#section-+RTMP">+RTMP</a></li> + <li><a href="#section-+WEBM">+WEBM</a></li> +</ul> + +<h3>Overview</h3> + +<p>Enum for each type of video streaming protocol</p> + +<p>@since SDL 4.7</p> + + +<section class="section task-group-section"> + <h3 id="section-+valueOf:"> + +valueOf: + </h3> + + <p>Convert String to SDLVideoStreamingProtocol</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingProtocol</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">value</span><span class="p">(</span><span class="n">of</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingProtocol</span><span class="o">!</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>value</dt> + <dd><p>String value to retrieve the object for</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>SDLVideoStreamingProtocol</p> + </div> + + <h3 id="section-+values"> + +values + </h3> + + <p>@abstract Store the enumeration of all possible SDLVideoStreamingProtocol</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span><span class="o">!</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>an array that store all possible SDLVideoStreamingProtocol</p> + </div> + + <h3 id="section-+RAW"> + +RAW + </h3> + + <p>@abstract SDLVideoStreamingProtocol : RAW</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingProtocol</span> <span class="o">*</span><span class="p">)</span><span class="n">RAW</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">raw</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingProtocol</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+RTP"> + +RTP + </h3> + + <p>@abstract SDLVideoStreamingProtocol : RTP</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingProtocol</span> <span class="o">*</span><span class="p">)</span><span class="n">RTP</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">rtp</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingProtocol</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+RTSP"> + +RTSP + </h3> + + <p>@abstract SDLVideoStreamingProtocol : RTSP</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingProtocol</span> <span class="o">*</span><span class="p">)</span><span class="n">RTSP</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">rtsp</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingProtocol</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+RTMP"> + +RTMP + </h3> + + <p>@abstract SDLVideoStreamingProtocol : RTMP</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingProtocol</span> <span class="o">*</span><span class="p">)</span><span class="n">RTMP</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">rtmp</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingProtocol</span><span class="o">!</span></code></pre> + + + + + <h3 id="section-+WEBM"> + +WEBM + </h3> + + <p>@abstract SDLVideoStreamingProtocol : WEBM</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVideoStreamingProtocol</span> <span class="o">*</span><span class="p">)</span><span class="n">WEBM</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">webm</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVideoStreamingProtocol</span><span class="o">!</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLWarningLightStatus.html b/docs/Classes/SDLWarningLightStatus.html index 07b5b657e..d00fecb92 100644 --- a/docs/Classes/SDLWarningLightStatus.html +++ b/docs/Classes/SDLWarningLightStatus.html @@ -23,9 +23,7 @@ +valueOf: </h3> - <p>Convert String to SDLWarningLightStatus -- parameter: value The value of the string to get an object for -- returns: SDLWarningLightStatus</p> + <p>Convert String to SDLWarningLightStatus</p> @@ -41,21 +39,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLWarningLightStatus</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLWarningLightStatus -- returns: an array that store all possible SDLWarningLightStatus</p> + <p>@abstract Store the enumeration of all possible SDLWarningLightStatus</p> @@ -71,15 +66,13 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLWarningLightStatus</p> - </div> <h3 id="section-+OFF"> +OFF </h3> - <p>@abstract Warninglight Off -- returns: SDLWarningLightStatus instance with value of <em>OFF</em></p> + <p>@abstract Warninglight Off</p> @@ -95,15 +88,13 @@ <div> <h4>Return Value</h4> <p>SDLWarningLightStatus instance with value of <em>OFF</em></p> - </div> <h3 id="section-+ON"> +ON </h3> - <p>@abstract Warninglight On -- returns: SDLWarningLightStatus instance with value of <em>ON</em></p> + <p>@abstract Warninglight On</p> @@ -119,15 +110,13 @@ <div> <h4>Return Value</h4> <p>SDLWarningLightStatus instance with value of <em>ON</em></p> - </div> <h3 id="section-+FLASH"> +FLASH </h3> - <p>@abstract Warninglight is flashing -- returns: SDLWarningLightStatus instance with value of <em>FLASH</em></p> + <p>@abstract Warninglight is flashing</p> @@ -143,15 +132,13 @@ <div> <h4>Return Value</h4> <p>SDLWarningLightStatus instance with value of <em>FLASH</em></p> - </div> <h3 id="section-+NOT_USED"> +NOT_USED </h3> - <p>@abstract Not used -- returns: SDLWarningLightStatus instance with value of <em>NOT_USED</em></p> + <p>@abstract Not used</p> @@ -167,7 +154,6 @@ <div> <h4>Return Value</h4> <p>SDLWarningLightStatus instance with value of <em>NOT_USED</em></p> - </div> </section> diff --git a/docs/Classes/SDLWaypointType.html b/docs/Classes/SDLWaypointType.html index 8643ef569..e62bfa391 100644 --- a/docs/Classes/SDLWaypointType.html +++ b/docs/Classes/SDLWaypointType.html @@ -35,13 +35,11 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLWayPointType</p> - </div> <h3 id="section-+values"> @@ -64,7 +62,6 @@ <div> <h4>Return Value</h4> <p>an array that store all possible SDLWayPointType</p> - </div> <h3 id="section-+ALL"> @@ -86,7 +83,6 @@ <div> <h4>Return Value</h4> <p>a SDLWayPointType with value of <em>PROMPT</em></p> - </div> <h3 id="section-+DESTINATION"> @@ -108,7 +104,6 @@ <div> <h4>Return Value</h4> <p>a SDLWayPointType with value of <em>DESTINATION</em></p> - </div> </section> diff --git a/docs/Classes/SDLWiperStatus.html b/docs/Classes/SDLWiperStatus.html index fdb57aa74..18d58777d 100644 --- a/docs/Classes/SDLWiperStatus.html +++ b/docs/Classes/SDLWiperStatus.html @@ -32,9 +32,7 @@ +valueOf: </h3> - <p>Convert String to SDLWiperStatus -- parameter: value The value of the string to get an object for -- returns: SDLWiperStatus</p> + <p>Convert String to SDLWiperStatus</p> @@ -50,21 +48,18 @@ <h4>Parameters</h4> <dl> <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> + <dd><p>The value of the string to get an object for</p></dd> </dl> <div> <h4>Return Value</h4> <p>SDLWiperStatus</p> - </div> <h3 id="section-+values"> +values </h3> - <p>@abstract Store the enumeration of all possible SDLWiperStatus -- returns: An array that store all possible SDLWiperStatus</p> + <p>@abstract Store the enumeration of all possible SDLWiperStatus</p> @@ -80,7 +75,6 @@ <div> <h4>Return Value</h4> <p>An array that store all possible SDLWiperStatus</p> - </div> <h3 id="section-+OFF"> |