diff options
| author | Joel Fischer <joeljfischer@gmail.com> | 2017-10-30 17:17:52 -0400 |
|---|---|---|
| committer | Joel Fischer <joeljfischer@gmail.com> | 2017-10-30 17:17:52 -0400 |
| commit | 4233b570952751945a3f066f35595fbcaec2b0ae (patch) | |
| tree | 7888256d1be523dfcb3f4343c59b64b1b516a644 /docs/Classes | |
| parent | 43f6367aa18724143032f3624887b0f867c5cc47 (diff) | |
| download | sdl_ios-release/5.0.0.tar.gz | |
Update for 5.0.0 releaserelease/5.0.0
Diffstat (limited to 'docs/Classes')
276 files changed, 6788 insertions, 23192 deletions
diff --git a/docs/Classes/SDLAbstractProtocol.html b/docs/Classes/SDLAbstractProtocol.html index d1f7d3dac..368e6683b 100644 --- a/docs/Classes/SDLAbstractProtocol.html +++ b/docs/Classes/SDLAbstractProtocol.html @@ -8,20 +8,14 @@ <li><a href="#section-protocolDelegateTable">protocolDelegateTable</a></li> <li><a href="#section-securityManager">securityManager</a></li> <li><a href="#section-appId">appId</a></li> - <li><a href="#section--sendStartSessionWithType:">-sendStartSessionWithType:</a></li> - <li><a href="#section--startServiceWithType:">-startServiceWithType:</a></li> - <li><a href="#section--startSecureServiceWithType:completionHandler:">-startSecureServiceWithType:completionHandler:</a></li> - <li><a href="#section--sendEndSessionWithType:">-sendEndSessionWithType:</a></li> + <li><a href="#section--startServiceWithType:payload:">-startServiceWithType:payload:</a></li> + <li><a href="#section--startSecureServiceWithType:payload:completionHandler:">-startSecureServiceWithType:payload:completionHandler:</a></li> <li><a href="#section--endServiceWithType:">-endServiceWithType:</a></li> <li><a href="#section--sendRPC:">-sendRPC:</a></li> <li><a href="#section--sendRPC:encrypted:error:">-sendRPC:encrypted:error:</a></li> - <li><a href="#section--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> - <li><a href="#section--sendHeartbeat">-sendHeartbeat</a></li> <li><a href="#section--handleBytesFromTransport:">-handleBytesFromTransport:</a></li> - <li><a href="#section--dispose">-dispose</a></li> </ul> <h3>Overview</h3> @@ -85,8 +79,8 @@ - <h3 id="section--sendStartSessionWithType:"> - -sendStartSessionWithType: + <h3 id="section--startServiceWithType:payload:"> + -startServiceWithType:payload: </h3> <p>Undocumented</p> @@ -96,30 +90,8 @@ - <h3 id="section--startServiceWithType:"> - -startServiceWithType: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--startSecureServiceWithType:completionHandler:"> - -startSecureServiceWithType:completionHandler: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--sendEndSessionWithType:"> - -sendEndSessionWithType: + <h3 id="section--startSecureServiceWithType:payload:completionHandler:"> + -startSecureServiceWithType:payload:completionHandler: </h3> <p>Undocumented</p> @@ -162,17 +134,6 @@ - <h3 id="section--sendRPCRequest:"> - -sendRPCRequest: - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--sendRawData:withServiceType:"> -sendRawData:withServiceType: </h3> @@ -195,28 +156,6 @@ - <h3 id="section--sendRawDataStream:withServiceType:"> - -sendRawDataStream:withServiceType: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--sendHeartbeat"> - -sendHeartbeat - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--handleBytesFromTransport:"> -handleBytesFromTransport: </h3> @@ -228,15 +167,4 @@ - <h3 id="section--dispose"> - -dispose - </h3> - - <p>Undocumented</p> - - - - - - </section> diff --git a/docs/Classes/SDLAbstractTransport.html b/docs/Classes/SDLAbstractTransport.html index 6d31fd83f..8f4da4575 100644 --- a/docs/Classes/SDLAbstractTransport.html +++ b/docs/Classes/SDLAbstractTransport.html @@ -8,7 +8,6 @@ <li><a href="#section--connect">-connect</a></li> <li><a href="#section--disconnect">-disconnect</a></li> <li><a href="#section--sendData:">-sendData:</a></li> - <li><a href="#section--dispose">-dispose</a></li> <li><a href="#section--retryDelay">-retryDelay</a></li> </ul> @@ -73,17 +72,6 @@ - <h3 id="section--dispose"> - -dispose - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--retryDelay"> -retryDelay </h3> diff --git a/docs/Classes/SDLAddCommand.html b/docs/Classes/SDLAddCommand.html index 742fadfa7..24ded1c16 100644 --- a/docs/Classes/SDLAddCommand.html +++ b/docs/Classes/SDLAddCommand.html @@ -3,9 +3,7 @@ <h3>Section Contents</h3> <ul> - <li><a href="#section--init">-init</a></li> <li><a href="#section--initWithHandler:">-initWithHandler:</a></li> - <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> <li><a href="#section--initWithId:vrCommands:handler:">-initWithId:vrCommands:handler:</a></li> <li><a href="#section--initWithId:vrCommands:menuName:handler:">-initWithId:vrCommands:menuName:handler:</a></li> <li><a href="#section--initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:">-initWithId:vrCommands:menuName:parentId:position:iconValue:iconType:handler:</a></li> @@ -38,7 +36,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 @@ -47,24 +44,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLAddCommand 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--initWithHandler:"> -initWithHandler: </h3> @@ -74,50 +53,25 @@ <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">initWithHandler</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCNotificationHandler">SDLRPCNotificationHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHandler</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">)</span><span class="nv">handler</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">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCNotificationHandler">SDLRPCNotificationHandler</a></span><span class="o">!</span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> <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:"> - -initWithDictionary: - </h3> - - <p>Constructs a new <em>SDLAddCommand</em> 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:vrCommands:handler:"> -initWithId:vrCommands:handler: </h3> @@ -127,7 +81,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></code></pre> @@ -142,7 +96,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></code></pre> @@ -157,7 +111,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></code></pre> @@ -168,7 +122,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. @@ -178,11 +131,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCNotificationHandler">SDLRPCNotificationHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCNotificationHandler">SDLRPCNotificationHandler</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">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCCommandNotificationHandler">SDLRPCCommandNotificationHandler</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> @@ -200,11 +154,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">cmdID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">cmdID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">cmdID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">cmdID</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -225,11 +179,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMenuParams.html">SDLMenuParams</a></span> <span class="o">*</span><span class="n">menuParams</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLMenuParams.html">SDLMenuParams</a></span> <span class="o">*</span><span class="n">menuParams</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuParams</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLMenuParams.html">SDLMenuParams</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">menuParams</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLMenuParams.html">SDLMenuParams</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> @@ -249,11 +203,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">vrCommands</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">vrCommands</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrCommands</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrCommands</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> @@ -273,11 +228,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">cmdIcon</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">cmdIcon</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">cmdIcon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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">cmdIcon</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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> diff --git a/docs/Classes/SDLAddCommandResponse.html b/docs/Classes/SDLAddCommandResponse.html deleted file mode 100644 index 9408d0b95..000000000 --- a/docs/Classes/SDLAddCommandResponse.html +++ /dev/null @@ -1,48 +0,0 @@ -<h1>SDLAddCommandResponse 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>SDLAddCommandResponse is sent, when SDLAddCommand has been called</p> - -<p>Since <b>SmartDeviceLink 1.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLAddSubMenu.html b/docs/Classes/SDLAddSubMenu.html index f9600ae12..827765439 100644 --- a/docs/Classes/SDLAddSubMenu.html +++ b/docs/Classes/SDLAddSubMenu.html @@ -3,8 +3,6 @@ <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:menuName:">-initWithId:menuName:</a></li> <li><a href="#section--initWithId:menuName:position:">-initWithId:menuName:position:</a></li> <li><a href="#section-menuID">menuID</a></li> @@ -28,49 +26,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLAddSubMenu 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 SDLAddSubMenu object indicated by the dictionary parameter - <p></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:menuName:"> -initWithId:menuName: </h3> @@ -80,7 +35,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 +50,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> @@ -113,11 +68,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">menuID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">menuID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuID</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -146,11 +101,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">position</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">position</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">position</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">position</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -165,11 +120,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">menuName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">menuName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</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/SDLAddSubMenuResponse.html b/docs/Classes/SDLAddSubMenuResponse.html deleted file mode 100644 index eb288793d..000000000 --- a/docs/Classes/SDLAddSubMenuResponse.html +++ /dev/null @@ -1,47 +0,0 @@ -<h1>SDLAddSubMenuResponse 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>SDLAddSubMenuResponse is sent, when SDLAddSubMenu has been called -Since <b>SmartDeviceLink 1.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</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> - - - - - -</section> diff --git a/docs/Classes/SDLAirbagStatus.html b/docs/Classes/SDLAirbagStatus.html index 349114714..e4d2253ca 100644 --- a/docs/Classes/SDLAirbagStatus.html +++ b/docs/Classes/SDLAirbagStatus.html @@ -3,8 +3,6 @@ <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-driverAirbagDeployed">driverAirbagDeployed</a></li> <li><a href="#section-driverSideAirbagDeployed">driverSideAirbagDeployed</a></li> <li><a href="#section-driverCurtainAirbagDeployed">driverCurtainAirbagDeployed</a></li> @@ -21,28 +19,6 @@ <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-driverAirbagDeployed"> driverAirbagDeployed </h3> diff --git a/docs/Classes/SDLAlert.html b/docs/Classes/SDLAlert.html index eb679e26b..c958e5649 100644 --- a/docs/Classes/SDLAlert.html +++ b/docs/Classes/SDLAlert.html @@ -3,8 +3,6 @@ <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--initWithAlertText1:alertText2:duration:">-initWithAlertText1:alertText2:duration:</a></li> <li><a href="#section--initWithAlertText1:alertText2:alertText3:">-initWithAlertText1:alertText2:alertText3:</a></li> <li><a href="#section--initWithAlertText1:alertText2:alertText3:duration:">-initWithAlertText1:alertText2:alertText3:duration:</a></li> @@ -56,48 +54,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLAlert 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 SDLAlert 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--initWithAlertText1:alertText2:duration:"> -initWithAlertText1:alertText2:duration: </h3> @@ -107,7 +63,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 +78,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 +93,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 +108,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 +123,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 +138,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 +153,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 +168,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 +183,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 +198,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> @@ -265,11 +221,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">alertText1</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">alertText1</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">alertText1</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">alertText1</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> @@ -293,11 +249,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">alertText2</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">alertText2</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">alertText2</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">alertText2</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> @@ -320,11 +276,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">alertText3</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">alertText3</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">alertText3</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">alertText3</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> @@ -336,7 +292,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 @@ -346,11 +301,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">ttsChunks</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">ttsChunks</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">ttsChunks</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ttsChunks</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> @@ -372,11 +328,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">duration</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">duration</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">duration</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">duration</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -394,11 +350,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">playTone</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">playTone</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">playTone</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">playTone</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -416,11 +372,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">progressIndicator</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">progressIndicator</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">progressIndicator</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">progressIndicator</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -434,7 +391,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 @@ -444,11 +400,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtons</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</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> diff --git a/docs/Classes/SDLAlertManeuver.html b/docs/Classes/SDLAlertManeuver.html index 4b998110e..a12497161 100644 --- a/docs/Classes/SDLAlertManeuver.html +++ b/docs/Classes/SDLAlertManeuver.html @@ -3,8 +3,6 @@ <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--initWithTTS:softButtons:">-initWithTTS:softButtons:</a></li> <li><a href="#section--initWithTTSChunks:softButtons:">-initWithTTSChunks:softButtons:</a></li> <li><a href="#section-ttsChunks">ttsChunks</a></li> @@ -17,36 +15,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - <h3 id="section--initWithTTS:softButtons:"> -initWithTTS:softButtons: </h3> @@ -56,7 +24,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 +39,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 +54,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 +69,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 deleted file mode 100644 index ad6069e1b..000000000 --- a/docs/Classes/SDLAlertManeuverResponse.html +++ /dev/null @@ -1,47 +0,0 @@ -<h1>SDLAlertManeuverResponse 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>SDLAlertManeuverResponse is sent, when SDLAlertManeuver has been called. - * @since SmartDeviceLink 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLAlertResponse.html b/docs/Classes/SDLAlertResponse.html index 900b6533c..93a080621 100644 --- a/docs/Classes/SDLAlertResponse.html +++ b/docs/Classes/SDLAlertResponse.html @@ -3,8 +3,6 @@ <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-tryAgainTime">tryAgainTime</a></li> </ul> @@ -15,36 +13,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - <h3 id="section-tryAgainTime"> tryAgainTime </h3> @@ -54,7 +22,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 deleted file mode 100644 index 4aff7b620..000000000 --- a/docs/Classes/SDLAmbientLightStatus.html +++ /dev/null @@ -1,175 +0,0 @@ -<h1>SDLAmbientLightStatus 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-+NIGHT">+NIGHT</a></li> - <li><a href="#section-+TWILIGHT_1">+TWILIGHT_1</a></li> - <li><a href="#section-+TWILIGHT_2">+TWILIGHT_2</a></li> - <li><a href="#section-+TWILIGHT_3">+TWILIGHT_3</a></li> - <li><a href="#section-+TWILIGHT_4">+TWILIGHT_4</a></li> - <li><a href="#section-+DAY">+DAY</a></li> - <li><a href="#section-+UNKNOWN">+UNKNOWN</a></li> - <li><a href="#section-+INVALID">+INVALID</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the status of the ambient light sensor -@since SDL 3.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+NIGHT"> - +NIGHT - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+TWILIGHT_1"> - +TWILIGHT_1 - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+TWILIGHT_2"> - +TWILIGHT_2 - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+TWILIGHT_3"> - +TWILIGHT_3 - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+TWILIGHT_4"> - +TWILIGHT_4 - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+DAY"> - +DAY - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+UNKNOWN"> - +UNKNOWN - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+INVALID"> - +INVALID - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLAppHMIType.html b/docs/Classes/SDLAppHMIType.html deleted file mode 100644 index 33a9cd30f..000000000 --- a/docs/Classes/SDLAppHMIType.html +++ /dev/null @@ -1,302 +0,0 @@ -<h1>SDLAppHMIType Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+valueOf:">+valueOf:</a></li> - <li><a href="#section-+values">+values</a></li> - <li><a href="#section-+DEFAULT">+DEFAULT</a></li> - <li><a href="#section-+COMMUNICATION">+COMMUNICATION</a></li> - <li><a href="#section-+MEDIA">+MEDIA</a></li> - <li><a href="#section-+MESSAGING">+MESSAGING</a></li> - <li><a href="#section-+NAVIGATION">+NAVIGATION</a></li> - <li><a href="#section-+INFORMATION">+INFORMATION</a></li> - <li><a href="#section-+SOCIAL">+SOCIAL</a></li> - <li><a href="#section-+BACKGROUND_PROCESS">+BACKGROUND_PROCESS</a></li> - <li><a href="#section-+TESTING">+TESTING</a></li> - <li><a href="#section-+SYSTEM">+SYSTEM</a></li> -</ul> - -<h3>Overview</h3> - -<p>Enumeration listing possible app hmi types.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to AppHMIType</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="nf">valueOf</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">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">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <h4>Parameters</h4> - <dl> - <dt>value</dt> - <dd><p>The value of the string to get an object for</p> -</dd> - </dl> - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLAppHMIType</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span> <span class="o">*</span><span class="p">)</span><span class="n">values</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">values</span><span class="p">()</span> <span class="o">-></span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>an array that store all possible SDLAppHMIType</p> - - </div> - - <h3 id="section-+DEFAULT"> - +DEFAULT - </h3> - - <p>@abstract The App will have default rights.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">DEFAULT</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="err">`</span><span class="k">default</span><span class="err">`</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType with value <em>DEFAULT</em></p> - - </div> - - <h3 id="section-+COMMUNICATION"> - +COMMUNICATION - </h3> - - <p>@abstract Communication type of App</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">COMMUNICATION</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">communication</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType with value <em>COMMUNICATION</em></p> - - </div> - - <h3 id="section-+MEDIA"> - +MEDIA - </h3> - - <p>@abstract App dealing with Media</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">MEDIA</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">media</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType with value <em>MEDIA</em></p> - - </div> - - <h3 id="section-+MESSAGING"> - +MESSAGING - </h3> - - <p>@abstract Messaging App</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">MESSAGING</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">messaging</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType with value <em>MESSAGING</em></p> - - </div> - - <h3 id="section-+NAVIGATION"> - +NAVIGATION - </h3> - - <p>@abstract Navigation App</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">NAVIGATION</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">navigation</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType with value <em>NAVIGATION</em></p> - - </div> - - <h3 id="section-+INFORMATION"> - +INFORMATION - </h3> - - <p>@abstract Information App</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">INFORMATION</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">information</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType with value <em>INFORMATION</em></p> - - </div> - - <h3 id="section-+SOCIAL"> - +SOCIAL - </h3> - - <p>@abstract App dealing with social media</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">SOCIAL</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">social</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType with value <em>SOCIAL</em></p> - - </div> - - <h3 id="section-+BACKGROUND_PROCESS"> - +BACKGROUND_PROCESS - </h3> - - <p>Undocumented</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAppHMIType</span> <span class="p">:</span> <span class="nc">SDLEnum</span></code></pre> - - - - - - <h3 id="section-+TESTING"> - +TESTING - </h3> - - <p>@abstract App only for Testing purposes</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">TESTING</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">testing</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType with value <em>TESTING</em></p> - - </div> - - <h3 id="section-+SYSTEM"> - +SYSTEM - </h3> - - <p>@abstract System App</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppHMIType</span> <span class="o">*</span><span class="p">)</span><span class="n">SYSTEM</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">system</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppHMIType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppHMIType with value <em>SYSTEM</em></p> - - </div> - -</section> diff --git a/docs/Classes/SDLAppInterfaceUnregisteredReason.html b/docs/Classes/SDLAppInterfaceUnregisteredReason.html deleted file mode 100644 index 071c32115..000000000 --- a/docs/Classes/SDLAppInterfaceUnregisteredReason.html +++ /dev/null @@ -1,312 +0,0 @@ -<h1>SDLAppInterfaceUnregisteredReason 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-+IGNITION_OFF">+IGNITION_OFF</a></li> - <li><a href="#section-+BLUETOOTH_OFF">+BLUETOOTH_OFF</a></li> - <li><a href="#section-+USB_DISCONNECTED">+USB_DISCONNECTED</a></li> - <li><a href="#section-+REQUEST_WHILE_IN_NONE_HMI_LEVEL">+REQUEST_WHILE_IN_NONE_HMI_LEVEL</a></li> - <li><a href="#section-+TOO_MANY_REQUESTS">+TOO_MANY_REQUESTS</a></li> - <li><a href="#section-+DRIVER_DISTRACTION_VIOLATION">+DRIVER_DISTRACTION_VIOLATION</a></li> - <li><a href="#section-+LANGUAGE_CHANGE">+LANGUAGE_CHANGE</a></li> - <li><a href="#section-+MASTER_RESET">+MASTER_RESET</a></li> - <li><a href="#section-+FACTORY_DEFAULTS">+FACTORY_DEFAULTS</a></li> - <li><a href="#section-+APP_UNAUTHORIZED">+APP_UNAUTHORIZED</a></li> -</ul> - -<h3>Overview</h3> - -<p>Indicates reason why app interface was unregistered. The application is being disconnected by SDL.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLAppInterfaceUnregisteredReason</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</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">SDLAppInterfaceUnregisteredReason</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>SDLAppInterfaceUnregisteredReason</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLAppInterfaceUnregisteredReason</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 stores all possible SDLAppInterfaceUnregisteredReason</p> - - </div> - - <h3 id="section-+IGNITION_OFF"> - +IGNITION_OFF - </h3> - - <p>@abstract Vehicle ignition turned off.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">IGNITION_OFF</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">ignition_OFF</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppInterfaceUnregisteredReason with value <em>IGNITION_OFF</em></p> - - </div> - - <h3 id="section-+BLUETOOTH_OFF"> - +BLUETOOTH_OFF - </h3> - - <p>@abstract Bluetooth was turned off, causing termination of a necessary Bluetooth connection.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">BLUETOOTH_OFF</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">bluetooth_OFF</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppInterfaceUnregisteredReason with value <em>BLUETOOTH_OFF</em></p> - - </div> - - <h3 id="section-+USB_DISCONNECTED"> - +USB_DISCONNECTED - </h3> - - <p>@abstract USB was disconnected, causing termination of a necessary iAP connection.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">USB_DISCONNECTED</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">usb_DISCONNECTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppInterfaceUnregisteredReason with value <em>USB_DISCONNECTED</em></p> - - </div> - - <h3 id="section-+REQUEST_WHILE_IN_NONE_HMI_LEVEL"> - +REQUEST_WHILE_IN_NONE_HMI_LEVEL - </h3> - - <p>@abstract Application attempted SmartDeviceLink RPC request while HMILevel = NONE. App must have HMILevel other than NONE to issue RPC requests or get notifications or RPC responses.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">REQUEST_WHILE_IN_NONE_HMI_LEVEL</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">request_WHILE_IN_NONE_HMI_LEVEL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <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"> - +TOO_MANY_REQUESTS - </h3> - - <p>@abstract Either too many – or too many per unit of time – requests were made by the application.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">TOO_MANY_REQUESTS</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">too_MANY_REQUESTS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppInterfaceUnregisteredReason with value <em>TOO_MANY_REQUESTS</em></p> - - </div> - - <h3 id="section-+DRIVER_DISTRACTION_VIOLATION"> - +DRIVER_DISTRACTION_VIOLATION - </h3> - - <p>@abstract The application has issued requests which cause driver distraction rules to be violated.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">DRIVER_DISTRACTION_VIOLATION</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">driver_DISTRACTION_VIOLATION</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppInterfaceUnregisteredReason with value <em>DRIVER_DISTRACTION_VIOLATION</em></p> - - </div> - - <h3 id="section-+LANGUAGE_CHANGE"> - +LANGUAGE_CHANGE - </h3> - - <p>@abstract The user performed a language change on the SDL platform, causing the application to need to be reregistered for the new language.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">LANGUAGE_CHANGE</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">language_CHANGE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppInterfaceUnregisteredReason with value <em>LANGUAGE_CHANGE</em></p> - - </div> - - <h3 id="section-+MASTER_RESET"> - +MASTER_RESET - </h3> - - <p>@abstract The user performed a MASTER RESET on the SDL platform, causing removal of a necessary Bluetooth pairing.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">MASTER_RESET</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">master_RESET</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppInterfaceUnregisteredReason with value <em>MASTER_RESET</em></p> - - </div> - - <h3 id="section-+FACTORY_DEFAULTS"> - +FACTORY_DEFAULTS - </h3> - - <p>@abstract The user restored settings to FACTORY DEFAULTS on the SDL platform.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">FACTORY_DEFAULTS</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">factory_DEFAULTS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAppInterfaceUnregisteredReason with value <em>FACTORY_DEFAULTS</em></p> - - </div> - - <h3 id="section-+APP_UNAUTHORIZED"> - +APP_UNAUTHORIZED - </h3> - - <p>@abstract The app is not being authorized to be connected to SDL.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAppInterfaceUnregisteredReason</span> <span class="o">*</span><span class="p">)</span><span class="n">APP_UNAUTHORIZED</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">app_UNAUTHORIZED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAppInterfaceUnregisteredReason</span><span class="o">!</span></code></pre> - - - - <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..b7e0fbb40 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> @@ -38,27 +37,20 @@ <span class="nf">asImageFormat</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span><span class="nv">imageFormat</span><span class="p">;</span></code></pre> - <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> - <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 +62,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> @@ -86,27 +77,20 @@ <span class="p">(</span><span class="n"><a href="../Enums/SDLArtworkImageFormat.html">SDLArtworkImageFormat</a></span><span class="p">)</span><span class="nv">imageFormat</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">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> - <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 +109,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..dd998494c 100644 --- a/docs/Classes/SDLAudioPassThruCapabilities.html +++ b/docs/Classes/SDLAudioPassThruCapabilities.html @@ -3,8 +3,6 @@ <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-samplingRate">samplingRate</a></li> <li><a href="#section-bitsPerSample">bitsPerSample</a></li> <li><a href="#section-audioType">audioType</a></li> @@ -13,7 +11,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> @@ -23,73 +22,31 @@ </tr> <tr> <td>samplingRate</td> - <td>SDLSamplingRate * </td> + <td>SDLSamplingRate </td> <td>Describes the sampling rate for AudioPassThru </td> <td>SmartDeviceLink 2.0</td> </tr> <tr> <td>bitsPerSample</td> - <td>SDLBitsPerSample * </td> + <td>SDLBitsPerSample </td> <td>Describes the sample depth in bit for AudioPassThru </td> <td>SmartDeviceLink 2.0</td> </tr> <tr> <td>audioType</td> - <td>SDLAudioType * </td> + <td>SDLAudioType </td> <td>Describes the audiotype for AudioPassThru </td> <td>SmartDeviceLink 2.0</td> </tr> </table> -Since <b>SmartDeviceLink 2.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLAudioPassThruCapabilities 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 newly allocated SDLAudioPassThruCapabilities object indicated by the Hashtable parameter -- parameter: dict The dictionary to use</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> +<p>Since <b>SmartDeviceLink 2.0</b></p> - - <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> - +<section class="section task-group-section"> <h3 id="section-samplingRate"> samplingRate </h3> @@ -99,11 +56,11 @@ Since <b>SmartDeviceLink 2.0</b></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/SDLSamplingRate.html">SDLSamplingRate</a></span> <span class="o">*</span><span class="n">samplingRate</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSamplingRate.h@T@SDLSamplingRate">SDLSamplingRate</a></span> <span class="n">_Nonnull</span> <span class="n">samplingRate</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">samplingRate</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSamplingRate.html">SDLSamplingRate</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">samplingRate</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSamplingRate.h@T@SDLSamplingRate">SDLSamplingRate</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -117,11 +74,11 @@ Since <b>SmartDeviceLink 2.0</b></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/SDLBitsPerSample.html">SDLBitsPerSample</a></span> <span class="o">*</span><span class="n">bitsPerSample</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLBitsPerSample.h@T@SDLBitsPerSample">SDLBitsPerSample</a></span> <span class="n">_Nonnull</span> <span class="n">bitsPerSample</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">bitsPerSample</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBitsPerSample.html">SDLBitsPerSample</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">bitsPerSample</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLBitsPerSample.h@T@SDLBitsPerSample">SDLBitsPerSample</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -135,11 +92,11 @@ Since <b>SmartDeviceLink 2.0</b></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/SDLAudioType.html">SDLAudioType</a></span> <span class="o">*</span><span class="n">audioType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLAudioType.h@T@SDLAudioType">SDLAudioType</a></span> <span class="n">_Nonnull</span> <span class="n">audioType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAudioType.html">SDLAudioType</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">audioType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLAudioType.h@T@SDLAudioType">SDLAudioType</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/SDLAudioStreamingState.html b/docs/Classes/SDLAudioStreamingState.html deleted file mode 100644 index 54f3ad005..000000000 --- a/docs/Classes/SDLAudioStreamingState.html +++ /dev/null @@ -1,144 +0,0 @@ -<h1>SDLAudioStreamingState 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-+AUDIBLE">+AUDIBLE</a></li> - <li><a href="#section-+ATTENUATED">+ATTENUATED</a></li> - <li><a href="#section-+NOT_AUDIBLE">+NOT_AUDIBLE</a></li> -</ul> - -<h3>Overview</h3> - -<p>Describes whether or not streaming audio is currently audible to the user. Though provided in every OnHMIStatus notification, this information is only relevant for applications that declare themselves as media apps in RegisterAppInterface</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLAudioStreamingState</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAudioStreamingState</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">SDLAudioStreamingState</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>SDLAudioStreamingState</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLAudioStreamingState</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 SDLAudioStreamingState</p> - - </div> - - <h3 id="section-+AUDIBLE"> - +AUDIBLE - </h3> - - <p>@abstract Currently streaming audio, if any, is audible to user.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAudioStreamingState</span> <span class="o">*</span><span class="p">)</span><span class="n">AUDIBLE</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">audible</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAudioStreamingState</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAudioStreamingState with value of <em>AUDIBLE</em></p> - - </div> - - <h3 id="section-+ATTENUATED"> - +ATTENUATED - </h3> - - <p>@abstract Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAudioStreamingState</span> <span class="o">*</span><span class="p">)</span><span class="n">ATTENUATED</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">attenuated</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAudioStreamingState</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAudioStreamingState with value of <em>ATTENUATED</em></p> - - </div> - - <h3 id="section-+NOT_AUDIBLE"> - +NOT_AUDIBLE - </h3> - - <p>@abstract Currently streaming audio, if any, is not audible to user. made via VR session.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAudioStreamingState</span> <span class="o">*</span><span class="p">)</span><span class="n">NOT_AUDIBLE</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">not_AUDIBLE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAudioStreamingState</span><span class="o">!</span></code></pre> - - - - <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 deleted file mode 100644 index 65652a5ce..000000000 --- a/docs/Classes/SDLAudioType.html +++ /dev/null @@ -1,94 +0,0 @@ -<h1>SDLAudioType 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-+PCM">+PCM</a></li> -</ul> - -<h3>Overview</h3> - -<p>Describes different audio type options for PerformAudioPassThru</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLAudioType</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAudioType</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">SDLAudioType</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>SDLAudioType</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLAudioType</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 SDLAudioType</p> - - </div> - - <h3 id="section-+PCM"> - +PCM - </h3> - - <p>@abstract PCM raw audio</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLAudioType</span> <span class="o">*</span><span class="p">)</span><span class="n">PCM</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">pcm</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLAudioType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLAudioType with value of <em>PCM</em></p> - - </div> - -</section> diff --git a/docs/Classes/SDLBeltStatus.html b/docs/Classes/SDLBeltStatus.html index 2a936c21c..72996b103 100644 --- a/docs/Classes/SDLBeltStatus.html +++ b/docs/Classes/SDLBeltStatus.html @@ -3,8 +3,6 @@ <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-driverBeltDeployed">driverBeltDeployed</a></li> <li><a href="#section-passengerBeltDeployed">passengerBeltDeployed</a></li> <li><a href="#section-passengerBuckleBelted">passengerBuckleBelted</a></li> @@ -28,28 +26,6 @@ <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-driverBeltDeployed"> driverBeltDeployed </h3> diff --git a/docs/Classes/SDLBitsPerSample.html b/docs/Classes/SDLBitsPerSample.html deleted file mode 100644 index f50340444..000000000 --- a/docs/Classes/SDLBitsPerSample.html +++ /dev/null @@ -1,118 +0,0 @@ -<h1>SDLBitsPerSample 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-+_8_BIT">+_8_BIT</a></li> - <li><a href="#section-+_16_BIT">+_16_BIT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Describes different bit depth options for PerformAudioPassThru</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLBitsPerSample</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLBitsPerSample</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">SDLBitsPerSample</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>SDLBitsPerSample</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLBitsPerSample</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 SDLBitsPerSample</p> - - </div> - - <h3 id="section-+_8_BIT"> - +_8_BIT - </h3> - - <p>@abstract 8 bits per sample</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLBitsPerSample</span> <span class="o">*</span><span class="p">)</span><span class="n">_8_BIT</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">_8_BIT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLBitsPerSample</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLBitsPerSample with value of <em>8_BIT</em></p> - - </div> - - <h3 id="section-+_16_BIT"> - +_16_BIT - </h3> - - <p>@abstract 16 bits per sample</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLBitsPerSample</span> <span class="o">*</span><span class="p">)</span><span class="n">_16_BIT</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">_16_BIT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLBitsPerSample</span><span class="o">!</span></code></pre> - - - - <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..b22144921 100644 --- a/docs/Classes/SDLBodyInformation.html +++ b/docs/Classes/SDLBodyInformation.html @@ -3,8 +3,6 @@ <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-parkBrakeActive">parkBrakeActive</a></li> <li><a href="#section-ignitionStableStatus">ignitionStableStatus</a></li> <li><a href="#section-ignitionStatus">ignitionStatus</a></li> @@ -20,50 +18,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLBodyInformation 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 new SDLBodyInformation object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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-parkBrakeActive"> parkBrakeActive </h3> @@ -73,11 +27,12 @@ parameter <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">parkBrakeActive</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">parkBrakeActive</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">parkBrakeActive</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">parkBrakeActive</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -91,12 +46,12 @@ parameter <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/SDLIgnitionStableStatus.html">SDLIgnitionStableStatus</a></span> <span class="o">*</span><span class="n">ignitionStableStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLIgnitionStableStatus.h@T@SDLIgnitionStableStatus">SDLIgnitionStableStatus</a></span> <span class="n">_Nonnull</span> <span class="n">ignitionStableStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">ignitionStableStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLIgnitionStableStatus.html">SDLIgnitionStableStatus</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">ignitionStableStatus</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLIgnitionStableStatus.h@T@SDLIgnitionStableStatus">SDLIgnitionStableStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -110,11 +65,12 @@ parameter <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/SDLIgnitionStatus.html">SDLIgnitionStatus</a></span> <span class="o">*</span><span class="n">ignitionStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLIgnitionStatus.h@T@SDLIgnitionStatus">SDLIgnitionStatus</a></span> <span class="n">_Nonnull</span> <span class="n">ignitionStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">ignitionStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLIgnitionStatus.html">SDLIgnitionStatus</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">ignitionStatus</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLIgnitionStatus.h@T@SDLIgnitionStatus">SDLIgnitionStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -128,11 +84,12 @@ parameter <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">driverDoorAjar</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">driverDoorAjar</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverDoorAjar</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverDoorAjar</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -146,11 +103,12 @@ parameter <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">passengerDoorAjar</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">passengerDoorAjar</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">passengerDoorAjar</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">passengerDoorAjar</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -164,11 +122,12 @@ parameter <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">rearLeftDoorAjar</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">rearLeftDoorAjar</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rearLeftDoorAjar</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rearLeftDoorAjar</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -182,11 +141,12 @@ parameter <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">rearRightDoorAjar</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">rearRightDoorAjar</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rearRightDoorAjar</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rearRightDoorAjar</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLButtonCapabilities.html b/docs/Classes/SDLButtonCapabilities.html index eabf7370c..a4c906ca2 100644 --- a/docs/Classes/SDLButtonCapabilities.html +++ b/docs/Classes/SDLButtonCapabilities.html @@ -3,8 +3,6 @@ <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-name">name</a></li> <li><a href="#section-shortPressAvailable">shortPressAvailable</a></li> <li><a href="#section-longPressAvailable">longPressAvailable</a></li> @@ -19,49 +17,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLButtonCapabilities 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 newly allocated SDLButtonCapabilities object indicated by the Hashtable parameter -- parameter: dict The dictionary to use</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-name"> name </h3> @@ -71,11 +26,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLButtonName.html">SDLButtonName</a></span> <span class="o">*</span><span class="n">name</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLButtonName.html">SDLButtonName</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">name</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -91,11 +46,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">shortPressAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">shortPressAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">shortPressAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">shortPressAvailable</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -111,11 +67,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">longPressAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">longPressAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">longPressAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">longPressAvailable</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -131,11 +88,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">upDownAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">upDownAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">upDownAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">upDownAvailable</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLButtonEventMode.html b/docs/Classes/SDLButtonEventMode.html deleted file mode 100644 index 364c2c9b8..000000000 --- a/docs/Classes/SDLButtonEventMode.html +++ /dev/null @@ -1,123 +0,0 @@ -<h1>SDLButtonEventMode 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-+BUTTONUP">+BUTTONUP</a></li> - <li><a href="#section-+BUTTONDOWN">+BUTTONDOWN</a></li> -</ul> - -<h3>Overview</h3> - -<p>Indicates whether the button was depressed or released. A BUTTONUP event will always be preceded by a BUTTONDOWN event.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonEventMode</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">SDLButtonEventMode</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>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> - - - - <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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonEventMode</span> <span class="o">*</span><span class="p">)</span><span class="n">BUTTONUP</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">buttonup</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonEventMode</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonEventMode</span> <span class="o">*</span><span class="p">)</span><span class="n">BUTTONDOWN</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">buttondown</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonEventMode</span><span class="o">!</span></code></pre> - - - - <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 deleted file mode 100644 index 2ec047792..000000000 --- a/docs/Classes/SDLButtonName.html +++ /dev/null @@ -1,474 +0,0 @@ -<h1>SDLButtonName 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-+OK">+OK</a></li> - <li><a href="#section-+SEEKLEFT">+SEEKLEFT</a></li> - <li><a href="#section-+SEEKRIGHT">+SEEKRIGHT</a></li> - <li><a href="#section-+TUNEUP">+TUNEUP</a></li> - <li><a href="#section-+TUNEDOWN">+TUNEDOWN</a></li> - <li><a href="#section-+PRESET_0">+PRESET_0</a></li> - <li><a href="#section-+PRESET_1">+PRESET_1</a></li> - <li><a href="#section-+PRESET_2">+PRESET_2</a></li> - <li><a href="#section-+PRESET_3">+PRESET_3</a></li> - <li><a href="#section-+PRESET_4">+PRESET_4</a></li> - <li><a href="#section-+PRESET_5">+PRESET_5</a></li> - <li><a href="#section-+PRESET_6">+PRESET_6</a></li> - <li><a href="#section-+PRESET_7">+PRESET_7</a></li> - <li><a href="#section-+PRESET_8">+PRESET_8</a></li> - <li><a href="#section-+PRESET_9">+PRESET_9</a></li> - <li><a href="#section-+CUSTOM_BUTTON">+CUSTOM_BUTTON</a></li> - <li><a href="#section-+SEARCH">+SEARCH</a></li> -</ul> - -<h3>Overview</h3> - -<p>Defines logical buttons which, on a given SDL unit, would correspond to - either physical or soft (touchscreen) buttons. These logical buttons present - a standard functional abstraction which the developer can rely upon, - independent of the SDL unit. For example, the developer can rely upon the OK - button having the same meaning to the user across SDL platforms.</p> - -<p>The preset buttons (0-9) can typically be interpreted by the application as - corresponding to some user-configured choices, though the application is free - to interpret these button presses as it sees fit.</p> - -<p>The application can discover which buttons a given SDL unit implements by - interrogating the ButtonCapabilities parameter of the - RegisterAppInterface response.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLButtonName</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</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">SDLButtonName</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>SDLButtonName</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLButtonName</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 SDLButtonName</p> - - </div> - - <h3 id="section-+OK"> - +OK - </h3> - - <p>@abstract Represents the button usually labeled <q>OK</q>. A typical use of this button is for the user to press it to make a selection.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">OK</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">ok</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>OK</em></p> - - </div> - - <h3 id="section-+SEEKLEFT"> - +SEEKLEFT - </h3> - - <p>@abstract Represents the seek-left button. A typical use of this button is for the user to scroll to the left through menu choices one menu item per press.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">SEEKLEFT</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">seekleft</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>SEEKLEFT</em></p> - - </div> - - <h3 id="section-+SEEKRIGHT"> - +SEEKRIGHT - </h3> - - <p>@abstract Represents the seek-right button. A typical use of this button is for the user to scroll to the right through menu choices one menu item per press.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">SEEKRIGHT</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">seekright</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>SEEKRIGHT</em></p> - - </div> - - <h3 id="section-+TUNEUP"> - +TUNEUP - </h3> - - <p>@abstract Represents a turn of the tuner knob in the clockwise direction one tick.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">TUNEUP</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">tuneup</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>TUNEUP</em></p> - - </div> - - <h3 id="section-+TUNEDOWN"> - +TUNEDOWN - </h3> - - <p>@abstract Represents a turn of the tuner knob in the counter-clockwise direction one tick.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">TUNEDOWN</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">tunedown</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>TUNEDOWN</em></p> - - </div> - - <h3 id="section-+PRESET_0"> - +PRESET_0 - </h3> - - <p>@abstract Represents the preset 0 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_0</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">preset_0</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_0</em></p> - - </div> - - <h3 id="section-+PRESET_1"> - +PRESET_1 - </h3> - - <p>@abstract Represents the preset 1 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_1</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">preset_1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_1</em></p> - - </div> - - <h3 id="section-+PRESET_2"> - +PRESET_2 - </h3> - - <p>@abstract Represents the preset 2 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_2</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">preset_2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_2</em></p> - - </div> - - <h3 id="section-+PRESET_3"> - +PRESET_3 - </h3> - - <p>@abstract Represents the preset 3 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_3</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">preset_3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_3</em></p> - - </div> - - <h3 id="section-+PRESET_4"> - +PRESET_4 - </h3> - - <p>@abstract Represents the preset 4 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_4</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">preset_4</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_4</em></p> - - </div> - - <h3 id="section-+PRESET_5"> - +PRESET_5 - </h3> - - <p>@abstract Represents the preset 5 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_5</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">preset_5</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_5</em></p> - - </div> - - <h3 id="section-+PRESET_6"> - +PRESET_6 - </h3> - - <p>@abstract Represents the preset 6 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_6</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">preset_6</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_6</em></p> - - </div> - - <h3 id="section-+PRESET_7"> - +PRESET_7 - </h3> - - <p>@abstract Represents the preset 7 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_7</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">preset_7</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_7</em></p> - - </div> - - <h3 id="section-+PRESET_8"> - +PRESET_8 - </h3> - - <p>@abstract Represents the preset 8 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_8</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">preset_8</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_8</em></p> - - </div> - - <h3 id="section-+PRESET_9"> - +PRESET_9 - </h3> - - <p>@abstract Represents the preset 9 button.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonName</span> <span class="o">*</span><span class="p">)</span><span class="n">PRESET_9</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">preset_9</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonName with the value of <em>PRESET_9</em></p> - - </div> - - <h3 id="section-+CUSTOM_BUTTON"> - +CUSTOM_BUTTON - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+SEARCH"> - +SEARCH - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLButtonPress.html b/docs/Classes/SDLButtonPress.html new file mode 100644 index 000000000..e4f5e0158 --- /dev/null +++ b/docs/Classes/SDLButtonPress.html @@ -0,0 +1,88 @@ +<h1>SDLButtonPress Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithButtonName:moduleType:">-initWithButtonName:moduleType:</a></li> + <li><a href="#section-moduleType">moduleType</a></li> + <li><a href="#section-buttonName">buttonName</a></li> + <li><a href="#section-buttonPressMode">buttonPressMode</a></li> +</ul> + +<h3>Overview</h3> + +<p>This RPC allows a remote control type mobile application to simulate a hardware button press event.</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithButtonName:moduleType:"> + -initWithButtonName:moduleType: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLButtonPress</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + + + + + + <h3 id="section-moduleType"> + moduleType + </h3> + + <p>The module where the button should be pressed.</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="../Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="n">_Nonnull</span> <span class="n">moduleType</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">moduleType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-buttonName"> + buttonName + </h3> + + <p>The name of supported RC climate or radio button.</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="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="n">_Nonnull</span> <span class="n">buttonName</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-buttonPressMode"> + buttonPressMode + </h3> + + <p>Indicates whether this is a LONG or SHORT button press event.</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="../Type Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode">SDLButtonPressMode</a></span> <span class="n">_Nonnull</span> <span class="n">buttonPressMode</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonPressMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode">SDLButtonPressMode</a></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/SDLButtonPressMode.html b/docs/Classes/SDLButtonPressMode.html deleted file mode 100644 index 0cf97073e..000000000 --- a/docs/Classes/SDLButtonPressMode.html +++ /dev/null @@ -1,118 +0,0 @@ -<h1>SDLButtonPressMode 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-+LONG">+LONG</a></li> - <li><a href="#section-+SHORT">+SHORT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Indicates whether this is a LONG or SHORT button press</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLButtonPressMode</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonPressMode</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">SDLButtonPressMode</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>SDLButtonPressMode</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLButtonPressMode</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 SDLButtonPressMode</p> - - </div> - - <h3 id="section-+LONG"> - +LONG - </h3> - - <p>@abstract A button was released, after it was pressed for a long time. Actual timing is defined by the head unit and may vary.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonPressMode</span> <span class="o">*</span><span class="p">)</span><span class="n">LONG</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">long</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonPressMode</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLButtonPressMode with the value of <em>LONG</em></p> - - </div> - - <h3 id="section-+SHORT"> - +SHORT - </h3> - - <p>@abstract A button was released, after it was pressed for a short time. Actual timing is defined by the head unit and may vary.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLButtonPressMode</span> <span class="o">*</span><span class="p">)</span><span class="n">SHORT</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">short</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLButtonPressMode</span><span class="o">!</span></code></pre> - - - - <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 deleted file mode 100644 index ef12611c4..000000000 --- a/docs/Classes/SDLCarModeStatus.html +++ /dev/null @@ -1,123 +0,0 @@ -<h1>SDLCarModeStatus 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-+NORMAL">+NORMAL</a></li> - <li><a href="#section-+FACTORY">+FACTORY</a></li> - <li><a href="#section-+TRANSPORT">+TRANSPORT</a></li> - <li><a href="#section-+CRASH">+CRASH</a></li> -</ul> - -<h3>Overview</h3> - -<p>Describes the carmode the vehicle is in. - * <b>Since</b> SmartDeviceLink 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+NORMAL"> - +NORMAL - </h3> - - <p>Provides carmode NORMAL to each module.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCarModeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NORMAL</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">normal</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCarModeStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+FACTORY"> - +FACTORY - </h3> - - <p>Provides carmode FACTORY to each module.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCarModeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">FACTORY</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">factory</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCarModeStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+TRANSPORT"> - +TRANSPORT - </h3> - - <p>Provides carmode TRANSPORT to each module.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCarModeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">TRANSPORT</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">transport</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCarModeStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+CRASH"> - +CRASH - </h3> - - <p>Provides carmode CRASH to each module.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCarModeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">CRASH</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">crash</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCarModeStatus</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLChangeRegistration.html b/docs/Classes/SDLChangeRegistration.html index 709f8d62f..8f454547b 100644 --- a/docs/Classes/SDLChangeRegistration.html +++ b/docs/Classes/SDLChangeRegistration.html @@ -3,8 +3,6 @@ <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--initWithLanguage:hmiDisplayLanguage:">-initWithLanguage:hmiDisplayLanguage:</a></li> <li><a href="#section--initWithLanguage:hmiDisplayLanguage:appName:ttsName:ngnMediaScreenAppName:vrSynonyms:">-initWithLanguage:hmiDisplayLanguage:appName:ttsName:ngnMediaScreenAppName:vrSynonyms:</a></li> <li><a href="#section-language">language</a></li> @@ -25,48 +23,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLChangeRegistration 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 SDLChangeRegistration 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--initWithLanguage:hmiDisplayLanguage:"> -initWithLanguage:hmiDisplayLanguage: </h3> @@ -76,7 +32,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 +47,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> @@ -106,11 +62,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">language</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">_Nonnull</span> <span class="n">language</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -124,11 +80,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">hmiDisplayLanguage</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">_Nonnull</span> <span class="n">hmiDisplayLanguage</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hmiDisplayLanguage</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">hmiDisplayLanguage</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -144,11 +100,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">appName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">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="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">appName</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> @@ -164,11 +120,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span> <span class="o">*</span><span class="n">ttsName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">Any</span><span class="p">]</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">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> @@ -184,11 +140,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">ngnMediaScreenAppName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">ngnMediaScreenAppName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">ngnMediaScreenAppName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ngnMediaScreenAppName</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> @@ -204,11 +160,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span> <span class="o">*</span><span class="n">vrSynonyms</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">vrSynonyms</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrSynonyms</span><span class="p">:</span> <span class="p">[</span><span class="kt">Any</span><span class="p">]</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">vrSynonyms</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> diff --git a/docs/Classes/SDLChangeRegistrationResponse.html b/docs/Classes/SDLChangeRegistrationResponse.html deleted file mode 100644 index 2c933ff64..000000000 --- a/docs/Classes/SDLChangeRegistrationResponse.html +++ /dev/null @@ -1,48 +0,0 @@ -<h1>SDLChangeRegistrationResponse 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>SDLChangeRegistrationResponse is sent, when SDLChangeRegistration has been called</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLCharacterSet.html b/docs/Classes/SDLCharacterSet.html deleted file mode 100644 index 5f8dccea7..000000000 --- a/docs/Classes/SDLCharacterSet.html +++ /dev/null @@ -1,134 +0,0 @@ -<h1>SDLCharacterSet 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-+TYPE2SET">+TYPE2SET</a></li> - <li><a href="#section-+TYPE5SET">+TYPE5SET</a></li> - <li><a href="#section-+CID1SET">+CID1SET</a></li> - <li><a href="#section-+CID2SET">+CID2SET</a></li> -</ul> - -<h3>Overview</h3> - -<p>Character sets supported by SDL.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLCharacterSet</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCharacterSet</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">SDLCharacterSet</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>SDLCharacterSet</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLCharacterSet</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 SDLCharacterSet</p> - - </div> - - <h3 id="section-+TYPE2SET"> - +TYPE2SET - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+TYPE5SET"> - +TYPE5SET - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+CID1SET"> - +CID1SET - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+CID2SET"> - +CID2SET - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLChoice.html b/docs/Classes/SDLChoice.html index 43d1f3981..2293a9c8a 100644 --- a/docs/Classes/SDLChoice.html +++ b/docs/Classes/SDLChoice.html @@ -3,8 +3,6 @@ <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:menuName:vrCommands:">-initWithId:menuName:vrCommands:</a></li> <li><a href="#section--initWithId:menuName:vrCommands:image:secondaryText:secondaryImage:tertiaryText:">-initWithId:menuName:vrCommands:image:secondaryText:secondaryImage:tertiaryText:</a></li> <li><a href="#section-choiceID">choiceID</a></li> @@ -47,7 +45,7 @@ </tr> <tr> <td>vrCommands</td> - <td>NSMutableArray *</td> + <td>NSArray *</td> <td>An array of strings to be used as VR synonyms for this choice. If this array is provided, it must have at least one non-empty element</td> <td>SmartDeviceLink 1.0</td> </tr> @@ -63,49 +61,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLChoice 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 newly allocated SDLChoice object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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:menuName:vrCommands:"> -initWithId:menuName:vrCommands: </h3> @@ -115,7 +70,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 +85,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> @@ -147,11 +102,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">choiceID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">choiceID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">choiceID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">choiceID</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -167,11 +122,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">menuName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">menuName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -187,11 +142,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">vrCommands</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">vrCommands</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrCommands</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrCommands</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> @@ -207,11 +163,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span></code></pre> + <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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">image</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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">image</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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> @@ -227,11 +183,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">secondaryText</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">secondaryText</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">secondaryText</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">secondaryText</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> @@ -247,11 +203,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">tertiaryText</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">tertiaryText</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tertiaryText</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tertiaryText</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> @@ -267,11 +223,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">secondaryImage</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">secondaryImage</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">secondaryImage</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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">secondaryImage</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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> diff --git a/docs/Classes/SDLClimateControlCapabilities.html b/docs/Classes/SDLClimateControlCapabilities.html new file mode 100644 index 000000000..d3fc527b6 --- /dev/null +++ b/docs/Classes/SDLClimateControlCapabilities.html @@ -0,0 +1,304 @@ +<h1>SDLClimateControlCapabilities Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable:dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable:">-initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable:dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable:</a></li> + <li><a href="#section-moduleName">moduleName</a></li> + <li><a href="#section-fanSpeedAvailable">fanSpeedAvailable</a></li> + <li><a href="#section-desiredTemperatureAvailable">desiredTemperatureAvailable</a></li> + <li><a href="#section-acEnableAvailable">acEnableAvailable</a></li> + <li><a href="#section-acMaxEnableAvailable">acMaxEnableAvailable</a></li> + <li><a href="#section-circulateAirEnableAvailable">circulateAirEnableAvailable</a></li> + <li><a href="#section-autoModeEnableAvailable">autoModeEnableAvailable</a></li> + <li><a href="#section-dualModeEnableAvailable">dualModeEnableAvailable</a></li> + <li><a href="#section-defrostZoneAvailable">defrostZoneAvailable</a></li> + <li><a href="#section-defrostZone">defrostZone</a></li> + <li><a href="#section-ventilationModeAvailable">ventilationModeAvailable</a></li> + <li><a href="#section-ventilationMode">ventilationMode</a></li> +</ul> + +<h3>Overview</h3> + +<p>Contains information about a climate control module’s capabilities.</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable:dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable:"> + -initWithModuleName:fanSpeedAvailable:desiredTemperatureAvailable:acEnableAvailable:acMaxEnableAvailable:circulateAirAvailable:autoModeEnableAvailable:dualModeEnableAvailable:defrostZoneAvailable:ventilationModeAvailable: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLClimateControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section-moduleName"> + moduleName + </h3> + + <p>@abstract The short friendly name of the climate control module. + It should not be used to identify a module by mobile application.</p> + +<p>Max string length 100 chars</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleName</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">moduleName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-fanSpeedAvailable"> + fanSpeedAvailable + </h3> + + <p>@abstract Availability of the control of fan speed. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">fanSpeedAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fanSpeedAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-desiredTemperatureAvailable"> + desiredTemperatureAvailable + </h3> + + <p>@abstract Availability of the control of desired temperature. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">desiredTemperatureAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">desiredTemperatureAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-acEnableAvailable"> + acEnableAvailable + </h3> + + <p>@abstract Availability of the control of turn on/off AC. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">acEnableAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">acEnableAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-acMaxEnableAvailable"> + acMaxEnableAvailable + </h3> + + <p>@abstract Availability of the control of enable/disable air conditioning is ON on the maximum level. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</p> + + + + <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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">acMaxEnableAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">acMaxEnableAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-circulateAirEnableAvailable"> + circulateAirEnableAvailable + </h3> + + <p>@abstract Availability of the control of enable/disable circulate Air mode. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">circulateAirEnableAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">circulateAirEnableAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-autoModeEnableAvailable"> + autoModeEnableAvailable + </h3> + + <p>@abstract Availability of the control of enable/disable auto mode. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">autoModeEnableAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">autoModeEnableAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-dualModeEnableAvailable"> + dualModeEnableAvailable + </h3> + + <p>@abstract Availability of the control of enable/disable dual mode. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">dualModeEnableAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">dualModeEnableAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-defrostZoneAvailable"> + defrostZoneAvailable + </h3> + + <p>@abstract Availability of the control of defrost zones. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">defrostZoneAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">defrostZoneAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-defrostZone"> + defrostZone + </h3> + + <p>@abstract A set of all defrost zones that are controllable.</p> + +<p>Optional, NSArray of type SDLDefrostZone minsize=<q>1</q> maxsize=<q>100</q></p> + + + + <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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone">SDLDefrostZone</a></span><span class="o">></span> <span class="o">*</span><span class="n">defrostZone</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">defrostZone</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone">SDLDefrostZone</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-ventilationModeAvailable"> + ventilationModeAvailable + </h3> + + <p>@abstract Availability of the control of air ventilation mode. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">ventilationModeAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ventilationModeAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-ventilationMode"> + ventilationMode + </h3> + + <p>@abstract A set of all ventilation modes that are controllable. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, NSArray of type SDLVentilationMode minsize=<q>1</q> maxsize=<q>100</q></p> + + + + <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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode">SDLVentilationMode</a></span><span class="o">></span> <span class="o">*</span><span class="n">ventilationMode</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ventilationMode</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode">SDLVentilationMode</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> + + + + +</section> diff --git a/docs/Classes/SDLClimateControlData.html b/docs/Classes/SDLClimateControlData.html new file mode 100644 index 000000000..855d94857 --- /dev/null +++ b/docs/Classes/SDLClimateControlData.html @@ -0,0 +1,248 @@ +<h1>SDLClimateControlData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone:dualModeEnable:acMaxEnable:ventilationMode:">-initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone:dualModeEnable:acMaxEnable:ventilationMode:</a></li> + <li><a href="#section-fanSpeed">fanSpeed</a></li> + <li><a href="#section-currentTemperature">currentTemperature</a></li> + <li><a href="#section-desiredTemperature">desiredTemperature</a></li> + <li><a href="#section-acEnable">acEnable</a></li> + <li><a href="#section-circulateAirEnable">circulateAirEnable</a></li> + <li><a href="#section-autoModeEnable">autoModeEnable</a></li> + <li><a href="#section-defrostZone">defrostZone</a></li> + <li><a href="#section-dualModeEnable">dualModeEnable</a></li> + <li><a href="#section-acMaxEnable">acMaxEnable</a></li> + <li><a href="#section-ventilationMode">ventilationMode</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone:dualModeEnable:acMaxEnable:ventilationMode:"> + -initWithFanSpeed:desiredTemperature:acEnable:circulateAirEnable:autoModeEnable:defrostZone:dualModeEnable:acMaxEnable:ventilationMode: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-fanSpeed"> + fanSpeed + </h3> + + <p>@abstract Speed of Fan in integer</p> + +<p>Optional, MinValue- 0 MaxValue= 100</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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">fanSpeed</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fanSpeed</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-currentTemperature"> + currentTemperature + </h3> + + <p>@abstract The Current Temperature in SDLTemperature</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + This property is readonly and cannot be set on the module. + +</div> + +<p>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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLTemperature.html">SDLTemperature</a></span> <span class="o">*</span><span class="n">currentTemperature</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">currentTemperature</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTemperature.html">SDLTemperature</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-desiredTemperature"> + desiredTemperature + </h3> + + <p>@abstract Desired Temperature in SDLTemperature</p> + +<p>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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLTemperature.html">SDLTemperature</a></span> <span class="o">*</span><span class="n">desiredTemperature</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">desiredTemperature</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTemperature.html">SDLTemperature</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-acEnable"> + acEnable + </h3> + + <p>@abstract Represents if AC is enabled.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">acEnable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">acEnable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-circulateAirEnable"> + circulateAirEnable + </h3> + + <p>@abstract Represents if circulation of air is enabled.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">circulateAirEnable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">circulateAirEnable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-autoModeEnable"> + autoModeEnable + </h3> + + <p>@abstract Represents if auto mode is enabled.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">autoModeEnable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">autoModeEnable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-defrostZone"> + defrostZone + </h3> + + <p>@abstract Represents the kind of defrost zone</p> + +<p>Optional, SDLDefrostZone</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone">SDLDefrostZone</a></span> <span class="n">defrostZone</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">defrostZone</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone">SDLDefrostZone</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-dualModeEnable"> + dualModeEnable + </h3> + + <p>@abstract Represents if dual mode is enabled.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">dualModeEnable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">dualModeEnable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-acMaxEnable"> + acMaxEnable + </h3> + + <p>@abstract Represents if ac max is enabled.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">acMaxEnable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">acMaxEnable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-ventilationMode"> + ventilationMode + </h3> + + <p>@abstract Represents the kind of Ventilation zone</p> + +<p>Optional, SDLVentilationMode</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode">SDLVentilationMode</a></span> <span class="n">ventilationMode</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ventilationMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode">SDLVentilationMode</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> + + + + +</section> diff --git a/docs/Classes/SDLClusterModeStatus.html b/docs/Classes/SDLClusterModeStatus.html index 74f1b45e0..1ed1b0e28 100644 --- a/docs/Classes/SDLClusterModeStatus.html +++ b/docs/Classes/SDLClusterModeStatus.html @@ -3,8 +3,6 @@ <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-powerModeActive">powerModeActive</a></li> <li><a href="#section-powerModeQualificationStatus">powerModeQualificationStatus</a></li> <li><a href="#section-carModeStatus">carModeStatus</a></li> @@ -17,28 +15,6 @@ <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-powerModeActive"> powerModeActive </h3> diff --git a/docs/Classes/SDLCompassDirection.html b/docs/Classes/SDLCompassDirection.html deleted file mode 100644 index 2955a1adc..000000000 --- a/docs/Classes/SDLCompassDirection.html +++ /dev/null @@ -1,273 +0,0 @@ -<h1>SDLCompassDirection 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-+NORTH">+NORTH</a></li> - <li><a href="#section-+NORTHWEST">+NORTHWEST</a></li> - <li><a href="#section-+WEST">+WEST</a></li> - <li><a href="#section-+SOUTHWEST">+SOUTHWEST</a></li> - <li><a href="#section-+SOUTH">+SOUTH</a></li> - <li><a href="#section-+SOUTHEAST">+SOUTHEAST</a></li> - <li><a href="#section-+EAST">+EAST</a></li> - <li><a href="#section-+NORTHEAST">+NORTHEAST</a></li> -</ul> - -<h3>Overview</h3> - -<p>The list of potential compass directions.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLCompassDirection -- parameter: value The value of the string to get an object for -- returns: SDLCompassDirection</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCompassDirection</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">SDLCompassDirection</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>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> - - - - <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 SDLCompassDirection</p> - - </div> - - <h3 id="section-+NORTH"> - +NORTH - </h3> - - <p>@abstract Direction North -- returns: A SDLCompassDirection with the value of <em>NORTH</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCompassDirection</span> <span class="o">*</span><span class="p">)</span><span class="n">NORTH</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">north</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCompassDirection</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCompassDirection</span> <span class="o">*</span><span class="p">)</span><span class="n">NORTHWEST</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">northwest</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCompassDirection</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCompassDirection</span> <span class="o">*</span><span class="p">)</span><span class="n">WEST</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">west</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCompassDirection</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCompassDirection</span> <span class="o">*</span><span class="p">)</span><span class="n">SOUTHWEST</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">southwest</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCompassDirection</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCompassDirection</span> <span class="o">*</span><span class="p">)</span><span class="n">SOUTH</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">south</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCompassDirection</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCompassDirection</span> <span class="o">*</span><span class="p">)</span><span class="n">SOUTHEAST</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">southeast</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCompassDirection</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCompassDirection</span> <span class="o">*</span><span class="p">)</span><span class="n">EAST</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">east</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCompassDirection</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLCompassDirection</span> <span class="o">*</span><span class="p">)</span><span class="n">NORTHEAST</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">northeast</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLCompassDirection</span><span class="o">!</span></code></pre> - - - - <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 deleted file mode 100644 index 4a2f86fc5..000000000 --- a/docs/Classes/SDLComponentVolumeStatus.html +++ /dev/null @@ -1,223 +0,0 @@ -<h1>SDLComponentVolumeStatus 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-+UNKNOWN">+UNKNOWN</a></li> - <li><a href="#section-+NORMAL">+NORMAL</a></li> - <li><a href="#section-+LOW">+LOW</a></li> - <li><a href="#section-+FAULT">+FAULT</a></li> - <li><a href="#section-+ALERT">+ALERT</a></li> - <li><a href="#section-+NOT_SUPPORTED">+NOT_SUPPORTED</a></li> -</ul> - -<h3>Overview</h3> - -<p>The volume status of a vehicle component.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLComponentVolumeStatus -- parameter: value The value of the string to get an object for -- returns: SDLComponentVolumeStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLComponentVolumeStatus</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">SDLComponentVolumeStatus</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>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> - - - - <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 SDLComponentVolumeStatus</p> - - </div> - - <h3 id="section-+UNKNOWN"> - +UNKNOWN - </h3> - - <p>@abstract Unknown SDLComponentVolumeStatus -- returns: a SDLComponentVolumeStatus with the value of <em>UNKNOWN</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLComponentVolumeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">UNKNOWN</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">unknown</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLComponentVolumeStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLComponentVolumeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NORMAL</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">normal</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLComponentVolumeStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLComponentVolumeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">LOW</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">low</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLComponentVolumeStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLComponentVolumeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">FAULT</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">fault</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLComponentVolumeStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLComponentVolumeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ALERT</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">alert</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLComponentVolumeStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLComponentVolumeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NOT_SUPPORTED</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">not_SUPPORTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLComponentVolumeStatus</span><span class="o">!</span></code></pre> - - - - <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..bf5a6a254 100644 --- a/docs/Classes/SDLConfiguration.html +++ b/docs/Classes/SDLConfiguration.html @@ -5,8 +5,12 @@ <ul> <li><a href="#section-lifecycleConfig">lifecycleConfig</a></li> <li><a href="#section-lockScreenConfig">lockScreenConfig</a></li> - <li><a href="#section--initWithLifecycle:lockScreen:">-initWithLifecycle:lockScreen:</a></li> - <li><a href="#section-+configurationWithLifecycle:lockScreen:">+configurationWithLifecycle:lockScreen:</a></li> + <li><a href="#section-loggingConfig">loggingConfig</a></li> + <li><a href="#section-streamingMediaConfig">streamingMediaConfig</a></li> + <li><a href="#section--initWithLifecycle:lockScreen:logging:">-initWithLifecycle:lockScreen:logging:</a></li> + <li><a href="#section-+configurationWithLifecycle:lockScreen:logging:">+configurationWithLifecycle:lockScreen:logging:</a></li> + <li><a href="#section--initWithLifecycle:lockScreen:logging:streamingMedia:">-initWithLifecycle:lockScreen:logging:streamingMedia:</a></li> + <li><a href="#section-+configurationWithLifecycle:lockScreen:logging:streamingMedia:">+configurationWithLifecycle:lockScreen:logging:streamingMedia:</a></li> </ul> <h3>Overview</h3> @@ -53,45 +57,83 @@ - <h3 id="section--initWithLifecycle:lockScreen:"> - -initWithLifecycle:lockScreen: + <h3 id="section-loggingConfig"> + loggingConfig </h3> - <p>Create a new configuration to be passed into SDLManager.</p> + <p>The log configuration.</p> + + + + <h4>Objective-C</h4> + <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"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">loggingConfig</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">loggingConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-streamingMediaConfig"> + streamingMediaConfig + </h3> + + <p>The configuration</p> + + + + <h4>Objective-C</h4> + <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"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">streamingMediaConfig</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">streamingMediaConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--initWithLifecycle:lockScreen:logging:"> + -initWithLifecycle:lockScreen:logging: + </h3> + + <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</p> <h4>Objective-C</h4> <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> <span class="nf">initWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span> - <span class="nf">lockScreen</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span><span class="p">;</span></code></pre> + <span class="nf">lockScreen</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span> + <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="n">lifecycle</span> <span class="nv">lifecycleConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span><span class="p">,</span> <span class="n">lockScreen</span> <span class="nv">lockScreenConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="n">lifecycle</span> <span class="nv">lifecycleConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span><span class="p">,</span> <span class="n">lockScreen</span> <span class="nv">lockScreenConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span><span class="p">?,</span> <span class="n">logging</span> <span class="nv">logConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span><span class="p">?)</span></code></pre> <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, or <code>enabledConfiguration</code> if nil.</p></dd> + <dt>logConfig</dt> + <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd> </dl> <div> <h4>Return Value</h4> <p>The configuration</p> - </div> - <h3 id="section-+configurationWithLifecycle:lockScreen:"> - +configurationWithLifecycle:lockScreen: + <h3 id="section-+configurationWithLifecycle:lockScreen:logging:"> + +configurationWithLifecycle:lockScreen:logging: </h3> - <p>Create a new configuration to be passed into SDLManager.</p> + <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration.</p> @@ -99,7 +141,8 @@ <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> <span class="nf">configurationWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span> <span class="nf">lockScreen</span><span class="p">:</span> - <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span><span class="p">;</span></code></pre> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span> + <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span><span class="p">;</span></code></pre> @@ -107,16 +150,89 @@ <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, or <code>enabledConfiguration</code> if nil.</p></dd> + <dt>logConfig</dt> + <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd> </dl> <div> <h4>Return Value</h4> <p>The configuration</p> + </div> + + <h3 id="section--initWithLifecycle:lockScreen:logging:streamingMedia:"> + -initWithLifecycle:lockScreen:logging:streamingMedia: + </h3> + + <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</p> + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> +<span class="nf">initWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span> + <span class="nf">lockScreen</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span> + <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span> + <span class="nf">streamingMedia</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">streamingMediaConfig</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="n">lifecycle</span> <span class="nv">lifecycleConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span><span class="p">,</span> <span class="n">lockScreen</span> <span class="nv">lockScreenConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span><span class="p">?,</span> <span class="n">logging</span> <span class="nv">logConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span><span class="p">?,</span> <span class="n">streamingMedia</span> <span class="nv">streamingMediaConfig</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span><span class="p">?)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>lifecycleConfig</dt> + <dd><p>The lifecycle configuration to be used.</p></dd> + <dt>lockScreenConfig</dt> + <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd> + <dt>logConfig</dt> + <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd> + <dt>streamingMediaConfig</dt> + <dd><p>The streaming media configuration to be used, or nil because it is not needed.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + + <h3 id="section-+configurationWithLifecycle:lockScreen:logging:streamingMedia:"> + +configurationWithLifecycle:lockScreen:logging:streamingMedia: + </h3> + + <p>Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> +<span class="nf">configurationWithLifecycle</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lifecycleConfig</span> + <span class="nf">lockScreen</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenConfig</span> + <span class="nf">logging</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">logConfig</span> + <span class="nf">streamingMedia</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">streamingMediaConfig</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>lifecycleConfig</dt> + <dd><p>The lifecycle configuration to be used.</p></dd> + <dt>lockScreenConfig</dt> + <dd><p>The lockscreen configuration to be used, or <code>enabledConfiguration</code> if nil.</p></dd> + <dt>logConfig</dt> + <dd><p>The logging configuration to be used, or <code>defaultConfiguration</code> if nil.</p></dd> + <dt>streamingMediaConfig</dt> + <dd><p>The streaming media configuration to be used, or nil because it is not needed.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The configuration</p> </div> </section> diff --git a/docs/Classes/SDLConsoleController.html b/docs/Classes/SDLConsoleController.html deleted file mode 100644 index 1ac5bb8be..000000000 --- a/docs/Classes/SDLConsoleController.html +++ /dev/null @@ -1,74 +0,0 @@ -<h1>SDLConsoleController Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-messageList">messageList</a></li> - <li><a href="#section-atBottom">atBottom</a></li> - <li><a href="#section-dateFormatter">dateFormatter</a></li> - <li><a href="#section-messageList">messageList</a></li> - <li><a href="#section--initWithTableView:">-initWithTableView:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-messageList"> - messageList - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-atBottom"> - atBottom - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-dateFormatter"> - dateFormatter - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-messageList"> - messageList - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--initWithTableView:"> - -initWithTableView: - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLCreateInteractionChoiceSet.html b/docs/Classes/SDLCreateInteractionChoiceSet.html index 89d9f4557..1e2552799 100644 --- a/docs/Classes/SDLCreateInteractionChoiceSet.html +++ b/docs/Classes/SDLCreateInteractionChoiceSet.html @@ -3,8 +3,6 @@ <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:choiceSet:">-initWithId:choiceSet:</a></li> <li><a href="#section-interactionChoiceSetID">interactionChoiceSetID</a></li> <li><a href="#section-choiceSet">choiceSet</a></li> @@ -21,7 +19,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 @@ -30,48 +27,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLCreateInteractionChoiceSet 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 SDLCreateInteractionChoiceSet 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:choiceSet:"> -initWithId:choiceSet: </h3> @@ -81,7 +36,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> @@ -98,11 +53,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">interactionChoiceSetID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">interactionChoiceSetID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">interactionChoiceSetID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">interactionChoiceSetID</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -118,11 +74,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">choiceSet</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLChoice.html">SDLChoice</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">choiceSet</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">choiceSet</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">choiceSet</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLChoice.html">SDLChoice</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> diff --git a/docs/Classes/SDLCreateInteractionChoiceSetResponse.html b/docs/Classes/SDLCreateInteractionChoiceSetResponse.html deleted file mode 100644 index f4745e136..000000000 --- a/docs/Classes/SDLCreateInteractionChoiceSetResponse.html +++ /dev/null @@ -1,49 +0,0 @@ -<h1>SDLCreateInteractionChoiceSetResponse 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>SDLCreateInteractionChoiceSetResponse is sent, when SDLCreateInteractionChoiceSet - has been called</p> - -<p>Since <b>SmartDeviceLink 1.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLDIDResult.html b/docs/Classes/SDLDIDResult.html index 91708e081..0b2a67e4a 100644 --- a/docs/Classes/SDLDIDResult.html +++ b/docs/Classes/SDLDIDResult.html @@ -3,8 +3,6 @@ <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-resultCode">resultCode</a></li> <li><a href="#section-didLocation">didLocation</a></li> <li><a href="#section-data">data</a></li> @@ -16,28 +14,6 @@ <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-resultCode"> resultCode </h3> diff --git a/docs/Classes/SDLDateTime.html b/docs/Classes/SDLDateTime.html index 0311062ca..2c06a1405 100644 --- a/docs/Classes/SDLDateTime.html +++ b/docs/Classes/SDLDateTime.html @@ -79,11 +79,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">millisecond</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">millisecond</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">millisecond</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">millisecond</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -99,11 +99,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">second</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">second</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">second</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">second</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -119,11 +119,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">minute</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">minute</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">minute</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">minute</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -139,11 +139,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">hour</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">hour</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">hour</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">hour</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -159,11 +159,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">day</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">day</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">day</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">day</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -179,11 +179,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">month</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">month</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">month</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">month</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -199,11 +199,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">year</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">year</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">year</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">year</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -219,11 +219,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timezoneMinuteOffset</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">timezoneMinuteOffset</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">timezoneMinuteOffset</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">timezoneMinuteOffset</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -239,11 +240,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timezoneHourOffset</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">timezoneHourOffset</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">timezoneHourOffset</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">timezoneHourOffset</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLDebugTool.html b/docs/Classes/SDLDebugTool.html deleted file mode 100644 index 3bbcb8fca..000000000 --- a/docs/Classes/SDLDebugTool.html +++ /dev/null @@ -1,206 +0,0 @@ -<h1>SDLDebugTool Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+enable">+enable</a></li> - <li><a href="#section-+disable">+disable</a></li> - <li><a href="#section-+addConsole:">+addConsole:</a></li> - <li><a href="#section-+addConsole:toGroup:">+addConsole:toGroup:</a></li> - <li><a href="#section-+removeConsole:">+removeConsole:</a></li> - <li><a href="#section-+removeConsole:fromGroup:">+removeConsole:fromGroup:</a></li> - <li><a href="#section-+logInfo:">+logInfo:</a></li> - <li><a href="#section-+logFormat:">+logFormat:</a></li> - <li><a href="#section-+logInfo:withType:">+logInfo:withType:</a></li> - <li><a href="#section-+logInfo:withType:toOutput:">+logInfo:withType:toOutput:</a></li> - <li><a href="#section-+logInfo:andBinaryData:withType:toOutput:">+logInfo:andBinaryData:withType:toOutput:</a></li> - <li><a href="#section-+logInfo:withType:toOutput:toGroup:">+logInfo:withType:toOutput:toGroup:</a></li> - <li><a href="#section-+enableDebugToLogFile">+enableDebugToLogFile</a></li> - <li><a href="#section-+disableDebugToLogFile">+disableDebugToLogFile</a></li> - <li><a href="#section-+writeToLogFile:">+writeToLogFile:</a></li> - <li><a href="#section-+stringForDebugType:">+stringForDebugType:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+enable"> - +enable - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+disable"> - +disable - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+addConsole:"> - +addConsole: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+addConsole:toGroup:"> - +addConsole:toGroup: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+removeConsole:"> - +removeConsole: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+removeConsole:fromGroup:"> - +removeConsole:fromGroup: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+logInfo:"> - +logInfo: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+logFormat:"> - +logFormat: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+logInfo:withType:"> - +logInfo:withType: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+logInfo:withType:toOutput:"> - +logInfo:withType:toOutput: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+logInfo:andBinaryData:withType:toOutput:"> - +logInfo:andBinaryData:withType:toOutput: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+logInfo:withType:toOutput:toGroup:"> - +logInfo:withType:toOutput:toGroup: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+enableDebugToLogFile"> - +enableDebugToLogFile - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+disableDebugToLogFile"> - +disableDebugToLogFile - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+writeToLogFile:"> - +writeToLogFile: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+stringForDebugType:"> - +stringForDebugType: - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLDeleteCommand.html b/docs/Classes/SDLDeleteCommand.html index f0d834aae..62197d9b9 100644 --- a/docs/Classes/SDLDeleteCommand.html +++ b/docs/Classes/SDLDeleteCommand.html @@ -3,8 +3,6 @@ <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:">-initWithId:</a></li> <li><a href="#section-cmdID">cmdID</a></li> </ul> @@ -24,50 +22,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLDeleteCommand 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 SDLDeleteCommand object indicated by the NSMutableDictionary - parameter - <p></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:"> -initWithId: </h3> @@ -77,7 +31,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> @@ -95,11 +49,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">cmdID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">cmdID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">cmdID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">cmdID</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLDeleteCommandResponse.html b/docs/Classes/SDLDeleteCommandResponse.html deleted file mode 100644 index f0728e1fe..000000000 --- a/docs/Classes/SDLDeleteCommandResponse.html +++ /dev/null @@ -1,48 +0,0 @@ -<h1>SDLDeleteCommandResponse 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>SDLDeleteCommandResponse is sent, when SDLDeleteCommand has been called</p> - -<p>Since <b>SmartDeviceLink 1.0</b><br></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLDeleteFile.html b/docs/Classes/SDLDeleteFile.html index 468b526ff..1c5149a6c 100644 --- a/docs/Classes/SDLDeleteFile.html +++ b/docs/Classes/SDLDeleteFile.html @@ -3,8 +3,6 @@ <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--initWithFileName:">-initWithFileName:</a></li> <li><a href="#section-syncFileName">syncFileName</a></li> </ul> @@ -20,49 +18,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLDeleteFile 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 SDLDeleteFile object indicated by the dictionary parameter - <p></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--initWithFileName:"> -initWithFileName: </h3> @@ -72,7 +27,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> @@ -88,11 +43,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">syncFileName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">syncFileName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">syncFileName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">syncFileName</span><span class="p">:</span> <span class="kt">String</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/SDLDeleteFileResponse.html b/docs/Classes/SDLDeleteFileResponse.html index 3893bbd72..bd23313b8 100644 --- a/docs/Classes/SDLDeleteFileResponse.html +++ b/docs/Classes/SDLDeleteFileResponse.html @@ -3,8 +3,6 @@ <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-spaceAvailable">spaceAvailable</a></li> </ul> @@ -16,36 +14,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - <h3 id="section-spaceAvailable"> spaceAvailable </h3> @@ -55,7 +23,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..8d32fa2fc 100644 --- a/docs/Classes/SDLDeleteInteractionChoiceSet.html +++ b/docs/Classes/SDLDeleteInteractionChoiceSet.html @@ -3,8 +3,6 @@ <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:">-initWithId:</a></li> <li><a href="#section-interactionChoiceSetID">interactionChoiceSetID</a></li> </ul> @@ -26,50 +24,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLDeleteInteractionChoiceSet 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 SDLDeleteInteractionChoiceSet object indicated by the - NSMutableDictionary parameter - <p></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:"> -initWithId: </h3> @@ -79,7 +33,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> @@ -97,11 +51,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">interactionChoiceSetID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">interactionChoiceSetID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">interactionChoiceSetID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">interactionChoiceSetID</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLDeleteInteractionChoiceSetResponse.html b/docs/Classes/SDLDeleteInteractionChoiceSetResponse.html deleted file mode 100644 index f66ff8b73..000000000 --- a/docs/Classes/SDLDeleteInteractionChoiceSetResponse.html +++ /dev/null @@ -1,48 +0,0 @@ -<h1>SDLDeleteInteractionChoiceSetResponse 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>SDLDeleteInteractionChoiceSetResponse is sent, when SDLDeleteInteractionChoiceSet has been called</p> - -<p>Since <b>SmartDeviceLink 1.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLDeleteSubMenu.html b/docs/Classes/SDLDeleteSubMenu.html index f5678029c..031445fd6 100644 --- a/docs/Classes/SDLDeleteSubMenu.html +++ b/docs/Classes/SDLDeleteSubMenu.html @@ -3,8 +3,6 @@ <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:">-initWithId:</a></li> <li><a href="#section-menuID">menuID</a></li> </ul> @@ -24,49 +22,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLDeleteSubMenu 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 SDLDeleteSubMenu object indicated by the dictionary parameter<p> -- parameter: dict The dictionary to use</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:"> -initWithId: </h3> @@ -76,7 +31,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> @@ -92,11 +47,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">menuID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">menuID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuID</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLDeleteSubMenuResponse.html b/docs/Classes/SDLDeleteSubMenuResponse.html deleted file mode 100644 index c26d8815d..000000000 --- a/docs/Classes/SDLDeleteSubMenuResponse.html +++ /dev/null @@ -1,48 +0,0 @@ -<h1>SDLDeleteSubMenuResponse 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>SDLDeleteSubMenuResponse is sent, when SDLDeleteSubMenu has been called</p> - -<p>Since <b>SmartDeviceLink 1.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLDeliveryMode.html b/docs/Classes/SDLDeliveryMode.html deleted file mode 100644 index 48d5dfd8d..000000000 --- a/docs/Classes/SDLDeliveryMode.html +++ /dev/null @@ -1,140 +0,0 @@ -<h1>SDLDeliveryMode 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-+PROMPT">+PROMPT</a></li> - <li><a href="#section-+DESTINATION">+DESTINATION</a></li> - <li><a href="#section-+QUEUE">+QUEUE</a></li> -</ul> - -<h3>Overview</h3> - -<p>Specifies the mode in which the sendLocation request is sent.</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLDeliveryMode</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeliveryMode</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">SDLDeliveryMode</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>SDLDeliveryMode</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLDeliveryMode</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 SDLDeliveryMode</p> - - </div> - - <h3 id="section-+PROMPT"> - +PROMPT - </h3> - - <p>@abstract User is prompted on HMI</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeliveryMode</span> <span class="o">*</span><span class="p">)</span><span class="n">PROMPT</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">prompt</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDeliveryMode</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLDeliveryMode with value of <em>PROMPT</em></p> - - </div> - - <h3 id="section-+DESTINATION"> - +DESTINATION - </h3> - - <p>@abstract Set the location as destination without prompting the user</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeliveryMode</span> <span class="o">*</span><span class="p">)</span><span class="n">DESTINATION</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">destination</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDeliveryMode</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLDeliveryMode with value of <em>DESTINATION</em></p> - - </div> - - <h3 id="section-+QUEUE"> - +QUEUE - </h3> - - <p>@abstract Adds the current location to navigation queue</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeliveryMode</span> <span class="o">*</span><span class="p">)</span><span class="n">QUEUE</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">queue</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDeliveryMode</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLDeliveryMode with value of <em>QUEUE</em></p> - - </div> - -</section> diff --git a/docs/Classes/SDLDeviceInfo.html b/docs/Classes/SDLDeviceInfo.html index 97a9ca6fd..f0d5bc03d 100644 --- a/docs/Classes/SDLDeviceInfo.html +++ b/docs/Classes/SDLDeviceInfo.html @@ -3,8 +3,6 @@ <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-+currentDevice">+currentDevice</a></li> <li><a href="#section-hardware">hardware</a></li> <li><a href="#section-firmwareRev">firmwareRev</a></li> @@ -20,28 +18,6 @@ <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-+currentDevice"> +currentDevice </h3> diff --git a/docs/Classes/SDLDeviceLevelStatus.html b/docs/Classes/SDLDeviceLevelStatus.html deleted file mode 100644 index 122268a1b..000000000 --- a/docs/Classes/SDLDeviceLevelStatus.html +++ /dev/null @@ -1,223 +0,0 @@ -<h1>SDLDeviceLevelStatus 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-+ZERO_LEVEL_BARS">+ZERO_LEVEL_BARS</a></li> - <li><a href="#section-+ONE_LEVEL_BARS">+ONE_LEVEL_BARS</a></li> - <li><a href="#section-+TWO_LEVEL_BARS">+TWO_LEVEL_BARS</a></li> - <li><a href="#section-+THREE_LEVEL_BARS">+THREE_LEVEL_BARS</a></li> - <li><a href="#section-+FOUR_LEVEL_BARS">+FOUR_LEVEL_BARS</a></li> - <li><a href="#section-+NOT_PROVIDED">+NOT_PROVIDED</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the reported battery status of the connected device, if reported.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to DeviceLevelStatus -- parameter: value String -- returns: DeviceLevelStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeviceLevelStatus</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">SDLDeviceLevelStatus</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>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> - - - - <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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeviceLevelStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ZERO_LEVEL_BARS</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">zero_LEVEL_BARS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDeviceLevelStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeviceLevelStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ONE_LEVEL_BARS</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">one_LEVEL_BARS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDeviceLevelStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeviceLevelStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">TWO_LEVEL_BARS</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">two_LEVEL_BARS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDeviceLevelStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeviceLevelStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">THREE_LEVEL_BARS</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">three_LEVEL_BARS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDeviceLevelStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeviceLevelStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">FOUR_LEVEL_BARS</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">four_LEVEL_BARS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDeviceLevelStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDeviceLevelStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NOT_PROVIDED</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">not_PROVIDED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDeviceLevelStatus</span><span class="o">!</span></code></pre> - - - - <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..cbf569c27 100644 --- a/docs/Classes/SDLDeviceStatus.html +++ b/docs/Classes/SDLDeviceStatus.html @@ -3,8 +3,6 @@ <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-voiceRecOn">voiceRecOn</a></li> <li><a href="#section-btIconOn">btIconOn</a></li> <li><a href="#section-callActive">callActive</a></li> @@ -112,48 +110,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLDeviceStatus 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 newly allocated SDLDeviceStatus 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-voiceRecOn"> voiceRecOn </h3> @@ -165,11 +121,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">voiceRecOn</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">voiceRecOn</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">voiceRecOn</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">voiceRecOn</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -185,11 +141,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">btIconOn</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">btIconOn</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">btIconOn</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">btIconOn</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -205,11 +161,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">callActive</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">callActive</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">callActive</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">callActive</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -225,11 +181,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">phoneRoaming</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">phoneRoaming</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">phoneRoaming</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">phoneRoaming</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -245,11 +202,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">textMsgAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">textMsgAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">textMsgAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">textMsgAvailable</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -259,7 +217,6 @@ </h3> <p>@abstract Battery level status</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeviceLevelStatus @@ -271,11 +228,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDeviceLevelStatus.html">SDLDeviceLevelStatus</a></span> <span class="o">*</span><span class="n">battLevelStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLDeviceLevelStatus.h@T@SDLDeviceLevelStatus">SDLDeviceLevelStatus</a></span> <span class="n">_Nonnull</span> <span class="n">battLevelStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">battLevelStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeviceLevelStatus.html">SDLDeviceLevelStatus</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">battLevelStatus</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDeviceLevelStatus.h@T@SDLDeviceLevelStatus">SDLDeviceLevelStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -291,11 +249,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">stereoAudioOutputMuted</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">stereoAudioOutputMuted</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">stereoAudioOutputMuted</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">stereoAudioOutputMuted</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -311,11 +270,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">monoAudioOutputMuted</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">monoAudioOutputMuted</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">monoAudioOutputMuted</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">monoAudioOutputMuted</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -325,7 +285,6 @@ </h3> <p>@abstract Signal level status</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLDeviceLevelStatus @@ -337,11 +296,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDeviceLevelStatus.html">SDLDeviceLevelStatus</a></span> <span class="o">*</span><span class="n">signalLevelStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLDeviceLevelStatus.h@T@SDLDeviceLevelStatus">SDLDeviceLevelStatus</a></span> <span class="n">_Nonnull</span> <span class="n">signalLevelStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">signalLevelStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeviceLevelStatus.html">SDLDeviceLevelStatus</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">signalLevelStatus</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDeviceLevelStatus.h@T@SDLDeviceLevelStatus">SDLDeviceLevelStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -351,7 +311,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 @@ -363,11 +322,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLPrimaryAudioSource.html">SDLPrimaryAudioSource</a></span> <span class="o">*</span><span class="n">primaryAudioSource</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource">SDLPrimaryAudioSource</a></span> <span class="n">_Nonnull</span> <span class="n">primaryAudioSource</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">primaryAudioSource</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPrimaryAudioSource.html">SDLPrimaryAudioSource</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">primaryAudioSource</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource">SDLPrimaryAudioSource</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -383,11 +343,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">eCallEventActive</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">eCallEventActive</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">eCallEventActive</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">eCallEventActive</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLDiagnosticMessage.html b/docs/Classes/SDLDiagnosticMessage.html index 518caba84..3d7d40554 100644 --- a/docs/Classes/SDLDiagnosticMessage.html +++ b/docs/Classes/SDLDiagnosticMessage.html @@ -3,8 +3,6 @@ <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--initWithTargetId:length:data:">-initWithTargetId:length:data:</a></li> <li><a href="#section-targetID">targetID</a></li> <li><a href="#section-messageLength">messageLength</a></li> @@ -19,36 +17,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - <h3 id="section--initWithTargetId:length:data:"> -initWithTargetId:length:data: </h3> @@ -58,7 +26,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> @@ -75,11 +43,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">targetID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">targetID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">targetID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">targetID</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -95,11 +63,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">messageLength</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">messageLength</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">messageLength</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">messageLength</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -115,11 +84,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">messageData</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">messageData</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">messageData</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">messageData</span><span class="p">:</span> <span class="p">[</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLDiagnosticMessageResponse.html b/docs/Classes/SDLDiagnosticMessageResponse.html index 51b45dc61..75346efc2 100644 --- a/docs/Classes/SDLDiagnosticMessageResponse.html +++ b/docs/Classes/SDLDiagnosticMessageResponse.html @@ -3,48 +3,19 @@ <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-messageDataResult">messageDataResult</a></li> </ul> <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"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - +<section class="section task-group-section"> <h3 id="section-messageDataResult"> messageDataResult </h3> @@ -54,7 +25,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..2ad946847 100644 --- a/docs/Classes/SDLDialNumber.html +++ b/docs/Classes/SDLDialNumber.html @@ -3,8 +3,6 @@ <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--initWithNumber:">-initWithNumber:</a></li> <li><a href="#section-number">number</a></li> </ul> @@ -17,36 +15,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - <h3 id="section--initWithNumber:"> -initWithNumber: </h3> @@ -56,7 +24,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,16 +34,16 @@ 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> <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">NSString</span> <span class="o">*</span><span class="n">number</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">number</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">number</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">number</span><span class="p">:</span> <span class="kt">String</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/SDLDialNumberResponse.html b/docs/Classes/SDLDialNumberResponse.html deleted file mode 100644 index d20451914..000000000 --- a/docs/Classes/SDLDialNumberResponse.html +++ /dev/null @@ -1,48 +0,0 @@ -<h1>SDLDialNumberResponse 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>Indicates the result, success, or failure of the SDLDialNumber request.</p> - -<p>@since SDL 4.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLDimension.html b/docs/Classes/SDLDimension.html deleted file mode 100644 index c6386805a..000000000 --- a/docs/Classes/SDLDimension.html +++ /dev/null @@ -1,145 +0,0 @@ -<h1>SDLDimension 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-+NO_FIX">+NO_FIX</a></li> - <li><a href="#section-+_2D">+_2D</a></li> - <li><a href="#section-+_3D">+_3D</a></li> -</ul> - -<h3>Overview</h3> - -<p>The supported dimensions of the GPS.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLDimension</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDimension</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">SDLDimension</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>SDLDimension</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLDimension</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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDimension</span> <span class="o">*</span><span class="p">)</span><span class="n">NO_FIX</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">no_FIX</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDimension</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDimension</span> <span class="o">*</span><span class="p">)</span><span class="n">_2D</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">_2D</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDimension</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDimension</span> <span class="o">*</span><span class="p">)</span><span class="n">_3D</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">_3D</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDimension</span><span class="o">!</span></code></pre> - - - - <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..a79a83fb2 100644 --- a/docs/Classes/SDLDisplayCapabilities.html +++ b/docs/Classes/SDLDisplayCapabilities.html @@ -3,8 +3,6 @@ <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-displayType">displayType</a></li> <li><a href="#section-textFields">textFields</a></li> <li><a href="#section-imageFields">imageFields</a></li> @@ -23,48 +21,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLDisplayCapabilities 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 newly allocated SDLDisplayCapabilities 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-displayType"> displayType </h3> @@ -76,11 +32,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDisplayType.html">SDLDisplayType</a></span> <span class="o">*</span><span class="n">displayType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="n">_Nonnull</span> <span class="n">displayType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">displayType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDisplayType.html">SDLDisplayType</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">displayType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDisplayType.h@T@SDLDisplayType">SDLDisplayType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -92,7 +48,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 @@ -104,11 +59,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">textFields</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTextField.html">SDLTextField</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">textFields</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">textFields</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">textFields</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTextField.html">SDLTextField</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> @@ -120,7 +76,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 @@ -132,11 +87,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">imageFields</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLImageField.html">SDLImageField</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">imageFields</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">imageFields</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">imageFields</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLImageField.html">SDLImageField</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> @@ -146,7 +102,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 @@ -158,11 +113,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">mediaClockFormats</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLMediaClockFormat.h@T@SDLMediaClockFormat">SDLMediaClockFormat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">mediaClockFormats</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">mediaClockFormats</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">mediaClockFormats</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLMediaClockFormat.h@T@SDLMediaClockFormat">SDLMediaClockFormat</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> @@ -180,11 +136,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">graphicSupported</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">graphicSupported</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">graphicSupported</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">graphicSupported</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -202,11 +159,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">templatesAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">templatesAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">templatesAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">templatesAvailable</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> @@ -222,11 +180,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLScreenParams.html">SDLScreenParams</a></span> <span class="o">*</span><span class="n">screenParams</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLScreenParams.html">SDLScreenParams</a></span> <span class="o">*</span><span class="n">screenParams</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">screenParams</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLScreenParams.html">SDLScreenParams</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">screenParams</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLScreenParams.html">SDLScreenParams</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> @@ -242,11 +200,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">numCustomPresetsAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">numCustomPresetsAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">numCustomPresetsAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">numCustomPresetsAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLDisplayType.html b/docs/Classes/SDLDisplayType.html deleted file mode 100644 index e2ff220b5..000000000 --- a/docs/Classes/SDLDisplayType.html +++ /dev/null @@ -1,262 +0,0 @@ -<h1>SDLDisplayType 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-+CID">+CID</a></li> - <li><a href="#section-+TYPE2">+TYPE2</a></li> - <li><a href="#section-+TYPE5">+TYPE5</a></li> - <li><a href="#section-+NGN">+NGN</a></li> - <li><a href="#section-+GEN2_8_DMA">+GEN2_8_DMA</a></li> - <li><a href="#section-+GEN2_6_DMA">+GEN2_6_DMA</a></li> - <li><a href="#section-+MFD3">+MFD3</a></li> - <li><a href="#section-+MFD4">+MFD4</a></li> - <li><a href="#section-+MFD5">+MFD5</a></li> - <li><a href="#section-+GEN3_8_INCH">+GEN3_8_INCH</a></li> - <li><a href="#section-+GENERIC">+GENERIC</a></li> -</ul> - -<h3>Overview</h3> - -<p>Identifies the various display types used by SDL.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLDisplayType</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDisplayType</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">SDLDisplayType</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>SDLDisplayType</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLDisplayType</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 SDLDisplayType</p> - - </div> - - <h3 id="section-+CID"> - +CID - </h3> - - <p>@abstract This display type provides a 2-line x 20 character <q>dot matrix</q> display.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDisplayType</span> <span class="o">*</span><span class="p">)</span><span class="n">CID</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">cid</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDisplayType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLDisplayType with value of <em>CID</em></p> - - </div> - - <h3 id="section-+TYPE2"> - +TYPE2 - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+TYPE5"> - +TYPE5 - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+NGN"> - +NGN - </h3> - - <p>@abstract This display type provides an 8 inch touchscreen display.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDisplayType</span> <span class="o">*</span><span class="p">)</span><span class="n">NGN</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">ngn</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDisplayType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLDisplayType with value of <em>NGN</em></p> - - </div> - - <h3 id="section-+GEN2_8_DMA"> - +GEN2_8_DMA - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+GEN2_6_DMA"> - +GEN2_6_DMA - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+MFD3"> - +MFD3 - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+MFD4"> - +MFD4 - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+MFD5"> - +MFD5 - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+GEN3_8_INCH"> - +GEN3_8_INCH - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+GENERIC"> - +GENERIC - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLDriverDistractionState.html b/docs/Classes/SDLDriverDistractionState.html deleted file mode 100644 index ea7d06013..000000000 --- a/docs/Classes/SDLDriverDistractionState.html +++ /dev/null @@ -1,118 +0,0 @@ -<h1>SDLDriverDistractionState 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-+DD_ON">+DD_ON</a></li> - <li><a href="#section-+DD_OFF">+DD_OFF</a></li> -</ul> - -<h3>Overview</h3> - -<p>Enumeration that describes possible states of driver distraction.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLDisplayType</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDriverDistractionState</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">SDLDriverDistractionState</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>SDLDisplayType</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLDriverDistractionState</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 SDLDriverDistractionState</p> - - </div> - - <h3 id="section-+DD_ON"> - +DD_ON - </h3> - - <p>@abstract Driver distraction rules are in effect.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDriverDistractionState</span> <span class="o">*</span><span class="p">)</span><span class="n">DD_ON</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">dd_ON</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDriverDistractionState</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLDriverDistractionState with value of <em>DD_ON</em></p> - - </div> - - <h3 id="section-+DD_OFF"> - +DD_OFF - </h3> - - <p>@abstract Driver distraction rules are NOT in effect.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLDriverDistractionState</span> <span class="o">*</span><span class="p">)</span><span class="n">DD_OFF</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">dd_OFF</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLDriverDistractionState</span><span class="o">!</span></code></pre> - - - - <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 deleted file mode 100644 index 26b67e654..000000000 --- a/docs/Classes/SDLECallConfirmationStatus.html +++ /dev/null @@ -1,181 +0,0 @@ -<h1>SDLECallConfirmationStatus 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-+NORMAL">+NORMAL</a></li> - <li><a href="#section-+CALL_IN_PROGRESS">+CALL_IN_PROGRESS</a></li> - <li><a href="#section-+CALL_CANCELLED">+CALL_CANCELLED</a></li> - <li><a href="#section-+CALL_COMPLETED">+CALL_COMPLETED</a></li> - <li><a href="#section-+CALL_UNSUCCESSFUL">+CALL_UNSUCCESSFUL</a></li> - <li><a href="#section-+ECALL_CONFIGURED_OFF">+ECALL_CONFIGURED_OFF</a></li> - <li><a href="#section-+CALL_COMPLETE_DTMF_TIMEOUT">+CALL_COMPLETE_DTMF_TIMEOUT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the status of the eCall Notification. - *<b>Since</b> SmartDeviceLink 2.0 - <p></p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+NORMAL"> - +NORMAL - </h3> - - <p>No E-Call signal triggered.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLECallConfirmationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NORMAL</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">normal</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLECallConfirmationStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+CALL_IN_PROGRESS"> - +CALL_IN_PROGRESS - </h3> - - <p>An E-Call is being in progress.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLECallConfirmationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">CALL_IN_PROGRESS</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">call_IN_PROGRESS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLECallConfirmationStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+CALL_CANCELLED"> - +CALL_CANCELLED - </h3> - - <p>CALL_CANCELLED An E-Call was cancelled by the user.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLECallConfirmationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">CALL_CANCELLED</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">call_CANCELLED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLECallConfirmationStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+CALL_COMPLETED"> - +CALL_COMPLETED - </h3> - - <p>The E-Call sequence is completed.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLECallConfirmationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">CALL_COMPLETED</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">call_COMPLETED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLECallConfirmationStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+CALL_UNSUCCESSFUL"> - +CALL_UNSUCCESSFUL - </h3> - - <p>An E-Call could not be connected.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLECallConfirmationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">CALL_UNSUCCESSFUL</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">call_UNSUCCESSFUL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLECallConfirmationStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ECALL_CONFIGURED_OFF"> - +ECALL_CONFIGURED_OFF - </h3> - - <p>E-Call is not configured on this vehicle.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLECallConfirmationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ECALL_CONFIGURED_OFF</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">ecall_CONFIGURED_OFF</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLECallConfirmationStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+CALL_COMPLETE_DTMF_TIMEOUT"> - +CALL_COMPLETE_DTMF_TIMEOUT - </h3> - - <p>E-Call is considered to be complete without Emergency Operator contact.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLECallConfirmationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">CALL_COMPLETE_DTMF_TIMEOUT</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">call_COMPLETE_DTMF_TIMEOUT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLECallConfirmationStatus</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLECallInfo.html b/docs/Classes/SDLECallInfo.html index 874107e04..f2a1b2405 100644 --- a/docs/Classes/SDLECallInfo.html +++ b/docs/Classes/SDLECallInfo.html @@ -3,8 +3,6 @@ <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-eCallNotificationStatus">eCallNotificationStatus</a></li> <li><a href="#section-auxECallNotificationStatus">auxECallNotificationStatus</a></li> <li><a href="#section-eCallConfirmationStatus">eCallConfirmationStatus</a></li> @@ -16,28 +14,6 @@ <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-eCallNotificationStatus"> eCallNotificationStatus </h3> diff --git a/docs/Classes/SDLEmergencyEvent.html b/docs/Classes/SDLEmergencyEvent.html index 685f373a3..4218e7b23 100644 --- a/docs/Classes/SDLEmergencyEvent.html +++ b/docs/Classes/SDLEmergencyEvent.html @@ -3,8 +3,6 @@ <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-emergencyEventType">emergencyEventType</a></li> <li><a href="#section-fuelCutoffStatus">fuelCutoffStatus</a></li> <li><a href="#section-rolloverEvent">rolloverEvent</a></li> @@ -18,28 +16,6 @@ <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-emergencyEventType"> emergencyEventType </h3> diff --git a/docs/Classes/SDLEmergencyEventType.html b/docs/Classes/SDLEmergencyEventType.html deleted file mode 100644 index 3668c7186..000000000 --- a/docs/Classes/SDLEmergencyEventType.html +++ /dev/null @@ -1,181 +0,0 @@ -<h1>SDLEmergencyEventType 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-+NO_EVENT">+NO_EVENT</a></li> - <li><a href="#section-+FRONTAL">+FRONTAL</a></li> - <li><a href="#section-+SIDE">+SIDE</a></li> - <li><a href="#section-+REAR">+REAR</a></li> - <li><a href="#section-+ROLLOVER">+ROLLOVER</a></li> - <li><a href="#section-+NOT_SUPPORTED">+NOT_SUPPORTED</a></li> - <li><a href="#section-+FAULT">+FAULT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the emergency event status of the vehicle. - *<b> Since:</b> SmartDeviceLink 2.0 - *<p></p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+NO_EVENT"> - +NO_EVENT - </h3> - - <p>No emergency event has happened.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLEmergencyEventType</span> <span class="o">*</span><span class="p">)</span><span class="n">NO_EVENT</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">no_</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLEmergencyEventType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+FRONTAL"> - +FRONTAL - </h3> - - <p>Frontal collision has happened.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLEmergencyEventType</span> <span class="o">*</span><span class="p">)</span><span class="n">FRONTAL</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">frontal</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLEmergencyEventType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+SIDE"> - +SIDE - </h3> - - <p>Side collision has happened.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLEmergencyEventType</span> <span class="o">*</span><span class="p">)</span><span class="n">SIDE</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">side</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLEmergencyEventType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+REAR"> - +REAR - </h3> - - <p>Rear collision has happened.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLEmergencyEventType</span> <span class="o">*</span><span class="p">)</span><span class="n">REAR</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">rear</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLEmergencyEventType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ROLLOVER"> - +ROLLOVER - </h3> - - <p>A rollover event has happened.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLEmergencyEventType</span> <span class="o">*</span><span class="p">)</span><span class="n">ROLLOVER</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">rollover</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLEmergencyEventType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+NOT_SUPPORTED"> - +NOT_SUPPORTED - </h3> - - <p>The signal is not supported</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLEmergencyEventType</span> <span class="o">*</span><span class="p">)</span><span class="n">NOT_SUPPORTED</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">not_SUPPORTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLEmergencyEventType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+FAULT"> - +FAULT - </h3> - - <p>Emergency status cannot be determined</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLEmergencyEventType</span> <span class="o">*</span><span class="p">)</span><span class="n">FAULT</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">fault</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLEmergencyEventType</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLEncodedSyncPData.html b/docs/Classes/SDLEncodedSyncPData.html index e5162cd3f..d14e99000 100644 --- a/docs/Classes/SDLEncodedSyncPData.html +++ b/docs/Classes/SDLEncodedSyncPData.html @@ -3,8 +3,6 @@ <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-data">data</a></li> </ul> @@ -14,28 +12,6 @@ <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-data"> data </h3> diff --git a/docs/Classes/SDLEncodedSyncPDataResponse.html b/docs/Classes/SDLEncodedSyncPDataResponse.html deleted file mode 100644 index 04a19ecb7..000000000 --- a/docs/Classes/SDLEncodedSyncPDataResponse.html +++ /dev/null @@ -1,38 +0,0 @@ -<h1>SDLEncodedSyncPDataResponse 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/SDLEndAudioPassThru.html b/docs/Classes/SDLEndAudioPassThru.html deleted file mode 100644 index 2fe2f95be..000000000 --- a/docs/Classes/SDLEndAudioPassThru.html +++ /dev/null @@ -1,68 +0,0 @@ -<h1>SDLEndAudioPassThru 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>When this request is invoked, the audio capture stops -<p> -Function Group: AudioPassThru -<p> -<b>HMILevel needs to be FULL, LIMITED or BACKGROUND</b> -</p> - -<p>Since <b>SmartDeviceLink 2.0</b><br> -see SDLPerformAudioPassThru</p></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLEndAudioPassThru 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 SDLEndAudioPassThru object indicated by the NSMutableDictionary - parameter - <p></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> - -</section> diff --git a/docs/Classes/SDLEndAudioPassThruResponse.html b/docs/Classes/SDLEndAudioPassThruResponse.html deleted file mode 100644 index 40e25686c..000000000 --- a/docs/Classes/SDLEndAudioPassThruResponse.html +++ /dev/null @@ -1,48 +0,0 @@ -<h1>SDLEndAudioPassThruResponse 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>SDLEndAudioPassThruResponse is sent, when SDLEndAudioPassThru has been called</p> - -<p>Since <b>SmartDeviceLink 2.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLEnum.html b/docs/Classes/SDLEnum.html deleted file mode 100644 index e85501003..000000000 --- a/docs/Classes/SDLEnum.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLEnum Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-value">value</a></li> - <li><a href="#section--initWithValue:">-initWithValue:</a></li> - <li><a href="#section--isEqualToEnum:">-isEqualToEnum:</a></li> - <li><a href="#section-value">value</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-value"> - value - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--initWithValue:"> - -initWithValue: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--isEqualToEnum:"> - -isEqualToEnum: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-value"> - value - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLFile.html b/docs/Classes/SDLFile.html index af15542f5..c77a5bd74 100644 --- a/docs/Classes/SDLFile.html +++ b/docs/Classes/SDLFile.html @@ -8,7 +8,9 @@ <li><a href="#section-name">name</a></li> <li><a href="#section-fileURL">fileURL</a></li> <li><a href="#section-data">data</a></li> + <li><a href="#section-fileSize">fileSize</a></li> <li><a href="#section-fileType">fileType</a></li> + <li><a href="#section-inputStream">inputStream</a></li> <li><a href="#section--init">-init</a></li> <li><a href="#section--initWithFileURL:name:persistent:">-initWithFileURL:name:persistent:</a></li> <li><a href="#section-+persistentFileAtFileURL:name:">+persistentFileAtFileURL:name:</a></li> @@ -114,6 +116,24 @@ + <h3 id="section-fileSize"> + fileSize + </h3> + + <p>The size of the binary data of the SDLFile.</p> + + + + <h4>Objective-C</h4> + <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">nonatomic</span><span class="p">)</span> <span class="kt">unsigned</span> <span class="kt">long</span> <span class="kt">long</span> <span class="n">fileSize</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fileSize</span><span class="p">:</span> <span class="kt">UInt64</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + <h3 id="section-fileType"> fileType </h3> @@ -123,11 +143,29 @@ <h4>Objective-C</h4> - <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">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLFileType.html">SDLFileType</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">fileType</span><span class="p">;</span></code></pre> + <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">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">_Nonnull</span> <span class="n">fileType</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fileType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-inputStream"> + inputStream + </h3> + + <p>A stream to pull binary data from a SDLFile. The stream only pulls required data from the file on disk or in memory. This reduces memory usage while uploading a large file to the remote system as each chunk of data can be released immediately after it is uploaded.</p> + + + + <h4>Objective-C</h4> + <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">nonatomic</span><span class="p">)</span> <span class="n">NSInputStream</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">inputStream</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fileType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLFileType.html">SDLFileType</a></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">inputStream</span><span class="p">:</span> <span class="kt">InputStream</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -165,19 +203,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 +223,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> @@ -203,24 +236,18 @@ <span class="nf">name</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span></code></pre> - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">persistentFile</span><span class="p">(</span><span class="n">atFileURL</span> <span class="nv">url</span><span class="p">:</span> <span class="kt">URL</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="o">-></span> <span class="k">Self</span></code></pre> - <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 +259,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 +280,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 +312,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:"> @@ -323,27 +341,20 @@ <span class="nf">fileExtension</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">extension</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">persistentFile</span><span class="p">(</span><span class="n">with</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</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="n">fileExtension</span> <span class="nv">extension</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="k">Self</span></code></pre> - <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 +381,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..ef936c5e9 100644 --- a/docs/Classes/SDLFileManager.html +++ b/docs/Classes/SDLFileManager.html @@ -13,7 +13,10 @@ <li><a href="#section--startWithCompletionHandler:">-startWithCompletionHandler:</a></li> <li><a href="#section--stop">-stop</a></li> <li><a href="#section--deleteRemoteFileWithName:completionHandler:">-deleteRemoteFileWithName:completionHandler:</a></li> + <li><a href="#section--deleteRemoteFilesWithNames:completionHandler:">-deleteRemoteFilesWithNames:completionHandler:</a></li> <li><a href="#section--uploadFile:completionHandler:">-uploadFile:completionHandler:</a></li> + <li><a href="#section--uploadFiles:progressHandler:completionHandler:">-uploadFiles:progressHandler:completionHandler:</a></li> + <li><a href="#section--uploadFiles:completionHandler:">-uploadFiles:completionHandler:</a></li> <li><a href="#section-+temporaryFileDirectory">+temporaryFileDirectory</a></li> </ul> @@ -33,7 +36,7 @@ <h4>Objective-C</h4> <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">NSSet</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileManager.h@T@SDLFileName">SDLFileName</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">remoteFileNames</span><span class="p">;</span></code></pre> + <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileName">SDLFileName</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">remoteFileNames</span><span class="p">;</span></code></pre> <h4>Swift</h4> @@ -132,7 +135,6 @@ <div> <h4>Return Value</h4> <p>nil</p> - </div> <h3 id="section--initWithConnectionManager:"> @@ -153,13 +155,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 +183,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"> @@ -214,24 +213,50 @@ <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">deleteRemoteFileWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManager.h@T@SDLFileName">SDLFileName</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">deleteRemoteFileWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileName">SDLFileName</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">completionHandler</span><span class="p">:</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerDeleteCompletionHandler">SDLFileManagerDeleteCompletionHandler</a></span><span class="p">)</span><span class="nv">completion</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">deleteRemoteFile</span><span class="p">(</span><span class="n">withName</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">completionHandler</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerDeleteCompletionHandler">SDLFileManagerDeleteCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">delete</span><span class="p">(</span><span class="n">fileName</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">completionHandler</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerDeleteCompletionHandler">SDLFileManagerDeleteCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> <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--deleteRemoteFilesWithNames:completionHandler:"> + -deleteRemoteFilesWithNames:completionHandler: + </h3> + + <p>Deletes an array of files on the remote file system. The files are deleted in the order in which they are added to the array, with the first file to be deleted at index 0. The delete queue is sequential, meaning that once a delete request is sent to Core, the queue waits until a response is received from Core before the next the next delete request is sent.</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">deleteRemoteFilesWithNames</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileName">SDLFileName</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">names</span> + <span class="nf">completionHandler</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiDeleteCompletionHandler">SDLFileManagerMultiDeleteCompletionHandler</a></span><span class="p">)</span> + <span class="n">completionHandler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">delete</span><span class="p">(</span><span class="n">fileNames</span> <span class="nv">names</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">],</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiDeleteCompletionHandler">SDLFileManagerMultiDeleteCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>names</dt> + <dd><p>The names of the files to be deleted</p></dd> + <dt>completionHandler</dt> + <dd><p>an optional SDLFileManagerMultiDeleteCompletionHandler</p></dd> </dl> <h3 id="section--uploadFile:completionHandler:"> @@ -249,18 +274,76 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">uploadFile</span><span class="p">(</span><span class="n">_</span> <span class="nv">file</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLFile.html">SDLFile</a></span><span class="p">,</span> <span class="n">completionHandler</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadCompletionHandler">SDLFileManagerUploadCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">file</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLFile.html">SDLFile</a></span><span class="p">,</span> <span class="n">completionHandler</span> <span class="nv">completion</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerUploadCompletionHandler">SDLFileManagerUploadCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> <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--uploadFiles:progressHandler:completionHandler:"> + -uploadFiles:progressHandler:completionHandler: + </h3> + + <p>Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</p> + +<p>The optional progress handler can be used to keep track of the upload progress. After each file upload, the progress handler returns the upload percentage and an error, if one occured during the upload process. The progress handler also includes an option to cancel the upload of all remaining files in queue.</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">uploadFiles</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLFile.html">SDLFile</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">files</span> + <span class="nf">progressHandler</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadProgressHandler">SDLFileManagerMultiUploadProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> + <span class="nf">completionHandler</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler">SDLFileManagerMultiUploadCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">files</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLFile.html">SDLFile</a></span><span class="p">],</span> <span class="nv">progressHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadProgressHandler">SDLFileManagerMultiUploadProgressHandler</a></span><span class="p">?,</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler">SDLFileManagerMultiUploadCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>files</dt> + <dd><p>An array of SDLFiles to be sent</p></dd> + <dt>progressHandler</dt> + <dd><p>an optional SDLFileManagerMultiUploadProgressHandler</p></dd> + <dt>completionHandler</dt> + <dd><p>an optional SDLFileManagerMultiUploadCompletionHandler</p></dd> + </dl> + + <h3 id="section--uploadFiles:completionHandler:"> + -uploadFiles:completionHandler: + </h3> + + <p>Uploads an array of files to the remote file system. The files will be uploaded in the order in which they are added to the array, with the first file to be uploaded at index 0. The upload queue is sequential, meaning that once a upload request is sent to Core, the queue waits until a response is received from Core before the next the next upload request is sent.</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">uploadFiles</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLFile.html">SDLFile</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">files</span> + <span class="nf">completionHandler</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler">SDLFileManagerMultiUploadCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">upload</span><span class="p">(</span><span class="nv">files</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLFile.html">SDLFile</a></span><span class="p">],</span> <span class="nv">completionHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileManagerConstants.h@T@SDLFileManagerMultiUploadCompletionHandler">SDLFileManagerMultiUploadCompletionHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>files</dt> + <dd><p>An array of SDLFiles to be sent</p></dd> + <dt>completionHandler</dt> + <dd><p>an optional SDLFileManagerMultiUploadCompletionHandler</p></dd> </dl> <h3 id="section-+temporaryFileDirectory"> @@ -285,7 +368,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 deleted file mode 100644 index 8f93fe009..000000000 --- a/docs/Classes/SDLFileType.html +++ /dev/null @@ -1,262 +0,0 @@ -<h1>SDLFileType 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-+GRAPHIC_BMP">+GRAPHIC_BMP</a></li> - <li><a href="#section-+GRAPHIC_JPEG">+GRAPHIC_JPEG</a></li> - <li><a href="#section-+GRAPHIC_PNG">+GRAPHIC_PNG</a></li> - <li><a href="#section-+AUDIO_WAVE">+AUDIO_WAVE</a></li> - <li><a href="#section-+AUDIO_MP3">+AUDIO_MP3</a></li> - <li><a href="#section-+AUDIO_AAC">+AUDIO_AAC</a></li> - <li><a href="#section-+BINARY">+BINARY</a></li> - <li><a href="#section-+JSON">+JSON</a></li> -</ul> - -<h3>Overview</h3> - -<p>Enumeration listing possible file types.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLFileType</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</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">SDLFileType</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>SDLFileType</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLFileType</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 SDLFileType</p> - - </div> - - <h3 id="section-+GRAPHIC_BMP"> - +GRAPHIC_BMP - </h3> - - <p>@abstract file type: Bitmap (BMP)</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">GRAPHIC_BMP</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">graphic_BMP</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLFileType with value of <em>GRAPHIC_BMP</em></p> - - </div> - - <h3 id="section-+GRAPHIC_JPEG"> - +GRAPHIC_JPEG - </h3> - - <p>@abstract file type: JPEG</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">GRAPHIC_JPEG</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">graphic_JPEG</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLFileType with value of <em>GRAPHIC_JPEG</em></p> - - </div> - - <h3 id="section-+GRAPHIC_PNG"> - +GRAPHIC_PNG - </h3> - - <p>@abstract file type: PNG</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">GRAPHIC_PNG</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">graphic_PNG</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLFileType with value of <em>GRAPHIC_PNG</em></p> - - </div> - - <h3 id="section-+AUDIO_WAVE"> - +AUDIO_WAVE - </h3> - - <p>@abstract file type: WAVE (WAV)</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">AUDIO_WAVE</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">audio_WAVE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLFileType with value of <em>AUDIO_WAVE</em></p> - - </div> - - <h3 id="section-+AUDIO_MP3"> - +AUDIO_MP3 - </h3> - - <p>@abstract file type: MP3</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">AUDIO_MP3</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">audio_MP3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLFileType with value of <em>AUDIO_MP3</em></p> - - </div> - - <h3 id="section-+AUDIO_AAC"> - +AUDIO_AAC - </h3> - - <p>@abstract file type: AAC</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">AUDIO_AAC</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">audio_AAC</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLFileType with value of <em>AUDIO_AAC</em></p> - - </div> - - <h3 id="section-+BINARY"> - +BINARY - </h3> - - <p>@abstract file type: BINARY</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">BINARY</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">binary</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLFileType with value of <em>BINARY</em></p> - - </div> - - <h3 id="section-+JSON"> - +JSON - </h3> - - <p>@abstract file type: JSON</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFileType</span> <span class="o">*</span><span class="p">)</span><span class="n">JSON</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">json</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFileType</span><span class="o">!</span></code></pre> - - - - <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 deleted file mode 100644 index c705169cc..000000000 --- a/docs/Classes/SDLFuelCutoffStatus.html +++ /dev/null @@ -1,146 +0,0 @@ -<h1>SDLFuelCutoffStatus 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-+TERMINATE_FUEL">+TERMINATE_FUEL</a></li> - <li><a href="#section-+NORMAL_OPERATION">+NORMAL_OPERATION</a></li> - <li><a href="#section-+FAULT">+FAULT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the status of the Restraints Control Module fuel pump cutoff. - The fuel pump is cut off typically after the vehicle has had a collision.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLFuelCutoffStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFuelCutoffStatus</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">SDLFuelCutoffStatus</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>SDLFuelCutoffStatus</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLFuelCutoffStatus</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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFuelCutoffStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">TERMINATE_FUEL</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">terminate_FUEL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFuelCutoffStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFuelCutoffStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NORMAL_OPERATION</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">normal_OPERATION</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFuelCutoffStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLFuelCutoffStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">FAULT</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">fault</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLFuelCutoffStatus</span><span class="o">!</span></code></pre> - - - - <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..2afb3c951 100644 --- a/docs/Classes/SDLGPSData.html +++ b/docs/Classes/SDLGPSData.html @@ -3,8 +3,6 @@ <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-longitudeDegrees">longitudeDegrees</a></li> <li><a href="#section-latitudeDegrees">latitudeDegrees</a></li> <li><a href="#section-utcYear">utcYear</a></li> @@ -33,49 +31,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLGPSData 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 newly allocated SDLGPSData object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-longitudeDegrees"> longitudeDegrees </h3> @@ -87,11 +42,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">longitudeDegrees</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">longitudeDegrees</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">longitudeDegrees</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">longitudeDegrees</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -107,11 +63,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">latitudeDegrees</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">latitudeDegrees</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">latitudeDegrees</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">latitudeDegrees</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -127,11 +84,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">utcYear</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">utcYear</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcYear</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcYear</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -147,11 +104,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">utcMonth</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">utcMonth</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcMonth</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcMonth</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -167,11 +124,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">utcDay</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">utcDay</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcDay</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcDay</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -187,11 +144,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">utcHours</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">utcHours</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcHours</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcHours</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -207,11 +164,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">utcMinutes</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">utcMinutes</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcMinutes</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcMinutes</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -227,11 +184,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">utcSeconds</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">utcSeconds</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcSeconds</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">utcSeconds</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -245,11 +202,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLCompassDirection.html">SDLCompassDirection</a></span> <span class="o">*</span><span class="n">compassDirection</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLCompassDirection.h@T@SDLCompassDirection">SDLCompassDirection</a></span> <span class="n">_Nonnull</span> <span class="n">compassDirection</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">compassDirection</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLCompassDirection.html">SDLCompassDirection</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">compassDirection</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLCompassDirection.h@T@SDLCompassDirection">SDLCompassDirection</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -267,11 +225,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">pdop</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">pdop</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">pdop</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">pdop</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -289,11 +247,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">hdop</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">hdop</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hdop</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">hdop</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -311,11 +269,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">vdop</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">vdop</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vdop</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vdop</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -333,11 +291,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">actual</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">actual</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">actual</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">actual</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -353,11 +311,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">satellites</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">satellites</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">satellites</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">satellites</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -373,11 +331,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDimension.html">SDLDimension</a></span> <span class="o">*</span><span class="n">dimension</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLDimension.h@T@SDLDimension">SDLDimension</a></span> <span class="n">_Nonnull</span> <span class="n">dimension</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">dimension</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDimension.html">SDLDimension</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">dimension</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDimension.h@T@SDLDimension">SDLDimension</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -393,11 +351,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">altitude</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">altitude</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">altitude</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">altitude</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -415,11 +373,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">heading</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">heading</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">heading</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">heading</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -435,11 +393,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">speed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLGenericResponse.html b/docs/Classes/SDLGenericResponse.html deleted file mode 100644 index 62d1fdbc2..000000000 --- a/docs/Classes/SDLGenericResponse.html +++ /dev/null @@ -1,48 +0,0 @@ -<h1>SDLGenericResponse 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>Generic Response is sent, when the name of a received msg cannot be -retrieved. Only used in case of an error. Currently, only resultCode -INVALID_DATA is used.</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</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> - - - - - -</section> diff --git a/docs/Classes/SDLGetDTCs.html b/docs/Classes/SDLGetDTCs.html index 6e6b9cb24..dc0f63be7 100644 --- a/docs/Classes/SDLGetDTCs.html +++ b/docs/Classes/SDLGetDTCs.html @@ -3,8 +3,6 @@ <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--initWithECUName:">-initWithECUName:</a></li> <li><a href="#section--initWithECUName:mask:">-initWithECUName:mask:</a></li> <li><a href="#section-ecuName">ecuName</a></li> @@ -23,49 +21,6 @@ Function Group: ProprietaryData <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLGetDTCs 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 SDLGetDTCs object indicated by the dictionary parameter - <p></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--initWithECUName:"> -initWithECUName: </h3> @@ -75,7 +30,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 +45,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> @@ -109,11 +64,11 @@ Function Group: ProprietaryData <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">ecuName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">ecuName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">ecuName</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ecuName</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -127,11 +82,11 @@ Function Group: ProprietaryData <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">dtcMask</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">dtcMask</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">dtcMask</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">dtcMask</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLGetDTCsResponse.html b/docs/Classes/SDLGetDTCsResponse.html index 1a4cbe10b..f21e93bfc 100644 --- a/docs/Classes/SDLGetDTCsResponse.html +++ b/docs/Classes/SDLGetDTCsResponse.html @@ -3,8 +3,6 @@ <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-ecuHeader">ecuHeader</a></li> <li><a href="#section-dtc">dtc</a></li> </ul> @@ -17,36 +15,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - <h3 id="section-ecuHeader"> ecuHeader </h3> @@ -56,7 +24,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 +39,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/SDLGetInteriorVehicleData.html b/docs/Classes/SDLGetInteriorVehicleData.html new file mode 100644 index 000000000..45349f356 --- /dev/null +++ b/docs/Classes/SDLGetInteriorVehicleData.html @@ -0,0 +1,107 @@ +<h1>SDLGetInteriorVehicleData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithModuleType:">-initWithModuleType:</a></li> + <li><a href="#section--initAndSubscribeToModuleType:">-initAndSubscribeToModuleType:</a></li> + <li><a href="#section--initAndUnsubscribeToModuleType:">-initAndUnsubscribeToModuleType:</a></li> + <li><a href="#section-moduleType">moduleType</a></li> + <li><a href="#section-subscribe">subscribe</a></li> +</ul> + +<h3>Overview</h3> + +<p>Reads the current status value of specified remote control module (type). +When subscribe is true, subscribes for specific remote control module data items. +When subscribe is false, unsubscribes for specific remote control module data items. +Once subscribed, the application will be notified by the onInteriorVehicleData RPC notification +whenever new data is available for the module.</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithModuleType:"> + -initWithModuleType: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetInteriorVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + + + + + + <h3 id="section--initAndSubscribeToModuleType:"> + -initAndSubscribeToModuleType: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetInteriorVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + + + + + + <h3 id="section--initAndUnsubscribeToModuleType:"> + -initAndUnsubscribeToModuleType: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetInteriorVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + + + + + + <h3 id="section-moduleType"> + moduleType + </h3> + + <p>The type of a RC module to retrieve module data from the vehicle.</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="../Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="n">_Nonnull</span> <span class="n">moduleType</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">moduleType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-subscribe"> + subscribe + </h3> + + <p>If subscribe is true, the head unit will register onInteriorVehicleData notifications for the requested moduelType. + If subscribe is false, the head unit will unregister onInteriorVehicleData notifications for the requested moduelType.</p> + +<p>optional, Boolean, default Value = false</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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">subscribe</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">subscribe</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + +</section> diff --git a/docs/Classes/SDLGetInteriorVehicleDataResponse.html b/docs/Classes/SDLGetInteriorVehicleDataResponse.html new file mode 100644 index 000000000..889ac3437 --- /dev/null +++ b/docs/Classes/SDLGetInteriorVehicleDataResponse.html @@ -0,0 +1,50 @@ +<h1>SDLGetInteriorVehicleDataResponse Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-moduleData">moduleData</a></li> + <li><a href="#section-isSubscribed">isSubscribed</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-moduleData"> + moduleData + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-isSubscribed"> + isSubscribed + </h3> + + <p>@abstract It is a conditional-mandatory parameter: must be returned in case <q>subscribe</q> parameter was present in the related request. + if <q>true</q> - the <q>moduleType</q> from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. + if <q>false</q> - the <q>moduleType</q> from request is either unsubscribed or failed to subscribe.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">isSubscribed</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isSubscribed</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + +</section> diff --git a/docs/Classes/SDLGetSystemCapability.html b/docs/Classes/SDLGetSystemCapability.html new file mode 100644 index 000000000..866542a9c --- /dev/null +++ b/docs/Classes/SDLGetSystemCapability.html @@ -0,0 +1,48 @@ +<h1>SDLGetSystemCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <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--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="../Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span> <span class="n">_Nonnull</span> <span class="n">systemCapabilityType</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">systemCapabilityType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span> <span class="p">{</span> <span class="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..51987195f --- /dev/null +++ b/docs/Classes/SDLGetSystemCapabilityResponse.html @@ -0,0 +1,26 @@ +<h1>SDLGetSystemCapabilityResponse Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-systemCapability">systemCapability</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-systemCapability"> + systemCapability + </h3> + + <p>Undocumented</p> + + + + + + +</section> diff --git a/docs/Classes/SDLGetVehicleData.html b/docs/Classes/SDLGetVehicleData.html index 405ebc637..c9e976fae 100644 --- a/docs/Classes/SDLGetVehicleData.html +++ b/docs/Classes/SDLGetVehicleData.html @@ -3,8 +3,6 @@ <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--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:">-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:</a></li> <li><a href="#section-gps">gps</a></li> <li><a href="#section-speed">speed</a></li> @@ -47,50 +45,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLGetVehicleData 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 new SDLGetVehicleData object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--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:"> -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: </h3> @@ -100,7 +54,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> @@ -115,11 +69,11 @@ parameter <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">gps</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -133,11 +87,11 @@ parameter <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">speed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -151,11 +105,11 @@ parameter <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">rpm</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">rpm</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -169,11 +123,11 @@ parameter <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">fuelLevel</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">fuelLevel</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -187,11 +141,12 @@ parameter <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">fuelLevel_State</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -205,11 +160,12 @@ parameter <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">instantFuelConsumption</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">instantFuelConsumption</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -223,11 +179,12 @@ parameter <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">externalTemperature</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">externalTemperature</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -241,11 +198,11 @@ parameter <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">vin</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">vin</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vin</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vin</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -259,11 +216,11 @@ parameter <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">prndl</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">prndl</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -277,11 +234,12 @@ parameter <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">tirePressure</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -295,11 +253,11 @@ parameter <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">odometer</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">odometer</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -313,11 +271,11 @@ parameter <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">beltStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -331,11 +289,12 @@ parameter <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">bodyInformation</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -349,11 +308,12 @@ parameter <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">deviceStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -367,11 +327,12 @@ parameter <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">driverBraking</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">driverBraking</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -385,11 +346,12 @@ parameter <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">wiperStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">wiperStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -403,11 +365,12 @@ parameter <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">headLampStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -421,11 +384,12 @@ parameter <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">engineTorque</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">engineTorque</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -440,11 +404,12 @@ subscribed.</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">accPedalPosition</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">accPedalPosition</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -459,11 +424,12 @@ subscribed.</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">steeringWheelAngle</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">steeringWheelAngle</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -477,7 +443,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 +458,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 +473,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 +488,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 +503,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..af5b59cf3 100644 --- a/docs/Classes/SDLGetVehicleDataResponse.html +++ b/docs/Classes/SDLGetVehicleDataResponse.html @@ -3,8 +3,6 @@ <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-gps">gps</a></li> <li><a href="#section-speed">speed</a></li> <li><a href="#section-rpm">rpm</a></li> @@ -40,50 +38,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLGetVehicleDataResponse 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 new SDLGetVehicleDataResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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-gps"> gps </h3> @@ -93,11 +47,11 @@ parameter <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/SDLGPSData.html">SDLGPSData</a></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLGPSData.html">SDLGPSData</a></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGPSData.html">SDLGPSData</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">gps</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGPSData.html">SDLGPSData</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> @@ -111,11 +65,11 @@ parameter <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">speed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -129,11 +83,11 @@ parameter <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">rpm</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">rpm</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -147,11 +101,11 @@ parameter <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">fuelLevel</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">fuelLevel</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -165,11 +119,12 @@ parameter <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/SDLComponentVolumeStatus.html">SDLComponentVolumeStatus</a></span> <span class="o">*</span><span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLComponentVolumeStatus.h@T@SDLComponentVolumeStatus">SDLComponentVolumeStatus</a></span> <span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLComponentVolumeStatus.html">SDLComponentVolumeStatus</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">fuelLevel_State</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLComponentVolumeStatus.h@T@SDLComponentVolumeStatus">SDLComponentVolumeStatus</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> @@ -183,11 +138,12 @@ parameter <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">instantFuelConsumption</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">instantFuelConsumption</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -201,11 +157,12 @@ parameter <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">externalTemperature</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">externalTemperature</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -219,11 +176,11 @@ parameter <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">NSString</span> <span class="o">*</span><span class="n">vin</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">vin</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vin</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vin</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> @@ -237,11 +194,11 @@ parameter <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/SDLPRNDL.html">SDLPRNDL</a></span> <span class="o">*</span><span class="n">prndl</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLPRNDL.h@T@SDLPRNDL">SDLPRNDL</a></span> <span class="n">prndl</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPRNDL.html">SDLPRNDL</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">prndl</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLPRNDL.h@T@SDLPRNDL">SDLPRNDL</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> @@ -255,11 +212,11 @@ parameter <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/SDLTireStatus.html">SDLTireStatus</a></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTireStatus.html">SDLTireStatus</a></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTireStatus.html">SDLTireStatus</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">tirePressure</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTireStatus.html">SDLTireStatus</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> @@ -273,11 +230,11 @@ parameter <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">odometer</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">odometer</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -291,11 +248,11 @@ parameter <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/SDLBeltStatus.html">SDLBeltStatus</a></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLBeltStatus.html">SDLBeltStatus</a></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBeltStatus.html">SDLBeltStatus</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">beltStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBeltStatus.html">SDLBeltStatus</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> @@ -309,11 +266,12 @@ parameter <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/SDLBodyInformation.html">SDLBodyInformation</a></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLBodyInformation.html">SDLBodyInformation</a></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBodyInformation.html">SDLBodyInformation</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">bodyInformation</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBodyInformation.html">SDLBodyInformation</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> @@ -327,11 +285,11 @@ parameter <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/SDLDeviceStatus.html">SDLDeviceStatus</a></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDeviceStatus.html">SDLDeviceStatus</a></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeviceStatus.html">SDLDeviceStatus</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">deviceStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeviceStatus.html">SDLDeviceStatus</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> @@ -345,11 +303,12 @@ parameter <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/SDLVehicleDataEventStatus.html">SDLVehicleDataEventStatus</a></span> <span class="o">*</span><span class="n">driverBraking</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBraking</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataEventStatus.html">SDLVehicleDataEventStatus</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">driverBraking</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</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> @@ -363,11 +322,11 @@ parameter <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/SDLWiperStatus.html">SDLWiperStatus</a></span> <span class="o">*</span><span class="n">wiperStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLWiperStatus.h@T@SDLWiperStatus">SDLWiperStatus</a></span> <span class="n">wiperStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLWiperStatus.html">SDLWiperStatus</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">wiperStatus</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLWiperStatus.h@T@SDLWiperStatus">SDLWiperStatus</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> @@ -381,11 +340,12 @@ parameter <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/SDLHeadLampStatus.html">SDLHeadLampStatus</a></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLHeadLampStatus.html">SDLHeadLampStatus</a></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHeadLampStatus.html">SDLHeadLampStatus</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">headLampStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHeadLampStatus.html">SDLHeadLampStatus</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> @@ -399,11 +359,12 @@ parameter <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">engineTorque</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">engineTorque</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -417,11 +378,12 @@ parameter <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">accPedalPosition</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">accPedalPosition</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -435,11 +397,12 @@ parameter <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">steeringWheelAngle</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">steeringWheelAngle</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -453,7 +416,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 +431,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 +446,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 +461,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 +476,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/SDLGetWaypoints.html b/docs/Classes/SDLGetWaypoints.html index eccd857b1..d57d57f51 100644 --- a/docs/Classes/SDLGetWaypoints.html +++ b/docs/Classes/SDLGetWaypoints.html @@ -36,11 +36,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLWaypointType.html">SDLWaypointType</a></span> <span class="o">*</span><span class="n">waypointType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span> <span class="n">waypointType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">waypointType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLWaypointType.html">SDLWaypointType</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">waypointType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</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> diff --git a/docs/Classes/SDLGetWaypointsResponse.html b/docs/Classes/SDLGetWaypointsResponse.html index b485b1739..48616be81 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 @@ -29,11 +28,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">waypoints</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">waypoints</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">waypoints</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span><span class="p">]</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">waypoints</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</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> diff --git a/docs/Classes/SDLGlobalProperty.html b/docs/Classes/SDLGlobalProperty.html deleted file mode 100644 index 59b6d62fa..000000000 --- a/docs/Classes/SDLGlobalProperty.html +++ /dev/null @@ -1,203 +0,0 @@ -<h1>SDLGlobalProperty 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-+HELPPROMPT">+HELPPROMPT</a></li> - <li><a href="#section-+TIMEOUTPROMPT">+TIMEOUTPROMPT</a></li> - <li><a href="#section-+VRHELPTITLE">+VRHELPTITLE</a></li> - <li><a href="#section-+VRHELPITEMS">+VRHELPITEMS</a></li> - <li><a href="#section-+MENUNAME">+MENUNAME</a></li> - <li><a href="#section-+MENUICON">+MENUICON</a></li> - <li><a href="#section-+KEYBOARDPROPERTIES">+KEYBOARDPROPERTIES</a></li> -</ul> - -<h3>Overview</h3> - -<p>Properties of a user-initiated VR interaction (i.e. interactions started by the user pressing the PTT button).</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLGlobalProperty -- parameter: value The value of the string to get an object for -- returns: SDLGlobalProperty</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLGlobalProperty</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">SDLGlobalProperty</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>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> - - - - <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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLGlobalProperty</span> <span class="o">*</span><span class="p">)</span><span class="n">HELPPROMPT</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">helpprompt</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLGlobalProperty</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLGlobalProperty</span> <span class="o">*</span><span class="p">)</span><span class="n">TIMEOUTPROMPT</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">timeoutprompt</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLGlobalProperty</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>A SDLGlobalProperty with value of <em>TIMEOUTPROMPT</em></p> - - </div> - - <h3 id="section-+VRHELPTITLE"> - +VRHELPTITLE - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+VRHELPITEMS"> - +VRHELPITEMS - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+MENUNAME"> - +MENUNAME - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+MENUICON"> - +MENUICON - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+KEYBOARDPROPERTIES"> - +KEYBOARDPROPERTIES - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLHMICapabilities.html b/docs/Classes/SDLHMICapabilities.html index 0375ca4c9..12b5393a4 100644 --- a/docs/Classes/SDLHMICapabilities.html +++ b/docs/Classes/SDLHMICapabilities.html @@ -3,10 +3,9 @@ <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-navigation">navigation</a></li> <li><a href="#section-phoneCall">phoneCall</a></li> + <li><a href="#section-videoStreaming">videoStreaming</a></li> </ul> <h3>Overview</h3> @@ -15,64 +14,63 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init + <h3 id="section-navigation"> + navigation </h3> - <p>Undocumented</p> + <p>Availability of built in Nav. True: Available, False: Not Available</p> + +<p>Boolean value. Optional.</p> - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">navigation</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">navigation</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + - - <h3 id="section-navigation"> - navigation + <h3 id="section-phoneCall"> + phoneCall </h3> - <p>Availability of build in Nav. True: Available, False: Not Available</p> + <p>Availability of built in phone. 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">navigation</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">phoneCall</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">navigation</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">phoneCall</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> - <h3 id="section-phoneCall"> - phoneCall + <h3 id="section-videoStreaming"> + videoStreaming </h3> - <p>Availability of build in phone. True: Available, False: Not Available</p> + <p>Availability of built 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">phoneCall</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">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">phoneCall</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> + <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="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLHMILevel.html b/docs/Classes/SDLHMILevel.html deleted file mode 100644 index 0fb78035b..000000000 --- a/docs/Classes/SDLHMILevel.html +++ /dev/null @@ -1,183 +0,0 @@ -<h1>SDLHMILevel 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-+FULL">+FULL</a></li> - <li><a href="#section-+LIMITED">+LIMITED</a></li> - <li><a href="#section-+BACKGROUND">+BACKGROUND</a></li> - <li><a href="#section-+NONE">+NONE</a></li> -</ul> - -<h3>Overview</h3> - -<p>Specifies current level of the HMI. An HMI level indicates the degree of user interaction possible through the HMI (e.g. TTS only, display only, VR, etc.). The HMI level varies for an application based on the type of display (i.e. Nav or non-Nav) and the user directing <q>focus</q> to other applications (e.g. phone, other mobile applications, etc.)</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Return HMILevel status (FULL, LIMITED, BACKGROUND, NONE)</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</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">SDLHMILevel</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>Current HMI level</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>Store all possible SDLHMILevel 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 with all possible HMILevel values inside</p> - - </div> - - <h3 id="section-+FULL"> - +FULL - </h3> - - <p>The application has full use of the SDL HMI. The app may output via TTS, display, or streaming audio and may gather input via VR, Menu, and button presses</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</span> <span class="o">*</span><span class="p">)</span><span class="n">FULL</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">full</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMILevel</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the HMILevel with value of <em>FULL</em></p> - - </div> - - <h3 id="section-+LIMITED"> - +LIMITED - </h3> - - <p>This HMI Level is only defined for a media application using an HMI with an 8 inch touchscreen (Nav) system. The application’s <i>Show</i> text is displayed and it receives button presses from media-oriented buttons (SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN, PRESET_0-9)</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</span> <span class="o">*</span><span class="p">)</span><span class="n">LIMITED</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">limited</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMILevel</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the HMILevel with value of <em>LIMITED</em></p> - - </div> - - <h3 id="section-+BACKGROUND"> - +BACKGROUND - </h3> - - <p>App cannot interact with user via TTS, VR, Display or Button Presses. App can perform the following operations:</p> - -<p>@discussion <ul> - <li>Operation : AddCommand</li> - <li>Operation : DeleteCommand</li> - <li>Operation : AddSubMenu</li> - <li>Operation : DeleteSubMenu</li> - <li>Operation : CreateInteractionChoiceSet</li> - <li>Operation : DeleteInteractionChoiceSet</li> - <li>Operation : SubscribeButton</li> - <li>Operation : UnsubscribeButton</li> - <li>Operation : Show</li> - <li>Operation : UnregisterAppInterface</li> - <li>Operation : ResetGlobalProperties</li> - <li>Operation : SetGlobalProperties</li> - </ul></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</span> <span class="o">*</span><span class="p">)</span><span class="n">BACKGROUND</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">background</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMILevel</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the HMILevel with value of <em>BACKGROUND</em></p> - - </div> - - <h3 id="section-+NONE"> - +NONE - </h3> - - <p>Application has been discovered by SDL, but it cannot send any requests or receive any notifications</p> - -<p>@discussion An HMILevel of NONE can also mean that the user has exited the application by saying <q>exit appname</q> or selecting <q>exit</q> from the application’s menu. When this happens, the application still has an active interface registration with SDL and all SDL resources the application has created (e.g. Choice Sets, subscriptions, etc.) still exist. But while the HMILevel is NONE, the application cannot send any messages to SYNC, except UnregisterAppInterface</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMILevel</span> <span class="o">*</span><span class="p">)</span><span class="n">NONE</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">none</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMILevel</span><span class="o">!</span></code></pre> - - - - <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..0a4526c50 100644 --- a/docs/Classes/SDLHMIPermissions.html +++ b/docs/Classes/SDLHMIPermissions.html @@ -3,8 +3,6 @@ <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-allowed">allowed</a></li> <li><a href="#section-userDisallowed">userDisallowed</a></li> </ul> @@ -17,55 +15,11 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLHMIPermissions 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 newly allocated SDLHMIPermissions object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-allowed"> allowed </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 @@ -77,11 +31,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">allowed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">allowed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">allowed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">allowed</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</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> @@ -91,7 +45,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 @@ -103,11 +56,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">userDisallowed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">userDisallowed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">userDisallowed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">userDisallowed</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</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> diff --git a/docs/Classes/SDLHMIZoneCapabilities.html b/docs/Classes/SDLHMIZoneCapabilities.html deleted file mode 100644 index 58fe12f38..000000000 --- a/docs/Classes/SDLHMIZoneCapabilities.html +++ /dev/null @@ -1,123 +0,0 @@ -<h1>SDLHMIZoneCapabilities 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-+FRONT">+FRONT</a></li> - <li><a href="#section-+BACK">+BACK</a></li> -</ul> - -<h3>Overview</h3> - -<p>Specifies HMI Zones in the vehicle.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract SDLHMIZoneCapabilities -- parameter: value The value of the string to get an object for -- returns: SDLHMIZoneCapabilities</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMIZoneCapabilities</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">SDLHMIZoneCapabilities</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>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> - - - - <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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMIZoneCapabilities</span> <span class="o">*</span><span class="p">)</span><span class="n">FRONT</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">front</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMIZoneCapabilities</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLHMIZoneCapabilities</span> <span class="o">*</span><span class="p">)</span><span class="n">BACK</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">back</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLHMIZoneCapabilities</span><span class="o">!</span></code></pre> - - - - <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..fd4c9bcb4 --- /dev/null +++ b/docs/Classes/SDLHapticRect.html @@ -0,0 +1,66 @@ +<h1>SDLHapticRect Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <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--initWithId:rect:"> + -initWithId:rect: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLHapticRect</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <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"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</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> </code></pre> + + + + + <h3 id="section-rect"> + rect + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLHapticRect</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + +</section> diff --git a/docs/Classes/SDLHeadLampStatus.html b/docs/Classes/SDLHeadLampStatus.html index f096caa7b..93169f2e6 100644 --- a/docs/Classes/SDLHeadLampStatus.html +++ b/docs/Classes/SDLHeadLampStatus.html @@ -3,8 +3,6 @@ <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-lowBeamsOn">lowBeamsOn</a></li> <li><a href="#section-highBeamsOn">highBeamsOn</a></li> <li><a href="#section-ambientLightSensorStatus">ambientLightSensorStatus</a></li> @@ -16,50 +14,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLHeadLampStatus 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 new SDLHeadLampStatus object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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-lowBeamsOn"> lowBeamsOn </h3> @@ -69,11 +23,11 @@ parameter <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">lowBeamsOn</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">lowBeamsOn</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">lowBeamsOn</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">lowBeamsOn</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -87,11 +41,11 @@ parameter <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">highBeamsOn</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">highBeamsOn</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">highBeamsOn</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">highBeamsOn</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -105,7 +59,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 deleted file mode 100644 index c4f6395c1..000000000 --- a/docs/Classes/SDLIgnitionStableStatus.html +++ /dev/null @@ -1,139 +0,0 @@ -<h1>SDLIgnitionStableStatus 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-+IGNITION_SWITCH_NOT_STABLE">+IGNITION_SWITCH_NOT_STABLE</a></li> - <li><a href="#section-+IGNITION_SWITCH_STABLE">+IGNITION_SWITCH_STABLE</a></li> - <li><a href="#section-+MISSING_FROM_TRANSMITTER">+MISSING_FROM_TRANSMITTER</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the ignition switch stability.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract return SDLIgnitionStableStatus -- parameter: value The value of the string to get an object for -- returns: SDLIgnitionStableStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStableStatus</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">SDLIgnitionStableStatus</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>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> - - - - <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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStableStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">IGNITION_SWITCH_NOT_STABLE</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">ignition_SWITCH_NOT_STABLE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLIgnitionStableStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStableStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">IGNITION_SWITCH_STABLE</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">ignition_SWITCH_STABLE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLIgnitionStableStatus</span><span class="o">!</span></code></pre> - - - - <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"> - +MISSING_FROM_TRANSMITTER - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLIgnitionStatus.html b/docs/Classes/SDLIgnitionStatus.html deleted file mode 100644 index 6e775c9ad..000000000 --- a/docs/Classes/SDLIgnitionStatus.html +++ /dev/null @@ -1,223 +0,0 @@ -<h1>SDLIgnitionStatus 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-+UNKNOWN">+UNKNOWN</a></li> - <li><a href="#section-+OFF">+OFF</a></li> - <li><a href="#section-+ACCESSORY">+ACCESSORY</a></li> - <li><a href="#section-+RUN">+RUN</a></li> - <li><a href="#section-+START">+START</a></li> - <li><a href="#section-+INVALID">+INVALID</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the status of ignition..</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract return SDLIgnitionStatus -- parameter: value The value of the string to get an object for -- returns: SDLIgnitionStatus object</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStatus</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">SDLIgnitionStatus</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>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> - - - - <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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">UNKNOWN</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">unknown</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLIgnitionStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">OFF</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">off</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLIgnitionStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ACCESSORY</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">accessory</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLIgnitionStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">RUN</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">run</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLIgnitionStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">START</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">start</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLIgnitionStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLIgnitionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">INVALID</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">invalid</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLIgnitionStatus</span><span class="o">!</span></code></pre> - - - - <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..10ef8304f 100644 --- a/docs/Classes/SDLImage.html +++ b/docs/Classes/SDLImage.html @@ -3,8 +3,6 @@ <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--initWithName:ofType:">-initWithName:ofType:</a></li> <li><a href="#section-value">value</a></li> <li><a href="#section-imageType">imageType</a></li> @@ -18,49 +16,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLImage 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 newly allocated SDLImage object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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--initWithName:ofType:"> -initWithName:ofType: </h3> @@ -70,7 +25,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> @@ -87,11 +42,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">value</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">value</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</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="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">value</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -107,11 +62,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImageType.html">SDLImageType</a></span> <span class="o">*</span><span class="n">imageType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</a></span> <span class="n">_Nonnull</span> <span class="n">imageType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">imageType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageType.html">SDLImageType</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">imageType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLImageType.h@T@SDLImageType">SDLImageType</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/SDLImageField.html b/docs/Classes/SDLImageField.html index cd4c8a590..16b195f41 100644 --- a/docs/Classes/SDLImageField.html +++ b/docs/Classes/SDLImageField.html @@ -3,8 +3,6 @@ <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-name">name</a></li> <li><a href="#section-imageTypeSupported">imageTypeSupported</a></li> <li><a href="#section-imageResolution">imageResolution</a></li> @@ -16,28 +14,6 @@ <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-name"> name </h3> diff --git a/docs/Classes/SDLImageFieldName.html b/docs/Classes/SDLImageFieldName.html deleted file mode 100644 index c41c06c35..000000000 --- a/docs/Classes/SDLImageFieldName.html +++ /dev/null @@ -1,290 +0,0 @@ -<h1>SDLImageFieldName 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-+softButtonImage">+softButtonImage</a></li> - <li><a href="#section-+choiceImage">+choiceImage</a></li> - <li><a href="#section-+choiceSecondaryImage">+choiceSecondaryImage</a></li> - <li><a href="#section-+vrHelpItem">+vrHelpItem</a></li> - <li><a href="#section-+turnIcon">+turnIcon</a></li> - <li><a href="#section-+menuIcon">+menuIcon</a></li> - <li><a href="#section-+cmdIcon">+cmdIcon</a></li> - <li><a href="#section-+appIcon">+appIcon</a></li> - <li><a href="#section-+graphic">+graphic</a></li> - <li><a href="#section-+showConstantTBTIcon">+showConstantTBTIcon</a></li> - <li><a href="#section-+showConstantTBTNextTurnIcon">+showConstantTBTNextTurnIcon</a></li> - <li><a href="#section-+locationImage">+locationImage</a></li> -</ul> - -<h3>Overview</h3> - -<p>The name that identifies the filed. - * - * - * @since SmartDeviceLink 3.0 - *</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+softButtonImage"> - +softButtonImage - </h3> - - <p>The image field for SoftButton - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">softButtonImage</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">softButtonImage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+choiceImage"> - +choiceImage - </h3> - - <p>The first image field for Choice. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">choiceImage</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">choiceImage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+choiceSecondaryImage"> - +choiceSecondaryImage - </h3> - - <p>The scondary image field for Choice. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">choiceSecondaryImage</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">choiceSecondaryImage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+vrHelpItem"> - +vrHelpItem - </h3> - - <p>The image field for vrHelpItem. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">vrHelpItem</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">vrHelpItem</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+turnIcon"> - +turnIcon - </h3> - - <p>The image field for Turn. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">turnIcon</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">turnIcon</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+menuIcon"> - +menuIcon - </h3> - - <p>The image field for the menu icon in SetGlobalProperties. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">menuIcon</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">menuIcon</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+cmdIcon"> - +cmdIcon - </h3> - - <p>The image filed for AddCommand. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">cmdIcon</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">cmdIcon</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+appIcon"> - +appIcon - </h3> - - <p>The iamage field for the app icon ( set by setAppIcon). - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">appIcon</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">appIcon</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+graphic"> - +graphic - </h3> - - <p>The image filed for Show. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">graphic</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">graphic</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+showConstantTBTIcon"> - +showConstantTBTIcon - </h3> - - <p>The primary image field for ShowConstant TBT. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">showConstantTBTIcon</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">showConstantTBTIcon</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+showConstantTBTNextTurnIcon"> - +showConstantTBTNextTurnIcon - </h3> - - <p>The secondary image field for ShowConstant TBT. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">showConstantTBTNextTurnIcon</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">showConstantTBTNextTurnIcon</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+locationImage"> - +locationImage - </h3> - - <p>The optional image of a destination / location -@since SDL 4.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">locationImage</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">locationImage</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageFieldName</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLImageResolution.html b/docs/Classes/SDLImageResolution.html index 562d3118c..014351d2c 100644 --- a/docs/Classes/SDLImageResolution.html +++ b/docs/Classes/SDLImageResolution.html @@ -3,10 +3,9 @@ <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-resolutionWidth">resolutionWidth</a></li> <li><a href="#section-resolutionHeight">resolutionHeight</a></li> + <li><a href="#section--initWithWidth:height:">-initWithWidth:height:</a></li> </ul> <h3>Overview</h3> @@ -15,19 +14,8 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: + <h3 id="section-resolutionWidth"> + resolutionWidth </h3> <p>Undocumented</p> @@ -37,8 +25,8 @@ - <h3 id="section-resolutionWidth"> - resolutionWidth + <h3 id="section-resolutionHeight"> + resolutionHeight </h3> <p>Undocumented</p> @@ -48,8 +36,8 @@ - <h3 id="section-resolutionHeight"> - resolutionHeight + <h3 id="section--initWithWidth:height:"> + -initWithWidth:height: </h3> <p>Undocumented</p> diff --git a/docs/Classes/SDLImageType.html b/docs/Classes/SDLImageType.html deleted file mode 100644 index f66196979..000000000 --- a/docs/Classes/SDLImageType.html +++ /dev/null @@ -1,124 +0,0 @@ -<h1>SDLImageType 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-+STATIC">+STATIC</a></li> - <li><a href="#section-+DYNAMIC">+DYNAMIC</a></li> -</ul> - -<h3>Overview</h3> - -<p>Contains information about the type of image.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract return SDLImageType (STATIC / DYNAMIC)</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageType</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">SDLImageType</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>An SDLImageType</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract store all possible SDLImageType 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 with all possible SDLImageType values inside</p> - - </div> - - <h3 id="section-+STATIC"> - +STATIC - </h3> - - <p>@abstract Just the static hex icon value to be used</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageType</span> <span class="o">*</span><span class="p">)</span><span class="n">STATIC</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="err">`</span><span class="kd">static</span><span class="err">`</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The Image Type with value <em>STATIC</em></p> - - </div> - - <h3 id="section-+DYNAMIC"> - +DYNAMIC - </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> - -</div> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLImageType</span> <span class="o">*</span><span class="p">)</span><span class="n">DYNAMIC</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">dynamic</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLImageType</span><span class="o">!</span></code></pre> - - - - <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 deleted file mode 100644 index e3e3b7c9f..000000000 --- a/docs/Classes/SDLInteractionMode.html +++ /dev/null @@ -1,152 +0,0 @@ -<h1>SDLInteractionMode 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-+MANUAL_ONLY">+MANUAL_ONLY</a></li> - <li><a href="#section-+VR_ONLY">+VR_ONLY</a></li> - <li><a href="#section-+BOTH">+BOTH</a></li> -</ul> - -<h3>Overview</h3> - -<p>For application-initiated interactions (SDLPerformInteraction), this specifies the mode by which the user is prompted and by which the user’s selection is indicated</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract SDLInteractionMode -- parameter: value The value of the string to get an object for -- returns: SDLInteractionMode</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLInteractionMode</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">SDLInteractionMode</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>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> - - - - <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 with all possible SDLInteractionMode values inside</p> - - </div> - - <h3 id="section-+MANUAL_ONLY"> - +MANUAL_ONLY - </h3> - - <p>@abstract Interaction Mode : Manual Only - @discussion This mode causes the interaction to occur only on the display, meaning the choices are presented and selected only via the display. Selections are viewed with the SEEKRIGHT, SEEKLEFT, TUNEUP, TUNEDOWN buttons. User’s selection is indicated with the OK button</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLInteractionMode</span> <span class="o">*</span><span class="p">)</span><span class="n">MANUAL_ONLY</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">manual_ONLY</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLInteractionMode</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>Current Interaction Mode with value of <em>MANUAL_ONLY</em></p> - - </div> - - <h3 id="section-+VR_ONLY"> - +VR_ONLY - </h3> - - <p>@abstract Interaction Mode : VR Only - @discussion This mode causes the interaction to occur only through TTS and VR. The user is prompted via TTS to select a choice by saying one of the choice’s synonyms</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLInteractionMode</span> <span class="o">*</span><span class="p">)</span><span class="n">VR_ONLY</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">vr_ONLY</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLInteractionMode</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>Current Interaction Mode with value of <em>VR_ONLY</em></p> - - </div> - - <h3 id="section-+BOTH"> - +BOTH - </h3> - - <p>@abstract Interaction Mode : Manual & VR - @discussion This mode is a combination of MANUAL_ONLY and VR_ONLY, meaning the user is prompted both visually and audibly. The user can make a selection either using the mode described in MANUAL_ONLY or using the mode described in VR_ONLY. </p> - -<p>If the user views selections as described in MANUAL_ONLY mode, the interaction becomes strictly, and irreversibly, a MANUAL_ONLY interaction (i.e. the VR session is cancelled, although the interaction itself is still in progress). If the user interacts with the VR session in any way (e.g. speaks a phrase, even if it is not a recognized choice), the interaction becomes strictly, and irreversibly, a VR_ONLY interaction (i.e. the MANUAL_ONLY mode forms of interaction will no longer be honored)</p> - -<p>The TriggerSource parameter of the <em>PerformInteraction</em> response will indicate which interaction mode the user finally chose to attempt the selection (even if the interaction did not end with a selection being made)</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLInteractionMode</span> <span class="o">*</span><span class="p">)</span><span class="n">BOTH</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">both</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLInteractionMode</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>Current Interaction Mode with value of <em>BOTH</em></p> - - </div> - -</section> diff --git a/docs/Classes/SDLJingle.html b/docs/Classes/SDLJingle.html deleted file mode 100644 index ea0167002..000000000 --- a/docs/Classes/SDLJingle.html +++ /dev/null @@ -1,74 +0,0 @@ -<h1>SDLJingle Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+NEGATIVE_JINGLE">+NEGATIVE_JINGLE</a></li> - <li><a href="#section-+POSITIVE_JINGLE">+POSITIVE_JINGLE</a></li> - <li><a href="#section-+LISTEN_JINGLE">+LISTEN_JINGLE</a></li> - <li><a href="#section-+INITIAL_JINGLE">+INITIAL_JINGLE</a></li> - <li><a href="#section-+HELP_JINGLE">+HELP_JINGLE</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+NEGATIVE_JINGLE"> - +NEGATIVE_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+POSITIVE_JINGLE"> - +POSITIVE_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+LISTEN_JINGLE"> - +LISTEN_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+INITIAL_JINGLE"> - +INITIAL_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+HELP_JINGLE"> - +HELP_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLKeyboardEvent.html b/docs/Classes/SDLKeyboardEvent.html deleted file mode 100644 index 1ca8cc9e0..000000000 --- a/docs/Classes/SDLKeyboardEvent.html +++ /dev/null @@ -1,148 +0,0 @@ -<h1>SDLKeyboardEvent 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-+KEYPRESS">+KEYPRESS</a></li> - <li><a href="#section-+ENTRY_SUBMITTED">+ENTRY_SUBMITTED</a></li> - <li><a href="#section-+ENTRY_CANCELLED">+ENTRY_CANCELLED</a></li> - <li><a href="#section-+ENTRY_ABORTED">+ENTRY_ABORTED</a></li> - <li><a href="#section-+ENTRY_VOICE">+ENTRY_VOICE</a></li> -</ul> - -<h3>Overview</h3> - -<p>Enumeration listing possible keyboard events. - * - * @since SmartDeviceLink 3.0 - *</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+KEYPRESS"> - +KEYPRESS - </h3> - - <p>The use has pressed the keyboard key (applies to both SINGLE_KEYPRESS and RESEND_CURRENT_ENTRY modes). - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">KEYPRESS</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">keypress</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ENTRY_SUBMITTED"> - +ENTRY_SUBMITTED - </h3> - - <p>The User has finished entering text from the keyboard and submitted the entry. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">ENTRY_SUBMITTED</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">entry_SUBMITTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ENTRY_CANCELLED"> - +ENTRY_CANCELLED - </h3> - - <p>The User has pressed the HMI-defined <q>Cancel</q> button. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">ENTRY_CANCELLED</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">entry_CANCELLED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ENTRY_ABORTED"> - +ENTRY_ABORTED - </h3> - - <p>The User has not finished entering text and the keyboard is aborted with the event of higher priority. - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">ENTRY_ABORTED</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">entry_ABORTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ENTRY_VOICE"> - +ENTRY_VOICE - </h3> - - <p>@since SDL 4.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardEvent</span> <span class="o">*</span><span class="p">)</span><span class="n">ENTRY_VOICE</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">entry_VOICE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardEvent</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLKeyboardLayout.html b/docs/Classes/SDLKeyboardLayout.html deleted file mode 100644 index 8f939e873..000000000 --- a/docs/Classes/SDLKeyboardLayout.html +++ /dev/null @@ -1,109 +0,0 @@ -<h1>SDLKeyboardLayout 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-+QWERTY">+QWERTY</a></li> - <li><a href="#section-+QWERTZ">+QWERTZ</a></li> - <li><a href="#section-+AZERTY">+AZERTY</a></li> -</ul> - -<h3>Overview</h3> - -<p>Enumeration listing possible keyboard layouts - * - *<b>Since</b> SmartDeviceLink 3.0 - *</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+QWERTY"> - +QWERTY - </h3> - - <p>QWERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardLayout</span> <span class="o">*</span><span class="p">)</span><span class="n">QWERTY</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">qwerty</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardLayout</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+QWERTZ"> - +QWERTZ - </h3> - - <p>QWERTZ layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardLayout</span> <span class="o">*</span><span class="p">)</span><span class="n">QWERTZ</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">qwertz</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardLayout</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+AZERTY"> - +AZERTY - </h3> - - <p>AZERTY layout (the name comes from the first six keys<br> appearing on the top left letter row of the keyboard and read from left to right) - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeyboardLayout</span> <span class="o">*</span><span class="p">)</span><span class="n">AZERTY</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">azerty</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeyboardLayout</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLKeyboardProperties.html b/docs/Classes/SDLKeyboardProperties.html index 57c4f7cd0..20b5aa55d 100644 --- a/docs/Classes/SDLKeyboardProperties.html +++ b/docs/Classes/SDLKeyboardProperties.html @@ -3,8 +3,6 @@ <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--initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText:">-initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText:</a></li> <li><a href="#section-language">language</a></li> <li><a href="#section-keyboardLayout">keyboardLayout</a></li> @@ -19,28 +17,6 @@ <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--initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText:"> -initWithLanguage:layout:keypressMode:limitedCharacterList:autoCompleteText: </h3> diff --git a/docs/Classes/SDLKeypressMode.html b/docs/Classes/SDLKeypressMode.html deleted file mode 100644 index 615484c04..000000000 --- a/docs/Classes/SDLKeypressMode.html +++ /dev/null @@ -1,111 +0,0 @@ -<h1>SDLKeypressMode 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-+SINGLE_KEYPRESS">+SINGLE_KEYPRESS</a></li> - <li><a href="#section-+QUEUE_KEYPRESSES">+QUEUE_KEYPRESSES</a></li> - <li><a href="#section-+RESEND_CURRENT_ENTRY">+RESEND_CURRENT_ENTRY</a></li> -</ul> - -<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> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+SINGLE_KEYPRESS"> - +SINGLE_KEYPRESS - </h3> - - <p>SINGLE_KEYPRESS:<br>Each and every User`s keypress must be reported (new notification for every newly entered single symbol). - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeypressMode</span> <span class="o">*</span><span class="p">)</span><span class="n">SINGLE_KEYPRESS</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">single_KEYPRESS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeypressMode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+QUEUE_KEYPRESSES"> - +QUEUE_KEYPRESSES - </h3> - - <p>QUEUE_KEYPRESSES:<br>The whole entry is reported only after the User submits it (by ‘Search’ button click displayed on touchscreen keyboard) - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeypressMode</span> <span class="o">*</span><span class="p">)</span><span class="n">QUEUE_KEYPRESSES</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">queue_KEYPRESSES</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeypressMode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+RESEND_CURRENT_ENTRY"> - +RESEND_CURRENT_ENTRY - </h3> - - <p>RESEND_CURRENT_ENTRY:<br>The whole entry must be reported each and every time the User makes a new keypress<br> (new notification with all previously entered symbols and a newly entered one appended). - *</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLKeypressMode</span> <span class="o">*</span><span class="p">)</span><span class="n">RESEND_CURRENT_ENTRY</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">resend_CURRENT_ENTRY</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLKeypressMode</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLLanguage.html b/docs/Classes/SDLLanguage.html deleted file mode 100644 index b478166e5..000000000 --- a/docs/Classes/SDLLanguage.html +++ /dev/null @@ -1,523 +0,0 @@ -<h1>SDLLanguage 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-+EN_US">+EN_US</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> - <li><a href="#section-+ES_ES">+ES_ES</a></li> - <li><a href="#section-+EN_GB">+EN_GB</a></li> - <li><a href="#section-+RU_RU">+RU_RU</a></li> - <li><a href="#section-+TR_TR">+TR_TR</a></li> - <li><a href="#section-+PL_PL">+PL_PL</a></li> - <li><a href="#section-+FR_FR">+FR_FR</a></li> - <li><a href="#section-+IT_IT">+IT_IT</a></li> - <li><a href="#section-+SV_SE">+SV_SE</a></li> - <li><a href="#section-+PT_PT">+PT_PT</a></li> - <li><a href="#section-+NL_NL">+NL_NL</a></li> - <li><a href="#section-+EN_AU">+EN_AU</a></li> - <li><a href="#section-+ZH_CN">+ZH_CN</a></li> - <li><a href="#section-+ZH_TW">+ZH_TW</a></li> - <li><a href="#section-+JA_JP">+JA_JP</a></li> - <li><a href="#section-+AR_SA">+AR_SA</a></li> - <li><a href="#section-+KO_KR">+KO_KR</a></li> - <li><a href="#section-+PT_BR">+PT_BR</a></li> - <li><a href="#section-+CS_CZ">+CS_CZ</a></li> - <li><a href="#section-+DA_DK">+DA_DK</a></li> - <li><a href="#section-+NO_NO">+NO_NO</a></li> -</ul> - -<h3>Overview</h3> - -<p>Specifies the language to be used for TTS, VR, displayed messages/menus</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Get a Langusge according to a String</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</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">SDLLanguage</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>The Language</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract store all possible Language 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 with all possible Language values inside</p> - - </div> - - <h3 id="section-+EN_US"> - +EN_US - </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">SDLEnum</span></code></pre> - - - - - - <h3 id="section-+ES_MX"> - +ES_MX - </h3> - - <p>@abstract Spanish - Mexico</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">ES_MX</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">es_MX</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+FR_CA"> - +FR_CA - </h3> - - <p>@abstract French - Canada</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">FR_CA</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">fr_CA</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+DE_DE"> - +DE_DE - </h3> - - <p>@abstract German - Germany</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">DE_DE</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">de_DE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ES_ES"> - +ES_ES - </h3> - - <p>@abstract Spanish - Spain</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">ES_ES</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">es_ES</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+EN_GB"> - +EN_GB - </h3> - - <p>@abstract English - Great Britain</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">EN_GB</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">en_GB</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+RU_RU"> - +RU_RU - </h3> - - <p>@abstract Russian - Russia</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">RU_RU</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">ru_RU</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+TR_TR"> - +TR_TR - </h3> - - <p>@abstract Turkish - Turkey</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">TR_TR</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">tr_TR</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+PL_PL"> - +PL_PL - </h3> - - <p>@abstract Polish - Poland</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">PL_PL</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">pl_PL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+FR_FR"> - +FR_FR - </h3> - - <p>@abstract French - France</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">FR_FR</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">fr_FR</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+IT_IT"> - +IT_IT - </h3> - - <p>@abstract Italian - Italy</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">IT_IT</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">it_IT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+SV_SE"> - +SV_SE - </h3> - - <p>@abstract Swedish - Sweden</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">SV_SE</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">sv_SE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+PT_PT"> - +PT_PT - </h3> - - <p>@abstract Portuguese - Portugal</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">PT_PT</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">pt_PT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+NL_NL"> - +NL_NL - </h3> - - <p>@abstract Dutch (Standard) - Netherlands</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">NL_NL</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">nl_NL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+EN_AU"> - +EN_AU - </h3> - - <p>@abstract English - Australia</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">EN_AU</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">en_AU</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ZH_CN"> - +ZH_CN - </h3> - - <p>@abstract Mandarin - China</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">ZH_CN</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">zh_CN</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ZH_TW"> - +ZH_TW - </h3> - - <p>@abstract Mandarin - Taiwan</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">ZH_TW</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">zh_TW</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+JA_JP"> - +JA_JP - </h3> - - <p>@abstract Japanese - Japan</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">JA_JP</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">ja_JP</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+AR_SA"> - +AR_SA - </h3> - - <p>@abstract Arabic - Saudi Arabia</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">AR_SA</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">ar_SA</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+KO_KR"> - +KO_KR - </h3> - - <p>@abstract Korean - South Korea</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">KO_KR</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">ko_KR</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+PT_BR"> - +PT_BR - </h3> - - <p>@abstract Portuguese - Brazil</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">PT_BR</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">pt_BR</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+CS_CZ"> - +CS_CZ - </h3> - - <p>@abstract Czech - Czech Republic</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">CS_CZ</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">cs_CZ</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+DA_DK"> - +DA_DK - </h3> - - <p>@abstract Danish - Denmark</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">DA_DK</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">da_DK</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+NO_NO"> - +NO_NO - </h3> - - <p>@abstract Norwegian - Norway</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLanguage</span> <span class="o">*</span><span class="p">)</span><span class="n">NO_NO</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">no_NO</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLanguage</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLLayoutMode.html b/docs/Classes/SDLLayoutMode.html deleted file mode 100644 index ddc0311d1..000000000 --- a/docs/Classes/SDLLayoutMode.html +++ /dev/null @@ -1,143 +0,0 @@ -<h1>SDLLayoutMode 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-+ICON_ONLY">+ICON_ONLY</a></li> - <li><a href="#section-+ICON_WITH_SEARCH">+ICON_WITH_SEARCH</a></li> - <li><a href="#section-+LIST_ONLY">+LIST_ONLY</a></li> - <li><a href="#section-+LIST_WITH_SEARCH">+LIST_WITH_SEARCH</a></li> - <li><a href="#section-+KEYBOARD">+KEYBOARD</a></li> -</ul> - -<h3>Overview</h3> - -<p>For touchscreen interactions, the mode of how the choices are presented.</p> - -<p>@since SDL 3.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+ICON_ONLY"> - +ICON_ONLY - </h3> - - <p>This mode causes the interaction to display the previous set of choices as icons.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLayoutMode</span> <span class="o">*</span><span class="p">)</span><span class="n">ICON_ONLY</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">icon_ONLY</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLayoutMode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ICON_WITH_SEARCH"> - +ICON_WITH_SEARCH - </h3> - - <p>This mode causes the interaction to display the previous set of choices as icons along with a search field in the HMI.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLayoutMode</span> <span class="o">*</span><span class="p">)</span><span class="n">ICON_WITH_SEARCH</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">icon_WITH_SEARCH</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLayoutMode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+LIST_ONLY"> - +LIST_ONLY - </h3> - - <p>This mode causes the interaction to display the previous set of choices as a list.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLayoutMode</span> <span class="o">*</span><span class="p">)</span><span class="n">LIST_ONLY</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">list_ONLY</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLayoutMode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+LIST_WITH_SEARCH"> - +LIST_WITH_SEARCH - </h3> - - <p>This mode causes the interaction to display the previous set of choices as a list along with a search field in the HMI.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLayoutMode</span> <span class="o">*</span><span class="p">)</span><span class="n">LIST_WITH_SEARCH</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">list_WITH_SEARCH</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLayoutMode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+KEYBOARD"> - +KEYBOARD - </h3> - - <p>This mode causes the interaction to immediately display a keyboard entry through the HMI.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLayoutMode</span> <span class="o">*</span><span class="p">)</span><span class="n">KEYBOARD</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">keyboard</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLayoutMode</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLLifecycleConfiguration.html b/docs/Classes/SDLLifecycleConfiguration.html index dd5713f27..85fe3b465 100644 --- a/docs/Classes/SDLLifecycleConfiguration.html +++ b/docs/Classes/SDLLifecycleConfiguration.html @@ -20,8 +20,6 @@ <li><a href="#section-shortAppName">shortAppName</a></li> <li><a href="#section-ttsName">ttsName</a></li> <li><a href="#section-voiceRecognitionCommandNames">voiceRecognitionCommandNames</a></li> - <li><a href="#section-securityManagers">securityManagers</a></li> - <li><a href="#section-logFlags">logFlags</a></li> </ul> <h3>Overview</h3> @@ -60,23 +58,20 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">defaultConfiguration</span><span class="p">(</span><span class="n">withAppName</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLLifecycleConfiguration</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> <h4>Parameters</h4> <dl> <dt>appName</dt> - <dd><p>The name of the app.</p> -</dd> + <dd><p>The name of the app.</p></dd> <dt>appId</dt> - <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p> -</dd> + <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p></dd> </dl> <div> <h4>Return Value</h4> <p>The lifecycle configuration</p> - </div> <h3 id="section-+debugConfigurationWithAppName:appId:ipAddress:port:"> @@ -96,29 +91,24 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">debugConfiguration</span><span class="p">(</span><span class="n">withAppName</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">ipAddress</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">,</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">Any</span><span class="o">!</span><span class="p">)</span> <span class="o">-></span> <span class="kt">SDLLifecycleConfiguration</span><span class="o">!</span></code></pre> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">ipAddress</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">port</span><span class="p">:</span> <span class="kt">UInt16</span><span class="p">)</span></code></pre> <h4>Parameters</h4> <dl> <dt>appName</dt> - <dd><p>The name of the app.</p> -</dd> + <dd><p>The name of the app.</p></dd> <dt>appId</dt> - <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p> -</dd> + <dd><p>The appId to be used. This should be registered with the radio’s manufacturer.</p></dd> <dt>ipAddress</dt> - <dd><p>The ip address of the server to connect to</p> -</dd> + <dd><p>The ip address of the server to connect to</p></dd> <dt>port</dt> - <dd><p>The port of the server to connect to</p> -</dd> + <dd><p>The port of the server to connect to</p></dd> </dl> <div> <h4>Return Value</h4> <p>The lifecycle configuration</p> - </div> <h3 id="section-tcpDebugMode"> @@ -134,7 +124,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugMode</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugMode</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -152,6 +142,9 @@ <span class="n">NSString</span> <span class="o">*</span><span class="n">tcpDebugIPAddress</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugIPAddress</span><span class="p">:</span> <span class="kt">String</span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -168,7 +161,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugPort</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tcpDebugPort</span><span class="p">:</span> <span class="kt">UInt16</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -185,6 +178,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appName</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">appName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -200,6 +196,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">appId</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">appId</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + @@ -215,6 +214,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">resumeHash</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">resumeHash</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -231,7 +233,7 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">isMedia</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isMedia</span><span class="p">:</span> <span class="kt">Bool</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -245,11 +247,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">null_resettable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAppHMIType.html">SDLAppHMIType</a></span> <span class="o">*</span><span class="n">appType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">null_resettable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span> <span class="n">appType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">appType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAppHMIType.html">SDLAppHMIType</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">appType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -263,11 +265,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">language</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">_Nonnull</span> <span class="n">language</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -282,9 +284,12 @@ <h4>Objective-C</h4> <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> - <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">languagesSupported</span><span class="p">;</span></code></pre> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">languagesSupported</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">languagesSupported</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -318,6 +323,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">shortAppName</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">shortAppName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -333,6 +341,9 @@ <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">ttsName</span><span class="p">;</span></code></pre> + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ttsName</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTTSChunk.html">SDLTTSChunk</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + @@ -349,39 +360,8 @@ <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">voiceRecognitionCommandNames</span><span class="p">;</span></code></pre> - - - - <h3 id="section-securityManagers"> - securityManagers - </h3> - - <p>Set security managers which could be used. This is primarily used with video streaming applications to authenticate and perhaps encrypt traffic data.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> - <span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">>></span> <span class="o">*</span><span class="n">securityManagers</span><span class="p">;</span></code></pre> - - - - - - <h3 id="section-logFlags"> - logFlags - </h3> - - <p>Which logging capabilities are currently enabled. The default is Console logging only.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogOutput.html">SDLLogOutput</a></span> <span class="n">logFlags</span><span class="p">;</span></code></pre> - - <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">logFlags</span><span class="p">:</span> <span class="kt">Int32</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">voiceRecognitionCommandNames</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> diff --git a/docs/Classes/SDLListFiles.html b/docs/Classes/SDLListFiles.html deleted file mode 100644 index 1d77efcae..000000000 --- a/docs/Classes/SDLListFiles.html +++ /dev/null @@ -1,63 +0,0 @@ -<h1>SDLListFiles 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>Requests the current list of resident filenames for the registered app. Not - supported on First generation SDL vehicles - <p></p> - -<p>Since <b>SmartDeviceLink 2.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLListFiles 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 SDLListFiles object indicated by the dictionary parameter - <p></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> - -</section> diff --git a/docs/Classes/SDLListFilesResponse.html b/docs/Classes/SDLListFilesResponse.html index c9fefa8f1..44fdfd143 100644 --- a/docs/Classes/SDLListFilesResponse.html +++ b/docs/Classes/SDLListFilesResponse.html @@ -3,8 +3,6 @@ <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-filenames">filenames</a></li> <li><a href="#section-spaceAvailable">spaceAvailable</a></li> </ul> @@ -17,36 +15,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - <h3 id="section-filenames"> filenames </h3> @@ -56,7 +24,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 +39,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/SDLLocationCoordinate.html b/docs/Classes/SDLLocationCoordinate.html index 3b4560f1f..f55bbc59a 100644 --- a/docs/Classes/SDLLocationCoordinate.html +++ b/docs/Classes/SDLLocationCoordinate.html @@ -24,11 +24,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">latitudeDegrees</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">latitudeDegrees</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">latitudeDegrees</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">latitudeDegrees</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -44,11 +45,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">longitudeDegrees</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">longitudeDegrees</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">longitudeDegrees</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">longitudeDegrees</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLLocationDetails.html b/docs/Classes/SDLLocationDetails.html index 7107c4743..3cc7369b1 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 @@ -35,11 +34,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLLocationCoordinate.html">SDLLocationCoordinate</a></span> <span class="o">*</span><span class="n">coordinate</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLLocationCoordinate.html">SDLLocationCoordinate</a></span> <span class="o">*</span><span class="n">coordinate</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">coordinate</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLocationCoordinate.html">SDLLocationCoordinate</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">coordinate</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLocationCoordinate.html">SDLLocationCoordinate</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> @@ -55,11 +55,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locationName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locationName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationName</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> @@ -75,11 +75,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">addressLines</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">addressLines</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">addressLines</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]</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">addressLines</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> @@ -95,11 +96,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locationDescription</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locationDescription</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationDescription</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationDescription</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> @@ -115,11 +116,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">phoneNumber</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">phoneNumber</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">phoneNumber</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">phoneNumber</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> @@ -129,7 +130,6 @@ </h3> <p>@abstract Image / icon of intended location.</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLImage @@ -141,11 +141,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">locationImage</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">locationImage</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationImage</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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">locationImage</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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> @@ -155,7 +155,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 @@ -167,11 +166,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="n">searchAddress</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="n">searchAddress</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">searchAddress</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</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">searchAddress</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</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> 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/SDLLockScreenStatus.html b/docs/Classes/SDLLockScreenStatus.html deleted file mode 100644 index 13353a8d6..000000000 --- a/docs/Classes/SDLLockScreenStatus.html +++ /dev/null @@ -1,95 +0,0 @@ -<h1>SDLLockScreenStatus 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-+OFF">+OFF</a></li> - <li><a href="#section-+OPTIONAL">+OPTIONAL</a></li> - <li><a href="#section-+REQUIRED">+REQUIRED</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+OFF"> - +OFF - </h3> - - <p>LockScreen is Not Required</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLockScreenStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">OFF</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">off</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLockScreenStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+OPTIONAL"> - +OPTIONAL - </h3> - - <p>LockScreen is Optional</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLockScreenStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">OPTIONAL</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">optional</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLockScreenStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+REQUIRED"> - +REQUIRED - </h3> - - <p>LockScreen is Not Required</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLLockScreenStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">REQUIRED</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">required</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLLockScreenStatus</span><span class="o">!</span></code></pre> - - - - -</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/SDLLogConfiguration.html b/docs/Classes/SDLLogConfiguration.html new file mode 100644 index 000000000..ba89b0ee2 --- /dev/null +++ b/docs/Classes/SDLLogConfiguration.html @@ -0,0 +1,197 @@ +<h1>SDLLogConfiguration Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-modules">modules</a></li> + <li><a href="#section-targets">targets</a></li> + <li><a href="#section-filters">filters</a></li> + <li><a href="#section-formatType">formatType</a></li> + <li><a href="#section-asynchronous">asynchronous</a></li> + <li><a href="#section-errorsAsynchronous">errorsAsynchronous</a></li> + <li><a href="#section-globalLogLevel">globalLogLevel</a></li> + <li><a href="#section-+defaultConfiguration">+defaultConfiguration</a></li> + <li><a href="#section-+debugConfiguration">+debugConfiguration</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-modules"> + modules + </h3> + + <p>Any custom logging modules used by the developer’s code. Defaults to none.</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">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFileModule.html">SDLLogFileModule</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">modules</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">modules</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + + <h3 id="section-targets"> + targets + </h3> + + <p>Where the logs will attempt to output. Defaults to Console.</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">NSSet</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLLogTarget.html">SDLLogTarget</a></span><span class="o">>></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">targets</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">targets</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + + <h3 id="section-filters"> + filters + </h3> + + <p>What log filters will run over this session. Defaults to none.</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">NSSet</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLogFilter.html">SDLLogFilter</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">filters</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">filters</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + + <h3 id="section-formatType"> + formatType + </h3> + + <p>How detailed of logs will be output. Defaults to Default.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogFormatType.html">SDLLogFormatType</a></span> <span class="n">formatType</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">formatType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogFormatType.html">SDLLogFormatType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-asynchronous"> + asynchronous + </h3> + + <p>Whether or not logs will be run on a separate queue, asynchronously, allowing the following code to run before the log completes. Or if it will occur synchronously, which will prevent logs from being missed, but will slow down surrounding code. Defaults to YES.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">getter</span><span class="o">=</span><span class="n">isAsynchronous</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">asynchronous</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isAsynchronous</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> + + + + + <h3 id="section-errorsAsynchronous"> + errorsAsynchronous + </h3> + + <p>Whether or not error logs will be dispatched to loggers asynchronously. Defaults to NO.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">getter</span><span class="o">=</span><span class="n">areErrorsAsynchronous</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">errorsAsynchronous</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">areErrorsAsynchronous</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> + + + + + <h3 id="section-globalLogLevel"> + globalLogLevel + </h3> + + <p>Any modules that do not have an explicitly specified level will by default use the global log level. Defaults to Error. +Do not specify Default for this parameter.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="n">globalLogLevel</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">globalLogLevel</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-+defaultConfiguration"> + +defaultConfiguration + </h3> + + <p>A default logger for production. This sets the format type to Default, the log level to Error, and only enables the ASL logger.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">defaultConfiguration</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="err">`</span><span class="k">default</span><span class="err">`</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A default configuration that may be customized.</p> + </div> + + <h3 id="section-+debugConfiguration"> + +debugConfiguration + </h3> + + <p>A debug logger for use in development. This sets the format type to Detailed, the log level to Debug, and enables the Console and ASL loggers.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">debugConfiguration</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">debug</span><span class="p">()</span> <span class="o">-></span> <span class="k">Self</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>A debug configuration that may be customized.</p> + </div> + +</section> diff --git a/docs/Classes/SDLLogFileModule.html b/docs/Classes/SDLLogFileModule.html new file mode 100644 index 000000000..cfb960466 --- /dev/null +++ b/docs/Classes/SDLLogFileModule.html @@ -0,0 +1,212 @@ +<h1>SDLLogFileModule Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-name">name</a></li> + <li><a href="#section-files">files</a></li> + <li><a href="#section-logLevel">logLevel</a></li> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithName:files:level:">-initWithName:files:level:</a></li> + <li><a href="#section--initWithName:files:">-initWithName:files:</a></li> + <li><a href="#section-+moduleWithName:files:">+moduleWithName:files:</a></li> + <li><a href="#section--containsFile:">-containsFile:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-name"> + name + </h3> + + <p>The name of the this module, e.g. <q>Transport</q></p> + + + + <h4>Objective-C</h4> + <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">name</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">name</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> + + + + + <h3 id="section-files"> + files + </h3> + + <p>All of the files contained within this module. When a log is logged, the <code>__FILE__</code> (in Obj-C) or <code>#file</code> (in Swift) is automatically captured and checked to see if any module has a file in this set that matches. If it does, it will be logged using the module’s log level and the module’s name will be printed in the formatted log.</p> + + + + <h4>Objective-C</h4> + <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">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">files</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">files</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + + <h3 id="section-logLevel"> + logLevel + </h3> + + <p>The custom level of the log. This is <code>SDLLogLevelDefault</code> (whatever the current global log level is) by default.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="n">logLevel</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">logLevel</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--init"> + -init + </h3> + + <p>This method is unavailable and may not be used.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> + + + + + <div> + <h4>Return Value</h4> + <p>Always returns nil</p> + </div> + + <h3 id="section--initWithName:files:level:"> + -initWithName:files:level: + </h3> + + <p>Returns an initialized <code>SDLLogFileModule</code> that contains a custom name, set of files, and associated log level.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <span class="nf">files</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">files</span> + <span class="nf">level</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span><span class="p">)</span><span class="nv">level</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</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">files</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The name of this module. This will be used when printing a formatted log for a file within this module e.g. <q>Transport</q>.</p></dd> + <dt>files</dt> + <dd><p>The files this module covers. This should correspond to a <code>__FILE__</code> or <code>#file</code> call for use when comparing a log to this module. Any log originating in a file contained in this set will then use this module’s log level and print the module name.</p></dd> + <dt>level</dt> + <dd><p>The custom logging level logs originating in files contained in this log module will use. For example, if the global level is <code>SDLLogLevelError</code> and this module is configured to <code>SDLLogLevelVerbose</code>, all logs originating from files within this module will be logged, not merely error logs.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An initialized <code>SDLLogFileModule</code></p> + </div> + + <h3 id="section--initWithName:files:"> + -initWithName:files: + </h3> + + <p>Returns an initialized <code>SDLLogFileModule</code> that contains a custom name and set of files. The logging level is the same as the current global logging file by using <code>SDLLogLevelDefault</code>.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <span class="nf">files</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">files</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="n">convenience</span> <span class="nf">init</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">files</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The name of this module. This will be used when printing a formatted log for a file within this module e.g. <q>Transport</q>.</p></dd> + <dt>files</dt> + <dd><p>The files this module covers. This should correspond to a <code>__FILE__</code> or <code>#file</code> call for use when comparing a log to this module. Any log originating in a file contained in this set will then use this module’s log level and print the module name.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An initialized <code>SDLLogFileModule</code></p> + </div> + + <h3 id="section-+moduleWithName:files:"> + +moduleWithName:files: + </h3> + + <p>Returns an initialized <code>SDLLogFileModule</code> that contains a custom name and set of files. The logging level is the same as the current global logging file by using <code>SDLLogLevelDefault</code>.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">moduleWithName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> + <span class="nf">files</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">files</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>name</dt> + <dd><p>The name of this module. This will be used when printing a formatted log for a file within this module e.g. <q>Transport</q>.</p></dd> + <dt>files</dt> + <dd><p>The files this module covers. This should correspond to a <code>__FILE__</code> or <code>#file</code> call for use when comparing a log to this module. Any log originating in a file contained in this set will then use this module’s log level and print the module name.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An initialized <code>SDLLogFileModule</code></p> + </div> + + <h3 id="section--containsFile:"> + -containsFile: + </h3> + + <p>Returns whether or not this module contains a given file.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">containsFile</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">containsFile</span><span class="p">(</span><span class="n">_</span> <span class="nv">fileName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>fileName</dt> + <dd><p>The file name to check</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A BOOL, YES if this module contains the given file.</p> + </div> + +</section> diff --git a/docs/Classes/SDLLogFilter.html b/docs/Classes/SDLLogFilter.html new file mode 100644 index 000000000..ed1301fc7 --- /dev/null +++ b/docs/Classes/SDLLogFilter.html @@ -0,0 +1,302 @@ +<h1>SDLLogFilter Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-filter">filter</a></li> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithCustomFilter:">-initWithCustomFilter:</a></li> + <li><a href="#section-+filterByDisallowingString:caseSensitive:">+filterByDisallowingString:caseSensitive:</a></li> + <li><a href="#section-+filterByAllowingString:caseSensitive:">+filterByAllowingString:caseSensitive:</a></li> + <li><a href="#section-+filterByDisallowingRegex:">+filterByDisallowingRegex:</a></li> + <li><a href="#section-+filterByAllowingRegex:">+filterByAllowingRegex:</a></li> + <li><a href="#section-+filterByDisallowingModules:">+filterByDisallowingModules:</a></li> + <li><a href="#section-+filterByAllowingModules:">+filterByAllowingModules:</a></li> + <li><a href="#section-+filterByDisallowingFileNames:">+filterByDisallowingFileNames:</a></li> + <li><a href="#section-+filterByAllowingFileNames:">+filterByAllowingFileNames:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-filter"> + filter + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section--init"> + -init + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section--initWithCustomFilter:"> + -initWithCustomFilter: + </h3> + + <p>Create a new filter with a custom filter block. The filter block will take a log model and return a BOOL of pass / fail.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithCustomFilter</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLogConstants.h@T@SDLLogFilterBlock">SDLLogFilterBlock</a></span><span class="p">)</span><span class="nv">filter</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="n">customFilter</span> <span class="nv">filter</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLogConstants.h@T@SDLLogFilterBlock">SDLLogFilterBlock</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>filter</dt> + <dd><p>The custom filter to be used</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>An instance of SDLLogFilter</p> + </div> + + <h3 id="section-+filterByDisallowingString:caseSensitive:"> + +filterByDisallowingString:caseSensitive: + </h3> + + <p>Returns a filter that only allows logs not containing the passed string within their message.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogFilter</span> <span class="o">*</span><span class="p">)</span><span class="nf">filterByDisallowingString</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span> + <span class="nf">caseSensitive</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">caseSensitive</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">byDisallowingString</span> <span class="nv">string</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">caseSensitive</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The string, which, if present in the message of the log, will prevent the log from being logged.</p></dd> + <dt>caseSensitive</dt> + <dd><p>Whether or not <code>string</code> should be checked as case sensitive against the log’s message.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A filter that may be passed into the <code>logConfiguration</code>.</p> + </div> + + <h3 id="section-+filterByAllowingString:caseSensitive:"> + +filterByAllowingString:caseSensitive: + </h3> + + <p>Returns a filter that only allows logs containing the passed string within their message.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogFilter</span> <span class="o">*</span><span class="p">)</span><span class="nf">filterByAllowingString</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">string</span> + <span class="nf">caseSensitive</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">caseSensitive</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">byAllowing</span> <span class="nv">string</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">caseSensitive</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>string</dt> + <dd><p>The string, which, if present in the message of the log, will allow the log to be logged.</p></dd> + <dt>caseSensitive</dt> + <dd><p>Whether or not <code>string</code> should be checked as case sensitive against the log’s message.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A filter that may be passed into the <code>logConfiguration</code>.</p> + </div> + + <h3 id="section-+filterByDisallowingRegex:"> + +filterByDisallowingRegex: + </h3> + + <p>Returns a filter that only allows logs not passing the passed regex against their message.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogFilter</span> <span class="o">*</span><span class="p">)</span><span class="nf">filterByDisallowingRegex</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSRegularExpression</span> <span class="o">*</span><span class="p">)</span><span class="nv">regex</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">byDisallowingRegex</span> <span class="nv">regex</span><span class="p">:</span> <span class="kt">NSRegularExpression</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>regex</dt> + <dd><p>The regex, which, if it matches the message of the log, will prevent the log from being logged.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A filter that may be passed into the <code>logConfiguration</code>.</p> + </div> + + <h3 id="section-+filterByAllowingRegex:"> + +filterByAllowingRegex: + </h3> + + <p>Returns a filter that only allows logs passing the passed regex against their message.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogFilter</span> <span class="o">*</span><span class="p">)</span><span class="nf">filterByAllowingRegex</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSRegularExpression</span> <span class="o">*</span><span class="p">)</span><span class="nv">regex</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">byAllowingRegex</span> <span class="nv">regex</span><span class="p">:</span> <span class="kt">NSRegularExpression</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>regex</dt> + <dd><p>The regex, which, if it matches the message of the log, will allow the log to be logged.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A filter that may be passed into the <code>logConfiguration</code>.</p> + </div> + + <h3 id="section-+filterByDisallowingModules:"> + +filterByDisallowingModules: + </h3> + + <p>Returns a filter that only allows logs not within the specified file modules to be logged.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogFilter</span> <span class="o">*</span><span class="p">)</span><span class="nf">filterByDisallowingModules</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">modules</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">byDisallowingModules</span> <span class="nv">modules</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>modules</dt> + <dd><p>A set of module names. If any match, they will not be logged.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A filter that may be passed into the <code>logConfiguration</code>.</p> + </div> + + <h3 id="section-+filterByAllowingModules:"> + +filterByAllowingModules: + </h3> + + <p>Returns a filter that only allows logs of the specified file modules to be logged.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogFilter</span> <span class="o">*</span><span class="p">)</span><span class="nf">filterByAllowingModules</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">modules</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">byAllowingModules</span> <span class="nv">modules</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>modules</dt> + <dd><p>A set of module names. If any match, they will not be logged.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A filter that may be passed into the <code>logConfiguration</code>.</p> + </div> + + <h3 id="section-+filterByDisallowingFileNames:"> + +filterByDisallowingFileNames: + </h3> + + <p>Returns a filter that only allows logs not within the specified files to be logged.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogFilter</span> <span class="o">*</span><span class="p">)</span><span class="nf">filterByDisallowingFileNames</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileNames</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">byDisallowingFileNames</span> <span class="nv">fileNames</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>fileNames</dt> + <dd><p>If a log matches any of the passed files, the log will not be logged.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A filter that may be passed into the <code>logConfiguration</code>.</p> + </div> + + <h3 id="section-+filterByAllowingFileNames:"> + +filterByAllowingFileNames: + </h3> + + <p>Returns a filter that only allows logs within the specified files to be logged.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">SDLLogFilter</span> <span class="o">*</span><span class="p">)</span><span class="nf">filterByAllowingFileNames</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileNames</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="cm">/*not inherited*/</span> <span class="nf">init</span><span class="p">(</span><span class="n">byAllowingFileNames</span> <span class="nv">fileNames</span><span class="p">:</span> <span class="kt">Set</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>fileNames</dt> + <dd><p>If a log matches any of the passed files, the log will be logged.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>A filter that may be passed into the <code>logConfiguration</code>.</p> + </div> + +</section> diff --git a/docs/Classes/SDLLogManager.html b/docs/Classes/SDLLogManager.html new file mode 100644 index 000000000..afdc013e3 --- /dev/null +++ b/docs/Classes/SDLLogManager.html @@ -0,0 +1,471 @@ +<h1>SDLLogManager Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-modules">modules</a></li> + <li><a href="#section-targets">targets</a></li> + <li><a href="#section-filters">filters</a></li> + <li><a href="#section-globalLogLevel">globalLogLevel</a></li> + <li><a href="#section-formatType">formatType</a></li> + <li><a href="#section-asynchronous">asynchronous</a></li> + <li><a href="#section-errorsAsynchronous">errorsAsynchronous</a></li> + <li><a href="#section-dateFormatter">dateFormatter</a></li> + <li><a href="#section-logQueue">logQueue</a></li> + <li><a href="#section-+sharedManager">+sharedManager</a></li> + <li><a href="#section-+setConfiguration:">+setConfiguration:</a></li> + <li><a href="#section--setConfiguration:">-setConfiguration:</a></li> + <li><a href="#section-+logWithLevel:timestamp:file:functionName:line:queue:formatMessage:">+logWithLevel:timestamp:file:functionName:line:queue:formatMessage:</a></li> + <li><a href="#section--logWithLevel:timestamp:file:functionName:line:queue:formatMessage:">-logWithLevel:timestamp:file:functionName:line:queue:formatMessage:</a></li> + <li><a href="#section-+logWithLevel:timestamp:file:functionName:line:queue:message:">+logWithLevel:timestamp:file:functionName:line:queue:message:</a></li> + <li><a href="#section--logWithLevel:timestamp:file:functionName:line:queue:message:">-logWithLevel:timestamp:file:functionName:line:queue:message:</a></li> + <li><a href="#section-+logBytes:direction:timestamp:file:functionName:line:queue:">+logBytes:direction:timestamp:file:functionName:line:queue:</a></li> + <li><a href="#section--logBytes:direction:timestamp:file:functionName:line:queue:">-logBytes:direction:timestamp:file:functionName:line:queue:</a></li> +</ul> + +<h3>Overview</h3> + +<p>This is the central manager of logging. A developer should not have to interact with this class, it is exclusively used internally.</p> + + +<section class="section task-group-section"> + <h3 id="section-modules"> + modules + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + + + + + <h3 id="section-targets"> + targets + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + + + + + <h3 id="section-filters"> + filters + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + + + + + <h3 id="section-globalLogLevel"> + globalLogLevel + </h3> + + <p>Any modules that do not have an explicitly specified level will by default use this log level</p> + + + + <h4>Objective-C</h4> + <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">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="n">globalLogLevel</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">globalLogLevel</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-formatType"> + formatType + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + + + + + <h3 id="section-asynchronous"> + asynchronous + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + + + + + <h3 id="section-errorsAsynchronous"> + errorsAsynchronous + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + + + + + <h3 id="section-dateFormatter"> + dateFormatter + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + + + + + <h3 id="section-logQueue"> + logQueue + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + + + + + <h3 id="section-+sharedManager"> + +sharedManager + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> + + + + + + <h3 id="section-+setConfiguration:"> + +setConfiguration: + </h3> + + <p>Sets a configuration to be used by the log manager’s sharedManager. This is generally for internal use and you should set your configuration using SDLManager’s startWithConfiguration: method.</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">setConfiguration</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">configuration</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">setConfiguration</span><span class="p">(</span><span class="n">_</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>configuration</dt> + <dd><p>The configuration to be used.</p></dd> + </dl> + + <h3 id="section--setConfiguration:"> + -setConfiguration: + </h3> + + <p>Sets a configuration to be used by the log manager. This is generally for internal use and you should set your configuration using SDLManager’s startWithConfiguration: method.</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">setConfiguration</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">configuration</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">setConfiguration</span><span class="p">(</span><span class="n">_</span> <span class="nv">configuration</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>configuration</dt> + <dd><p>The configuration to be used.</p></dd> + </dl> + + <h3 id="section-+logWithLevel:timestamp:file:functionName:line:queue:formatMessage:"> + +logWithLevel:timestamp:file:functionName:line:queue:formatMessage: + </h3> + + <p>Log to the sharedManager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</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">logWithLevel</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span><span class="p">)</span><span class="nv">level</span> + <span class="nf">timestamp</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSDate</span> <span class="o">*</span><span class="p">)</span><span class="nv">timestamp</span> + <span class="nf">file</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">file</span> + <span class="nf">functionName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> + <span class="nf">line</span><span class="p">:(</span><span class="n">NSInteger</span><span class="p">)</span><span class="nv">line</span> + <span class="nf">queue</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">queueLabel</span> + <span class="nf">formatMessage</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">,</span> <span class="p">...;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>level</dt> + <dd><p>The level of the log</p></dd> + <dt>timestamp</dt> + <dd><p>The time the log was sent</p></dd> + <dt>file</dt> + <dd><p>The file the log originated from</p></dd> + <dt>functionName</dt> + <dd><p>The function the log originated from</p></dd> + <dt>line</dt> + <dd><p>The line the log originated from</p></dd> + <dt>queueLabel</dt> + <dd><p>The queue the log was sent from</p></dd> + <dt>message</dt> + <dd><p>The message of the log with a format</p></dd> + </dl> + + <h3 id="section--logWithLevel:timestamp:file:functionName:line:queue:formatMessage:"> + -logWithLevel:timestamp:file:functionName:line:queue:formatMessage: + </h3> + + <p>Log to this log manager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</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">logWithLevel</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span><span class="p">)</span><span class="nv">level</span> + <span class="nf">timestamp</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSDate</span> <span class="o">*</span><span class="p">)</span><span class="nv">timestamp</span> + <span class="nf">file</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">file</span> + <span class="nf">functionName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> + <span class="nf">line</span><span class="p">:(</span><span class="n">NSInteger</span><span class="p">)</span><span class="nv">line</span> + <span class="nf">queue</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">queueLabel</span> + <span class="nf">formatMessage</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">,</span> <span class="p">...;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>level</dt> + <dd><p>The level of the log</p></dd> + <dt>timestamp</dt> + <dd><p>The time the log was sent</p></dd> + <dt>file</dt> + <dd><p>The file the log originated from</p></dd> + <dt>functionName</dt> + <dd><p>The function the log originated from</p></dd> + <dt>line</dt> + <dd><p>The line the log originated from</p></dd> + <dt>queueLabel</dt> + <dd><p>The queue the log was sent from</p></dd> + <dt>message</dt> + <dd><p>The message of the log with a format</p></dd> + </dl> + + <h3 id="section-+logWithLevel:timestamp:file:functionName:line:queue:message:"> + +logWithLevel:timestamp:file:functionName:line:queue:message: + </h3> + + <p>Log to this sharedManager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</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">logWithLevel</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span><span class="p">)</span><span class="nv">level</span> + <span class="nf">timestamp</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSDate</span> <span class="o">*</span><span class="p">)</span><span class="nv">timestamp</span> + <span class="nf">file</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">file</span> + <span class="nf">functionName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> + <span class="nf">line</span><span class="p">:(</span><span class="n">NSInteger</span><span class="p">)</span><span class="nv">line</span> + <span class="nf">queue</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">queueLabel</span> + <span class="nf">message</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">message</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">log</span><span class="p">(</span><span class="n">with</span> <span class="nv">level</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span><span class="p">,</span> <span class="nv">timestamp</span><span class="p">:</span> <span class="kt">Date</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">line</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="n">queue</span> <span class="nv">queueLabel</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>level</dt> + <dd><p>The level of the log</p></dd> + <dt>timestamp</dt> + <dd><p>The time the log was sent</p></dd> + <dt>file</dt> + <dd><p>The file the log originated from</p></dd> + <dt>functionName</dt> + <dd><p>The function the log originated from</p></dd> + <dt>line</dt> + <dd><p>The line the log originated from</p></dd> + <dt>queueLabel</dt> + <dd><p>The queue the log was sent from</p></dd> + <dt>message</dt> + <dd><p>The message of the log</p></dd> + </dl> + + <h3 id="section--logWithLevel:timestamp:file:functionName:line:queue:message:"> + -logWithLevel:timestamp:file:functionName:line:queue:message: + </h3> + + <p>Log to this log manager’s active log targets. This is used internally to log. If you want to create a log, you should use macros such as <code>SDLLogD</code>.</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">logWithLevel</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span><span class="p">)</span><span class="nv">level</span> + <span class="nf">timestamp</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSDate</span> <span class="o">*</span><span class="p">)</span><span class="nv">timestamp</span> + <span class="nf">file</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">file</span> + <span class="nf">functionName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> + <span class="nf">line</span><span class="p">:(</span><span class="n">NSInteger</span><span class="p">)</span><span class="nv">line</span> + <span class="nf">queue</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">queueLabel</span> + <span class="nf">message</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">log</span><span class="p">(</span><span class="n">with</span> <span class="nv">level</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogLevel.html">SDLLogLevel</a></span><span class="p">,</span> <span class="nv">timestamp</span><span class="p">:</span> <span class="kt">Date</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">line</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="n">queue</span> <span class="nv">queueLabel</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">message</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>level</dt> + <dd><p>The level of the log</p></dd> + <dt>timestamp</dt> + <dd><p>The time the log was sent</p></dd> + <dt>file</dt> + <dd><p>The file the log originated from</p></dd> + <dt>functionName</dt> + <dd><p>The function the log originated from</p></dd> + <dt>line</dt> + <dd><p>The line the log originated from</p></dd> + <dt>queueLabel</dt> + <dd><p>The queue the log was sent from</p></dd> + <dt>message</dt> + <dd><p>The message of the log</p></dd> + </dl> + + <h3 id="section-+logBytes:direction:timestamp:file:functionName:line:queue:"> + +logBytes:direction:timestamp:file:functionName:line:queue: + </h3> + + <p>Log to this sharedManager’s active log targets. This is used internally to log.</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">logBytes</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> + <span class="nf">direction</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLLogBytesDirection.html">SDLLogBytesDirection</a></span><span class="p">)</span><span class="nv">direction</span> + <span class="nf">timestamp</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSDate</span> <span class="o">*</span><span class="p">)</span><span class="nv">timestamp</span> + <span class="nf">file</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">file</span> + <span class="nf">functionName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> + <span class="nf">line</span><span class="p">:(</span><span class="n">NSInteger</span><span class="p">)</span><span class="nv">line</span> + <span class="nf">queue</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">queueLabel</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">logBytes</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="nv">direction</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogBytesDirection.html">SDLLogBytesDirection</a></span><span class="p">,</span> <span class="nv">timestamp</span><span class="p">:</span> <span class="kt">Date</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">line</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="n">queue</span> <span class="nv">queueLabel</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>data</dt> + <dd><p>The data to be logged</p></dd> + <dt>direction</dt> + <dd><p>Whether its transmit or receive data</p></dd> + <dt>timestamp</dt> + <dd><p>The time the log was sent</p></dd> + <dt>file</dt> + <dd><p>The file the log originated from</p></dd> + <dt>functionName</dt> + <dd><p>The function the log originated from</p></dd> + <dt>line</dt> + <dd><p>The line the log originated from</p></dd> + <dt>queueLabel</dt> + <dd><p>The queue the log was sent from</p></dd> + </dl> + + <h3 id="section--logBytes:direction:timestamp:file:functionName:line:queue:"> + -logBytes:direction:timestamp:file:functionName:line:queue: + </h3> + + <p>Log to this manager’s active log targets. This is used internally to log.</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">logBytes</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> + <span class="nf">direction</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLLogBytesDirection.html">SDLLogBytesDirection</a></span><span class="p">)</span><span class="nv">direction</span> + <span class="nf">timestamp</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSDate</span> <span class="o">*</span><span class="p">)</span><span class="nv">timestamp</span> + <span class="nf">file</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">file</span> + <span class="nf">functionName</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> + <span class="nf">line</span><span class="p">:(</span><span class="n">NSInteger</span><span class="p">)</span><span class="nv">line</span> + <span class="nf">queue</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">queueLabel</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">logBytes</span><span class="p">(</span><span class="n">_</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">,</span> <span class="nv">direction</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLLogBytesDirection.html">SDLLogBytesDirection</a></span><span class="p">,</span> <span class="nv">timestamp</span><span class="p">:</span> <span class="kt">Date</span><span class="p">,</span> <span class="nv">file</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">functionName</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">line</span><span class="p">:</span> <span class="kt">Int</span><span class="p">,</span> <span class="n">queue</span> <span class="nv">queueLabel</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>data</dt> + <dd><p>The data to be logged</p></dd> + <dt>direction</dt> + <dd><p>Whether its transmit or receive data</p></dd> + <dt>timestamp</dt> + <dd><p>The time the log was sent</p></dd> + <dt>file</dt> + <dd><p>The file the log originated from</p></dd> + <dt>functionName</dt> + <dd><p>The function the log originated from</p></dd> + <dt>line</dt> + <dd><p>The line the log originated from</p></dd> + <dt>queueLabel</dt> + <dd><p>The queue the log was sent from</p></dd> + </dl> + +</section> diff --git a/docs/Classes/SDLMaintenanceModeStatus.html b/docs/Classes/SDLMaintenanceModeStatus.html deleted file mode 100644 index 406bb7d0a..000000000 --- a/docs/Classes/SDLMaintenanceModeStatus.html +++ /dev/null @@ -1,171 +0,0 @@ -<h1>SDLMaintenanceModeStatus 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-+NORMAL">+NORMAL</a></li> - <li><a href="#section-+NEAR">+NEAR</a></li> - <li><a href="#section-+ACTIVE">+ACTIVE</a></li> - <li><a href="#section-+FEATURE_NOT_PRESENT">+FEATURE_NOT_PRESENT</a></li> -</ul> - -<h3>Overview</h3> - -<p>The SDLMaintenanceModeStatus class.</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Maintenance Mode Status -- parameter: value The value of the string to get an object for -- returns: SDLMaintenanceModeStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMaintenanceModeStatus</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">SDLMaintenanceModeStatus</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>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> - - - - <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>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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMaintenanceModeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NORMAL</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">normal</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMaintenanceModeStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMaintenanceModeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NEAR</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">near</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMaintenanceModeStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMaintenanceModeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ACTIVE</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">active</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMaintenanceModeStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMaintenanceModeStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">FEATURE_NOT_PRESENT</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">feature_NOT_PRESENT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMaintenanceModeStatus</span><span class="o">!</span></code></pre> - - - - <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..2679b734a 100644 --- a/docs/Classes/SDLManager.html +++ b/docs/Classes/SDLManager.html @@ -5,6 +5,8 @@ <ul> <li><a href="#section-configuration">configuration</a></li> <li><a href="#section-hmiLevel">hmiLevel</a></li> + <li><a href="#section-audioStreamingState">audioStreamingState</a></li> + <li><a href="#section-systemContext">systemContext</a></li> <li><a href="#section-fileManager">fileManager</a></li> <li><a href="#section-permissionManager">permissionManager</a></li> <li><a href="#section-streamManager">streamManager</a></li> @@ -51,11 +53,48 @@ <h4>Objective-C</h4> - <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"><a href="../Classes/SDLHMILevel.html">SDLHMILevel</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">hmiLevel</span><span class="p">;</span></code></pre> + <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"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span> <span class="n">_Nonnull</span> <span class="n">hmiLevel</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">hmiLevel</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHMILevel.html">SDLHMILevel</a></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">hmiLevel</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-audioStreamingState"> + audioStreamingState + </h3> + + <p>The current audio streaming state of the running app.</p> + + + + <h4>Objective-C</h4> + <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"><a href="../Type Definitions.html#/c:SDLAudioStreamingState.h@T@SDLAudioStreamingState">SDLAudioStreamingState</a></span> <span class="n">_Nonnull</span> <span class="n">audioStreamingState</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioStreamingState</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLAudioStreamingState.h@T@SDLAudioStreamingState">SDLAudioStreamingState</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-systemContext"> + systemContext + </h3> + + <p>The current system context of the running app.</p> + + + + <h4>Objective-C</h4> + <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"><a href="../Type Definitions.html#/c:SDLSystemContext.h@T@SDLSystemContext">SDLSystemContext</a></span> <span class="n">_Nonnull</span> <span class="n">systemContext</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">systemContext</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSystemContext.h@T@SDLSystemContext">SDLSystemContext</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> @@ -180,16 +219,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 +248,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 +291,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:"> @@ -274,18 +308,16 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="n">_</span> <span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">,</span> <span class="n">withResponseHandler</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLResponseHandler">SDLResponseHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">send</span><span class="p">(</span><span class="nv">request</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span><span class="p">,</span> <span class="n">responseHandler</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLResponseHandler">SDLResponseHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> <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 deleted file mode 100644 index 77de53323..000000000 --- a/docs/Classes/SDLMediaClockFormat.html +++ /dev/null @@ -1,320 +0,0 @@ -<h1>SDLMediaClockFormat 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-+CLOCK1">+CLOCK1</a></li> - <li><a href="#section-+CLOCK2">+CLOCK2</a></li> - <li><a href="#section-+CLOCK3">+CLOCK3</a></li> - <li><a href="#section-+CLOCKTEXT1">+CLOCKTEXT1</a></li> - <li><a href="#section-+CLOCKTEXT2">+CLOCKTEXT2</a></li> - <li><a href="#section-+CLOCKTEXT3">+CLOCKTEXT3</a></li> - <li><a href="#section-+CLOCKTEXT4">+CLOCKTEXT4</a></li> -</ul> - -<h3>Overview</h3> - -<p>Indicates the format of the time displayed on the connected SDL unit.</p> - -<p>Format description follows the following nomenclature: <br> - Sp = Space <br> - | = or <br> - c = character <br></p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Media Clock Format</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</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">SDLMediaClockFormat</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>SDLMediaClockFormat</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract declare an array that store all possible Media clock formats inside</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>the array</p> - - </div> - - <h3 id="section-+CLOCK1"> - +CLOCK1 - </h3> - - <p>@abstract Media clock format: Clock1</p> - -<p>@discussion - <ul> - <li>maxHours = 19</li> - <li>maxMinutes = 59</li> - <li>maxSeconds = 59</li> - </ul></p> - -<ul> -<li>- returns: The SDLMediaClockFormat object with value <em>CLOCK1</em></li> -</ul> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCK1</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">clock1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCK1</em></p> - - </div> - - <h3 id="section-+CLOCK2"> - +CLOCK2 - </h3> - - <p>@abstract Media clock format: Clock2</p> - -<p>@discussion - <ul> - <li>maxHours = 59</li> - <li>maxMinutes = 59</li> - <li>maxSeconds = 59</li> - </ul></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCK2</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">clock2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCK2</em></p> - - </div> - - <h3 id="section-+CLOCK3"> - +CLOCK3 - </h3> - - <p>@abstract Media clock format: Clock3</p> - -<p>@discussion - <ul> - <li>maxHours = 9</li> - <li>maxMinutes = 59</li> - <li>maxSeconds = 59</li> - </ul></p> - -<p>@since SDL 2.0 - - returns: The SDLMediaClockFormat object with value <em>CLOCK3</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCK3</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">clock3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCK3</em></p> - - </div> - - <h3 id="section-+CLOCKTEXT1"> - +CLOCKTEXT1 - </h3> - - <p>@abstract Media clock format: ClockText1</p> - -<p>@discussion - <ul> - <li>5 characters possible</li> - <li>Format: 1|sp c :|sp c c</li> - <li>1|sp : digit <q>1</q> or space</li> - <li>c : character out of following character set: sp|0-9|[letters, see - TypeII column in XLS.</li> - <li>:|sp : colon or space</li> - <li>used for Type II headunit</li> - </ul></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCKTEXT1</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">clocktext1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT1</em></p> - - </div> - - <h3 id="section-+CLOCKTEXT2"> - +CLOCKTEXT2 - </h3> - - <p>@abstract Media clock format: ClockText2</p> - -<p>@discussion - <ul> - <li>5 characters possible</li> - <li>Format: 1|sp c :|sp c c</li> - <li>1|sp : digit <q>1</q> or space</li> - <li>c : character out of following character set: sp|0-9|[letters, see - CID column in XLS.</li> - <li>:|sp : colon or space</li> - <li>used for CID headunit</li> - </ul> - difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character - set</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCKTEXT2</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">clocktext2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT2</em></p> - - </div> - - <h3 id="section-+CLOCKTEXT3"> - +CLOCKTEXT3 - </h3> - - <p>@abstract Media clock format: ClockText3</p> - -<p>@discussion - <ul> - <li>6 chars possible</li> - <li>Format: 1|sp c c :|sp c c</li> - <li>1|sp : digit <q>1</q> or space</li> - <li>c : character out of following character set: sp|0-9|[letters, see - Type 5 column in XLS].</li> - <li>:|sp : colon or space</li> - <li>used for Type V headunit</li> - </ul> - difference between CLOCKTEXT1 and CLOCKTEXT2 is the supported character - set</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCKTEXT3</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">clocktext3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLMediaClockFormat object with value <em>CLOCKTEXT3</em></p> - - </div> - - <h3 id="section-+CLOCKTEXT4"> - +CLOCKTEXT4 - </h3> - - <p>@abstract Media clock format: ClockText4</p> - -<p>@discussion - <ul> - <li>6 chars possible</li> - <li>Format: c :|sp c c : c c</li> - <li>:|sp : colon or space</li> - <li>c : character out of following character set: sp|0-9|[letters]</li> - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLMediaClockFormat</span> <span class="o">*</span><span class="p">)</span><span class="n">CLOCKTEXT4</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">clocktext4</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLMediaClockFormat</span><span class="o">!</span></code></pre> - - - - <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..cbb93a5d4 100644 --- a/docs/Classes/SDLMenuParams.html +++ b/docs/Classes/SDLMenuParams.html @@ -3,8 +3,6 @@ <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--initWithMenuName:">-initWithMenuName:</a></li> <li><a href="#section--initWithMenuName:parentId:position:">-initWithMenuName:parentId:position:</a></li> <li><a href="#section-parentID">parentID</a></li> @@ -20,49 +18,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLMenuParams 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 newly allocated SDLMenuParams object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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--initWithMenuName:"> -initWithMenuName: </h3> @@ -72,7 +27,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 +42,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> @@ -105,11 +60,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">parentID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">parentID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">parentID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">parentID</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -133,11 +88,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">position</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">position</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">position</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">position</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -153,11 +108,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">menuName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">menuName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">menuName</span><span class="p">:</span> <span class="kt">String</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/SDLMetadataTags.html b/docs/Classes/SDLMetadataTags.html new file mode 100644 index 000000000..da1bd1932 --- /dev/null +++ b/docs/Classes/SDLMetadataTags.html @@ -0,0 +1,143 @@ +<h1>SDLMetadataTags Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <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--initWithTextFieldTypes:mainField2:"> + -initWithTextFieldTypes:mainField2: + </h3> + + <p>@abstract Constructs a newly allocated SDLMetadataType object with NSArrays</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> +<span class="nf">initWithTextFieldTypes</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">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">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">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="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="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">]?,</span> <span class="nv">mainField2</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">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="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">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="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">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="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">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="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</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> + + + + +</section> diff --git a/docs/Classes/SDLModuleData.html b/docs/Classes/SDLModuleData.html new file mode 100644 index 000000000..ea68ebeff --- /dev/null +++ b/docs/Classes/SDLModuleData.html @@ -0,0 +1,83 @@ +<h1>SDLModuleData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithRadioControlData:">-initWithRadioControlData:</a></li> + <li><a href="#section--initWithClimateControlData:">-initWithClimateControlData:</a></li> + <li><a href="#section-moduleType">moduleType</a></li> + <li><a href="#section-radioControlData">radioControlData</a></li> + <li><a href="#section-climateControlData">climateControlData</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithRadioControlData:"> + -initWithRadioControlData: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section--initWithClimateControlData:"> + -initWithClimateControlData: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-moduleType"> + moduleType + </h3> + + <p>The moduleType indicates which type of data should be changed +and identifies which data object exists in this struct. +For example, if the moduleType is CLIMATE then a <q>climateControlData</q> should exist</p> + + + + <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="../Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="n">_Nonnull</span> <span class="n">moduleType</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">moduleType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-radioControlData"> + radioControlData + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-climateControlData"> + climateControlData + </h3> + + <p>Undocumented</p> + + + + + + +</section> diff --git a/docs/Classes/SDLMyKey.html b/docs/Classes/SDLMyKey.html index d0a8a33f1..cc42cd527 100644 --- a/docs/Classes/SDLMyKey.html +++ b/docs/Classes/SDLMyKey.html @@ -3,8 +3,6 @@ <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-e911Override">e911Override</a></li> </ul> @@ -14,28 +12,6 @@ <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-e911Override"> e911Override </h3> diff --git a/docs/Classes/SDLNavigationCapability.html b/docs/Classes/SDLNavigationCapability.html new file mode 100644 index 000000000..f699da081 --- /dev/null +++ b/docs/Classes/SDLNavigationCapability.html @@ -0,0 +1,66 @@ +<h1>SDLNavigationCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <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--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">nullable</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="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-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">nullable</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="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLOasisAddress.html b/docs/Classes/SDLOasisAddress.html index 51304f548..fd75e532d 100644 --- a/docs/Classes/SDLOasisAddress.html +++ b/docs/Classes/SDLOasisAddress.html @@ -55,11 +55,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">countryName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">countryName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">countryName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">countryName</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> @@ -75,11 +75,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">countryCode</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">countryCode</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">countryCode</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">countryCode</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> @@ -95,11 +95,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">postalCode</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">postalCode</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">postalCode</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">postalCode</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> @@ -115,11 +115,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">administrativeArea</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">administrativeArea</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">administrativeArea</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">administrativeArea</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> @@ -135,11 +135,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">subAdministrativeArea</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">subAdministrativeArea</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">subAdministrativeArea</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">subAdministrativeArea</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> @@ -155,11 +155,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locality</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locality</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">locality</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">locality</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> @@ -175,11 +175,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">subLocality</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">subLocality</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">subLocality</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">subLocality</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> @@ -195,11 +195,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">thoroughfare</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">thoroughfare</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">thoroughfare</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">thoroughfare</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> @@ -215,11 +215,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">subThoroughfare</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">subThoroughfare</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">subThoroughfare</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">subThoroughfare</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> diff --git a/docs/Classes/SDLOnAppInterfaceUnregistered.html b/docs/Classes/SDLOnAppInterfaceUnregistered.html index 2e8bcfdb9..b341530cc 100644 --- a/docs/Classes/SDLOnAppInterfaceUnregistered.html +++ b/docs/Classes/SDLOnAppInterfaceUnregistered.html @@ -3,8 +3,6 @@ <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-reason">reason</a></li> </ul> @@ -14,54 +12,15 @@ <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"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLOnAppInterfaceUnregistered 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 newly allocated SDLOnAppInterfaceUnregistered object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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> - +<section class="section task-group-section"> <h3 id="section-reason"> reason </h3> @@ -71,11 +30,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAppInterfaceUnregisteredReason.html">SDLAppInterfaceUnregisteredReason</a></span> <span class="o">*</span><span class="n">reason</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLAppInterfaceUnregisteredReason.h@T@SDLAppInterfaceUnregisteredReason">SDLAppInterfaceUnregisteredReason</a></span> <span class="n">_Nonnull</span> <span class="n">reason</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">reason</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAppInterfaceUnregisteredReason.html">SDLAppInterfaceUnregisteredReason</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">reason</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLAppInterfaceUnregisteredReason.h@T@SDLAppInterfaceUnregisteredReason">SDLAppInterfaceUnregisteredReason</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/SDLOnAudioPassThru.html b/docs/Classes/SDLOnAudioPassThru.html deleted file mode 100644 index 7e9a97520..000000000 --- a/docs/Classes/SDLOnAudioPassThru.html +++ /dev/null @@ -1,75 +0,0 @@ -<h1>SDLOnAudioPassThru 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>Binary data is in binary part of hybrid msg.</p> - -<p>HMI Status Requirements: - <ul> - HMILevel: - <ul> - <li>BACKGROUND, FULL, LIMITED</li> - </ul> - AudioStreamingState: - <ul> - <li>TBD</li> - </ul> - SystemContext: - <ul> - <li>TBD</li> - </ul> - </ul></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLOnAudioPassThru 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 newly allocated SDLOnAudioPassThru object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLOnButtonEvent.html b/docs/Classes/SDLOnButtonEvent.html index 469b99be6..58f9d9b18 100644 --- a/docs/Classes/SDLOnButtonEvent.html +++ b/docs/Classes/SDLOnButtonEvent.html @@ -3,8 +3,6 @@ <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-buttonName">buttonName</a></li> <li><a href="#section-buttonEventMode">buttonEventMode</a></li> <li><a href="#section-customButtonID">customButtonID</a></li> @@ -19,8 +17,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,56 +43,14 @@ <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> <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLOnButtonEvent 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 SDLOnButtonEvent 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-buttonName"> buttonName </h3> @@ -105,11 +60,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLButtonName.html">SDLButtonName</a></span> <span class="o">*</span><span class="n">buttonName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="n">_Nonnull</span> <span class="n">buttonName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLButtonName.html">SDLButtonName</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">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -123,11 +78,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLButtonEventMode.html">SDLButtonEventMode</a></span> <span class="o">*</span><span class="n">buttonEventMode</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLButtonEventMode.h@T@SDLButtonEventMode">SDLButtonEventMode</a></span> <span class="n">_Nonnull</span> <span class="n">buttonEventMode</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonEventMode</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLButtonEventMode.html">SDLButtonEventMode</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">buttonEventMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLButtonEventMode.h@T@SDLButtonEventMode">SDLButtonEventMode</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -145,11 +101,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">customButtonID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">customButtonID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">customButtonID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">customButtonID</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLOnButtonPress.html b/docs/Classes/SDLOnButtonPress.html index 9f2df2ccd..f96493d4a 100644 --- a/docs/Classes/SDLOnButtonPress.html +++ b/docs/Classes/SDLOnButtonPress.html @@ -3,8 +3,6 @@ <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-buttonName">buttonName</a></li> <li><a href="#section-buttonPressMode">buttonPressMode</a></li> <li><a href="#section-customButtonID">customButtonID</a></li> @@ -47,13 +45,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 @@ -64,54 +60,11 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLOnButtonPress 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 newly allocated SDLOnButtonPress 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-buttonName"> buttonName </h3> <p>@abstract the button’s name</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLButtonName @@ -123,11 +76,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLButtonName.html">SDLButtonName</a></span> <span class="o">*</span><span class="n">buttonName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="n">_Nonnull</span> <span class="n">buttonName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLButtonName.html">SDLButtonName</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">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -137,7 +90,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 @@ -149,11 +101,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLButtonPressMode.html">SDLButtonPressMode</a></span> <span class="o">*</span><span class="n">buttonPressMode</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode">SDLButtonPressMode</a></span> <span class="n">_Nonnull</span> <span class="n">buttonPressMode</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonPressMode</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLButtonPressMode.html">SDLButtonPressMode</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">buttonPressMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLButtonPressMode.h@T@SDLButtonPressMode">SDLButtonPressMode</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -171,11 +124,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">customButtonID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">customButtonID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">customButtonID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">customButtonID</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLOnCommand.html b/docs/Classes/SDLOnCommand.html index 035d537b4..44789f0ec 100644 --- a/docs/Classes/SDLOnCommand.html +++ b/docs/Classes/SDLOnCommand.html @@ -3,8 +3,6 @@ <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-cmdID">cmdID</a></li> <li><a href="#section-triggerSource">triggerSource</a></li> </ul> @@ -16,54 +14,15 @@ <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"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLRPCNotification 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 newly allocated SDLRPCNotification object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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> - +<section class="section task-group-section"> <h3 id="section-cmdID"> cmdID </h3> @@ -73,11 +32,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">cmdID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">cmdID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">cmdID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">cmdID</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -91,11 +50,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTriggerSource.html">SDLTriggerSource</a></span> <span class="o">*</span><span class="n">triggerSource</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource">SDLTriggerSource</a></span> <span class="n">_Nonnull</span> <span class="n">triggerSource</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">triggerSource</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTriggerSource.html">SDLTriggerSource</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">triggerSource</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource">SDLTriggerSource</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/SDLOnDriverDistraction.html b/docs/Classes/SDLOnDriverDistraction.html index e055186c2..d04e5d615 100644 --- a/docs/Classes/SDLOnDriverDistraction.html +++ b/docs/Classes/SDLOnDriverDistraction.html @@ -3,8 +3,6 @@ <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-state">state</a></li> </ul> @@ -28,48 +26,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLOnDriverDistraction 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 newly allocated SDLOnDriverDistraction 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-state"> state </h3> @@ -79,11 +35,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDriverDistractionState.html">SDLDriverDistractionState</a></span> <span class="o">*</span><span class="n">state</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLDriverDistractionState.h@T@SDLDriverDistractionState">SDLDriverDistractionState</a></span> <span class="n">_Nonnull</span> <span class="n">state</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">state</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDriverDistractionState.html">SDLDriverDistractionState</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">state</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDriverDistractionState.h@T@SDLDriverDistractionState">SDLDriverDistractionState</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/SDLOnEncodedSyncPData.html b/docs/Classes/SDLOnEncodedSyncPData.html index d7648f8ec..a27578ff8 100644 --- a/docs/Classes/SDLOnEncodedSyncPData.html +++ b/docs/Classes/SDLOnEncodedSyncPData.html @@ -3,8 +3,6 @@ <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-data">data</a></li> <li><a href="#section-URL">URL</a></li> <li><a href="#section-Timeout">Timeout</a></li> @@ -16,28 +14,6 @@ <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-data"> data </h3> diff --git a/docs/Classes/SDLOnHMIStatus.html b/docs/Classes/SDLOnHMIStatus.html index 59622b448..b1bb60a0c 100644 --- a/docs/Classes/SDLOnHMIStatus.html +++ b/docs/Classes/SDLOnHMIStatus.html @@ -3,8 +3,6 @@ <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-hmiLevel">hmiLevel</a></li> <li><a href="#section-audioStreamingState">audioStreamingState</a></li> <li><a href="#section-systemContext">systemContext</a></li> @@ -28,48 +26,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLOnHMIStatus 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 newly allocated SDLOnHMIStatus 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-hmiLevel"> hmiLevel </h3> @@ -79,11 +35,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLHMILevel.html">SDLHMILevel</a></span> <span class="o">*</span><span class="n">hmiLevel</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span> <span class="n">_Nonnull</span> <span class="n">hmiLevel</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hmiLevel</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHMILevel.html">SDLHMILevel</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">hmiLevel</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -99,12 +55,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> - <span class="n"><a href="../Classes/SDLAudioStreamingState.html">SDLAudioStreamingState</a></span> <span class="o">*</span><span class="n">audioStreamingState</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLAudioStreamingState.h@T@SDLAudioStreamingState">SDLAudioStreamingState</a></span> <span class="n">_Nonnull</span> <span class="n">audioStreamingState</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioStreamingState</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAudioStreamingState.html">SDLAudioStreamingState</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">audioStreamingState</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLAudioStreamingState.h@T@SDLAudioStreamingState">SDLAudioStreamingState</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -119,11 +75,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSystemContext.html">SDLSystemContext</a></span> <span class="o">*</span><span class="n">systemContext</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSystemContext.h@T@SDLSystemContext">SDLSystemContext</a></span> <span class="n">_Nonnull</span> <span class="n">systemContext</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">systemContext</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSystemContext.html">SDLSystemContext</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">systemContext</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSystemContext.h@T@SDLSystemContext">SDLSystemContext</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/SDLOnHashChange.html b/docs/Classes/SDLOnHashChange.html index 0b3cef8a9..a5682d414 100644 --- a/docs/Classes/SDLOnHashChange.html +++ b/docs/Classes/SDLOnHashChange.html @@ -3,8 +3,6 @@ <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-hashID">hashID</a></li> </ul> @@ -14,28 +12,6 @@ <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-hashID"> hashID </h3> diff --git a/docs/Classes/SDLOnInteriorVehicleData.html b/docs/Classes/SDLOnInteriorVehicleData.html new file mode 100644 index 000000000..1a66a4e5e --- /dev/null +++ b/docs/Classes/SDLOnInteriorVehicleData.html @@ -0,0 +1,26 @@ +<h1>SDLOnInteriorVehicleData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-moduleData">moduleData</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-moduleData"> + moduleData + </h3> + + <p>Undocumented</p> + + + + + + +</section> diff --git a/docs/Classes/SDLOnKeyboardInput.html b/docs/Classes/SDLOnKeyboardInput.html index baf4d621f..8a64d5c9d 100644 --- a/docs/Classes/SDLOnKeyboardInput.html +++ b/docs/Classes/SDLOnKeyboardInput.html @@ -3,8 +3,6 @@ <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-event">event</a></li> <li><a href="#section-data">data</a></li> </ul> @@ -15,28 +13,6 @@ <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-event"> event </h3> diff --git a/docs/Classes/SDLOnLanguageChange.html b/docs/Classes/SDLOnLanguageChange.html index 4ec9d4517..c975e34b1 100644 --- a/docs/Classes/SDLOnLanguageChange.html +++ b/docs/Classes/SDLOnLanguageChange.html @@ -3,8 +3,6 @@ <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-language">language</a></li> <li><a href="#section-hmiDisplayLanguage">hmiDisplayLanguage</a></li> </ul> @@ -17,49 +15,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLOnLanguageChange 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 newly allocated SDLOnLanguageChange object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-language"> language </h3> @@ -69,11 +24,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">language</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">_Nonnull</span> <span class="n">language</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -87,11 +42,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">hmiDisplayLanguage</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">_Nonnull</span> <span class="n">hmiDisplayLanguage</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hmiDisplayLanguage</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">hmiDisplayLanguage</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> diff --git a/docs/Classes/SDLOnLockScreenStatus.html b/docs/Classes/SDLOnLockScreenStatus.html index 62df091a5..96fcfe9a9 100644 --- a/docs/Classes/SDLOnLockScreenStatus.html +++ b/docs/Classes/SDLOnLockScreenStatus.html @@ -3,8 +3,6 @@ <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-driverDistractionStatus">driverDistractionStatus</a></li> <li><a href="#section-userSelected">userSelected</a></li> <li><a href="#section-lockScreenStatus">lockScreenStatus</a></li> @@ -23,36 +21,6 @@ The call back also includes details regarding the current HMI_Status level, driv <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - <h3 id="section-driverDistractionStatus"> driverDistractionStatus </h3> @@ -62,18 +30,18 @@ The call back also includes details regarding the current HMI_Status level, driv <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">driverDistractionStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">driverDistractionStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverDistractionStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverDistractionStatus</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> <div> <h4>Return Value</h4> <p>String</p> - </div> <h3 id="section-userSelected"> @@ -85,18 +53,18 @@ The call back also includes details regarding the current HMI_Status level, driv <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">userSelected</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">userSelected</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">userSelected</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">userSelected</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> <div> <h4>Return Value</h4> <p>Boolean the current user selection status</p> - </div> <h3 id="section-lockScreenStatus"> @@ -108,19 +76,18 @@ The call back also includes details regarding the current HMI_Status level, driv <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/SDLLockScreenStatus.html">SDLLockScreenStatus</a></span> <span class="o">*</span><span class="n">lockScreenStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLLockScreenStatus.h@T@SDLLockScreenStatus">SDLLockScreenStatus</a></span> <span class="n">_Nonnull</span> <span class="n">lockScreenStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">lockScreenStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLockScreenStatus.html">SDLLockScreenStatus</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">lockScreenStatus</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLockScreenStatus.h@T@SDLLockScreenStatus">SDLLockScreenStatus</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <div> <h4>Return Value</h4> - <p>{@linkplain -LockScreenStatus}</p> - + <p>{@linkplain LockScreenStatus}</p> </div> <h3 id="section-hmiLevel"> @@ -132,19 +99,17 @@ LockScreenStatus}</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/SDLHMILevel.html">SDLHMILevel</a></span> <span class="o">*</span><span class="n">hmiLevel</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span> <span class="n">_Nonnull</span> <span class="n">hmiLevel</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hmiLevel</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHMILevel.html">SDLHMILevel</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">hmiLevel</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> <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..1332b3db6 100644 --- a/docs/Classes/SDLOnPermissionsChange.html +++ b/docs/Classes/SDLOnPermissionsChange.html @@ -3,8 +3,6 @@ <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-permissionItem">permissionItem</a></li> </ul> @@ -16,49 +14,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a newly allocated SDLOnPermissionsChange 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 newly allocated SDLOnPermissionsChange object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-permissionItem"> permissionItem </h3> @@ -66,7 +21,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 @@ -76,11 +30,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">permissionItem</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLPermissionItem.html">SDLPermissionItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">permissionItem</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">permissionItem</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">permissionItem</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLPermissionItem.html">SDLPermissionItem</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> diff --git a/docs/Classes/SDLOnSyncPData.html b/docs/Classes/SDLOnSyncPData.html index 1623d1332..b7a59075e 100644 --- a/docs/Classes/SDLOnSyncPData.html +++ b/docs/Classes/SDLOnSyncPData.html @@ -3,8 +3,6 @@ <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-URL">URL</a></li> <li><a href="#section-Timeout">Timeout</a></li> </ul> @@ -15,28 +13,6 @@ <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-URL"> URL </h3> diff --git a/docs/Classes/SDLOnSystemRequest.html b/docs/Classes/SDLOnSystemRequest.html index 9bd7189e1..6f4287efd 100644 --- a/docs/Classes/SDLOnSystemRequest.html +++ b/docs/Classes/SDLOnSystemRequest.html @@ -3,8 +3,6 @@ <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-requestType">requestType</a></li> <li><a href="#section-url">url</a></li> <li><a href="#section-timeout">timeout</a></li> @@ -19,28 +17,6 @@ <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-requestType"> requestType </h3> diff --git a/docs/Classes/SDLOnTBTClientState.html b/docs/Classes/SDLOnTBTClientState.html index 502c8cf30..303cc4c8f 100644 --- a/docs/Classes/SDLOnTBTClientState.html +++ b/docs/Classes/SDLOnTBTClientState.html @@ -3,8 +3,6 @@ <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-state">state</a></li> </ul> @@ -14,28 +12,6 @@ <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-state"> state </h3> diff --git a/docs/Classes/SDLOnTouchEvent.html b/docs/Classes/SDLOnTouchEvent.html index e4239fa4e..629a1a67e 100644 --- a/docs/Classes/SDLOnTouchEvent.html +++ b/docs/Classes/SDLOnTouchEvent.html @@ -3,8 +3,6 @@ <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-type">type</a></li> <li><a href="#section-event">event</a></li> </ul> @@ -15,28 +13,6 @@ <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-type"> type </h3> diff --git a/docs/Classes/SDLOnVehicleData.html b/docs/Classes/SDLOnVehicleData.html index 33cde85d5..778d44e58 100644 --- a/docs/Classes/SDLOnVehicleData.html +++ b/docs/Classes/SDLOnVehicleData.html @@ -3,8 +3,6 @@ <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-gps">gps</a></li> <li><a href="#section-speed">speed</a></li> <li><a href="#section-rpm">rpm</a></li> @@ -40,50 +38,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLOnVehicleData 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 new SDLOnVehicleData object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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-gps"> gps </h3> @@ -93,11 +47,11 @@ parameter <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/SDLGPSData.html">SDLGPSData</a></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLGPSData.html">SDLGPSData</a></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGPSData.html">SDLGPSData</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">gps</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGPSData.html">SDLGPSData</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> @@ -111,11 +65,11 @@ parameter <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">speed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -129,11 +83,11 @@ parameter <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">rpm</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">rpm</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -147,11 +101,11 @@ parameter <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">fuelLevel</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">fuelLevel</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -165,11 +119,12 @@ parameter <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/SDLComponentVolumeStatus.html">SDLComponentVolumeStatus</a></span> <span class="o">*</span><span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLComponentVolumeStatus.h@T@SDLComponentVolumeStatus">SDLComponentVolumeStatus</a></span> <span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLComponentVolumeStatus.html">SDLComponentVolumeStatus</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">fuelLevel_State</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLComponentVolumeStatus.h@T@SDLComponentVolumeStatus">SDLComponentVolumeStatus</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> @@ -183,11 +138,12 @@ parameter <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">instantFuelConsumption</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">instantFuelConsumption</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -201,11 +157,12 @@ parameter <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">externalTemperature</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">externalTemperature</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -219,11 +176,11 @@ parameter <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">NSString</span> <span class="o">*</span><span class="n">vin</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">vin</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vin</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vin</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> @@ -237,11 +194,11 @@ parameter <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/SDLPRNDL.html">SDLPRNDL</a></span> <span class="o">*</span><span class="n">prndl</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLPRNDL.h@T@SDLPRNDL">SDLPRNDL</a></span> <span class="n">prndl</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPRNDL.html">SDLPRNDL</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">prndl</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLPRNDL.h@T@SDLPRNDL">SDLPRNDL</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> @@ -255,11 +212,11 @@ parameter <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/SDLTireStatus.html">SDLTireStatus</a></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTireStatus.html">SDLTireStatus</a></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTireStatus.html">SDLTireStatus</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">tirePressure</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTireStatus.html">SDLTireStatus</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> @@ -273,11 +230,11 @@ parameter <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">odometer</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">odometer</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -291,11 +248,11 @@ parameter <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/SDLBeltStatus.html">SDLBeltStatus</a></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLBeltStatus.html">SDLBeltStatus</a></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBeltStatus.html">SDLBeltStatus</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">beltStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBeltStatus.html">SDLBeltStatus</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> @@ -309,11 +266,12 @@ parameter <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/SDLBodyInformation.html">SDLBodyInformation</a></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLBodyInformation.html">SDLBodyInformation</a></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBodyInformation.html">SDLBodyInformation</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">bodyInformation</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBodyInformation.html">SDLBodyInformation</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> @@ -327,11 +285,11 @@ parameter <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/SDLDeviceStatus.html">SDLDeviceStatus</a></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDeviceStatus.html">SDLDeviceStatus</a></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeviceStatus.html">SDLDeviceStatus</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">deviceStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeviceStatus.html">SDLDeviceStatus</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> @@ -345,11 +303,12 @@ parameter <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/SDLVehicleDataEventStatus.html">SDLVehicleDataEventStatus</a></span> <span class="o">*</span><span class="n">driverBraking</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBraking</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataEventStatus.html">SDLVehicleDataEventStatus</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">driverBraking</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</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> @@ -363,11 +322,11 @@ parameter <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/SDLWiperStatus.html">SDLWiperStatus</a></span> <span class="o">*</span><span class="n">wiperStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLWiperStatus.h@T@SDLWiperStatus">SDLWiperStatus</a></span> <span class="n">wiperStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLWiperStatus.html">SDLWiperStatus</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">wiperStatus</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLWiperStatus.h@T@SDLWiperStatus">SDLWiperStatus</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> @@ -381,11 +340,12 @@ parameter <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/SDLHeadLampStatus.html">SDLHeadLampStatus</a></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLHeadLampStatus.html">SDLHeadLampStatus</a></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHeadLampStatus.html">SDLHeadLampStatus</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">headLampStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHeadLampStatus.html">SDLHeadLampStatus</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> @@ -399,11 +359,12 @@ parameter <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">engineTorque</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">engineTorque</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -417,11 +378,12 @@ parameter <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">accPedalPosition</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">accPedalPosition</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -435,11 +397,12 @@ parameter <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">steeringWheelAngle</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">steeringWheelAngle</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -453,7 +416,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.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> @@ -468,7 +431,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.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> @@ -483,7 +446,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.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> @@ -498,7 +461,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.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> @@ -513,7 +476,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.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> diff --git a/docs/Classes/SDLOnWaypointChange.html b/docs/Classes/SDLOnWaypointChange.html index be37a886f..894196177 100644 --- a/docs/Classes/SDLOnWaypointChange.html +++ b/docs/Classes/SDLOnWaypointChange.html @@ -23,11 +23,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">waypoints</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">waypoints</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">waypoints</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</a></span><span class="p">]</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">waypoints</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLLocationDetails.html">SDLLocationDetails</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> diff --git a/docs/Classes/SDLPRNDL.html b/docs/Classes/SDLPRNDL.html deleted file mode 100644 index 93f0a51fa..000000000 --- a/docs/Classes/SDLPRNDL.html +++ /dev/null @@ -1,454 +0,0 @@ -<h1>SDLPRNDL 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-+PARK">+PARK</a></li> - <li><a href="#section-+REVERSE">+REVERSE</a></li> - <li><a href="#section-+NEUTRAL">+NEUTRAL</a></li> - <li><a href="#section-+DRIVE">+DRIVE</a></li> - <li><a href="#section-+SPORT">+SPORT</a></li> - <li><a href="#section-+LOWGEAR">+LOWGEAR</a></li> - <li><a href="#section-+FIRST">+FIRST</a></li> - <li><a href="#section-+SECOND">+SECOND</a></li> - <li><a href="#section-+THIRD">+THIRD</a></li> - <li><a href="#section-+FOURTH">+FOURTH</a></li> - <li><a href="#section-+FIFTH">+FIFTH</a></li> - <li><a href="#section-+SIXTH">+SIXTH</a></li> - <li><a href="#section-+SEVENTH">+SEVENTH</a></li> - <li><a href="#section-+EIGHTH">+EIGHTH</a></li> - <li><a href="#section-+UNKNOWN">+UNKNOWN</a></li> - <li><a href="#section-+FAULT">+FAULT</a></li> -</ul> - -<h3>Overview</h3> - -<p>The selected gear the car is in.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract get SDLPRNDL according value string</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</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">SDLPRNDL</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>SDLPRNDL object</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract declare an array to store all possible SDLPRNDL 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>the array</p> - - </div> - - <h3 id="section-+PARK"> - +PARK - </h3> - - <p>@abstract Park</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">PARK</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">park</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>PARK</em></p> - - </div> - - <h3 id="section-+REVERSE"> - +REVERSE - </h3> - - <p>@abstract Reverse gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">REVERSE</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">reverse</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>REVERSE</em></p> - - </div> - - <h3 id="section-+NEUTRAL"> - +NEUTRAL - </h3> - - <p>@abstract No gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">NEUTRAL</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">neutral</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>NEUTRAL</em></p> - - </div> - - <h3 id="section-+DRIVE"> - +DRIVE - </h3> - - <p>@abstract: Drive gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">DRIVE</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">drive</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>DRIVE</em></p> - - </div> - - <h3 id="section-+SPORT"> - +SPORT - </h3> - - <p>@abstract Drive Sport mode</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">SPORT</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">sport</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>SPORT</em></p> - - </div> - - <h3 id="section-+LOWGEAR"> - +LOWGEAR - </h3> - - <p>@abstract 1st gear hold</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">LOWGEAR</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">lowgear</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>LOWGEAR</em></p> - - </div> - - <h3 id="section-+FIRST"> - +FIRST - </h3> - - <p>@abstract First gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">FIRST</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">first</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>FIRST</em></p> - - </div> - - <h3 id="section-+SECOND"> - +SECOND - </h3> - - <p>@abstract Second gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">SECOND</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">second</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>SECOND</em></p> - - </div> - - <h3 id="section-+THIRD"> - +THIRD - </h3> - - <p>@abstract Third gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">THIRD</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">third</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>THIRD</em></p> - - </div> - - <h3 id="section-+FOURTH"> - +FOURTH - </h3> - - <p>@abstract Fourth gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">FOURTH</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">fourth</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>FOURTH</em></p> - - </div> - - <h3 id="section-+FIFTH"> - +FIFTH - </h3> - - <p>@abstract Fifth gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">FIFTH</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">fifth</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>FIFTH</em></p> - - </div> - - <h3 id="section-+SIXTH"> - +SIXTH - </h3> - - <p>@abstract Sixth gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">SIXTH</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">sixth</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>SIXTH</em></p> - - </div> - - <h3 id="section-+SEVENTH"> - +SEVENTH - </h3> - - <p>@abstract Seventh gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">SEVENTH</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">seventh</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>SEVENTH</em></p> - - </div> - - <h3 id="section-+EIGHTH"> - +EIGHTH - </h3> - - <p>@abstract Eighth gear</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">EIGHTH</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">eighth</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>EIGHTH</em></p> - - </div> - - <h3 id="section-+UNKNOWN"> - +UNKNOWN - </h3> - - <p>@abstract Unknown</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">UNKNOWN</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">unknown</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLPRNDL: <em>UNKNOWN</em></p> - - </div> - - <h3 id="section-+FAULT"> - +FAULT - </h3> - - <p>@abstract Fault</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPRNDL</span> <span class="o">*</span><span class="p">)</span><span class="n">FAULT</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">fault</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPRNDL</span><span class="o">!</span></code></pre> - - - - <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..ef5a0dc6c 100644 --- a/docs/Classes/SDLParameterPermissions.html +++ b/docs/Classes/SDLParameterPermissions.html @@ -3,8 +3,6 @@ <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-allowed">allowed</a></li> <li><a href="#section-userDisallowed">userDisallowed</a></li> </ul> @@ -17,48 +15,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a newly allocated SDLParameterPermissions 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 SDLParameterPermissions 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-allowed"> allowed </h3> @@ -70,11 +26,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">allowed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">allowed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">allowed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">allowed</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> @@ -90,11 +46,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">userDisallowed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">userDisallowed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">userDisallowed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">userDisallowed</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> diff --git a/docs/Classes/SDLPerformAudioPassThru.html b/docs/Classes/SDLPerformAudioPassThru.html index dcedb7973..54dfd3bc7 100644 --- a/docs/Classes/SDLPerformAudioPassThru.html +++ b/docs/Classes/SDLPerformAudioPassThru.html @@ -3,10 +3,10 @@ <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--initWithSamplingRate:bitsPerSample:audioType:maxDuration:">-initWithSamplingRate:bitsPerSample:audioType:maxDuration:</a></li> <li><a href="#section--initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:">-initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:</a></li> + <li><a href="#section--initWithSamplingRate:bitsPerSample:audioType:maxDuration:audioDataHandler:">-initWithSamplingRate:bitsPerSample:audioType:maxDuration:audioDataHandler:</a></li> + <li><a href="#section--initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:audioDataHandler:">-initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:audioDataHandler:</a></li> <li><a href="#section-initialPrompt">initialPrompt</a></li> <li><a href="#section-audioPassThruDisplayText1">audioPassThruDisplayText1</a></li> <li><a href="#section-audioPassThruDisplayText2">audioPassThruDisplayText2</a></li> @@ -15,6 +15,7 @@ <li><a href="#section-bitsPerSample">bitsPerSample</a></li> <li><a href="#section-audioType">audioType</a></li> <li><a href="#section-muteAudio">muteAudio</a></li> + <li><a href="#section-audioDataHandler">audioDataHandler</a></li> </ul> <h3>Overview</h3> @@ -28,56 +29,42 @@ </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"> - <h3 id="section--init"> - -init + <h3 id="section--initWithSamplingRate:bitsPerSample:audioType:maxDuration:"> + -initWithSamplingRate:bitsPerSample:audioType:maxDuration: </h3> - <p>@abstract Constructs a new SDLPerformAudioPassThru object</p> + <p>Undocumented</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> + <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> - <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 id="section--initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:"> + -initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio: </h3> - <p>@abstract Constructs a new SDLPerformAudioPassThru object indicated by the NSMutableDictionary -- parameter: dict The dictionary to use</p> + <p>Undocumented</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> + <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> - <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--initWithSamplingRate:bitsPerSample:audioType:maxDuration:"> - -initWithSamplingRate:bitsPerSample:audioType:maxDuration: + <h3 id="section--initWithSamplingRate:bitsPerSample:audioType:maxDuration:audioDataHandler:"> + -initWithSamplingRate:bitsPerSample:audioType:maxDuration:audioDataHandler: </h3> <p>Undocumented</p> @@ -85,14 +72,14 @@ <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> - <h3 id="section--initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:"> - -initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio: + <h3 id="section--initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:audioDataHandler:"> + -initWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:bitsPerSample:audioType:maxDuration:muteAudio:audioDataHandler: </h3> <p>Undocumented</p> @@ -100,7 +87,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> @@ -129,11 +116,12 @@ thru session by SDL <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">initialPrompt</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">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">initialPrompt</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">initialPrompt</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">initialPrompt</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> @@ -152,11 +140,12 @@ thru session by SDL <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">NSString</span> <span class="o">*</span><span class="n">audioPassThruDisplayText1</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSString</span> <span class="o">*</span><span class="n">audioPassThruDisplayText1</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioPassThruDisplayText1</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioPassThruDisplayText1</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> @@ -175,11 +164,12 @@ thru session by SDL <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">NSString</span> <span class="o">*</span><span class="n">audioPassThruDisplayText2</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSString</span> <span class="o">*</span><span class="n">audioPassThruDisplayText2</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioPassThruDisplayText2</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioPassThruDisplayText2</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> @@ -195,11 +185,11 @@ thru session by SDL <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/SDLSamplingRate.html">SDLSamplingRate</a></span> <span class="o">*</span><span class="n">samplingRate</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSamplingRate.h@T@SDLSamplingRate">SDLSamplingRate</a></span> <span class="n">_Nonnull</span> <span class="n">samplingRate</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">samplingRate</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSamplingRate.html">SDLSamplingRate</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">samplingRate</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSamplingRate.h@T@SDLSamplingRate">SDLSamplingRate</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -219,11 +209,11 @@ thru session by SDL <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">maxDuration</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">maxDuration</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">maxDuration</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">maxDuration</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -239,11 +229,11 @@ thru session by SDL <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/SDLBitsPerSample.html">SDLBitsPerSample</a></span> <span class="o">*</span><span class="n">bitsPerSample</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLBitsPerSample.h@T@SDLBitsPerSample">SDLBitsPerSample</a></span> <span class="n">_Nonnull</span> <span class="n">bitsPerSample</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">bitsPerSample</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLBitsPerSample.html">SDLBitsPerSample</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">bitsPerSample</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLBitsPerSample.h@T@SDLBitsPerSample">SDLBitsPerSample</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -257,11 +247,11 @@ thru session by SDL <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/SDLAudioType.html">SDLAudioType</a></span> <span class="o">*</span><span class="n">audioType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLAudioType.h@T@SDLAudioType">SDLAudioType</a></span> <span class="n">_Nonnull</span> <span class="n">audioType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAudioType.html">SDLAudioType</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">audioType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLAudioType.h@T@SDLAudioType">SDLAudioType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -276,11 +266,30 @@ muted during the APT session<br/></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">muteAudio</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">muteAudio</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">muteAudio</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-audioDataHandler"> + audioDataHandler + </h3> + + <p>A handler that will be called whenever an <code>onAudioPassThru</code> notification is received.</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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLAudioPassThruHandler">SDLAudioPassThruHandler</a></span> <span class="n">audioDataHandler</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">muteAudio</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioDataHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLAudioPassThruHandler">SDLAudioPassThruHandler</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> diff --git a/docs/Classes/SDLPerformAudioPassThruResponse.html b/docs/Classes/SDLPerformAudioPassThruResponse.html deleted file mode 100644 index d026d698e..000000000 --- a/docs/Classes/SDLPerformAudioPassThruResponse.html +++ /dev/null @@ -1,61 +0,0 @@ -<h1>SDLPerformAudioPassThruResponse 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>Perform Audio Pass Thru Response is sent, when PerformAudioPassThru has been called</p> - -<p>Since SmartDeviceLink 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLPerformAudioPassThruResponse 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 new SDLPerformAudioPassThruResponse object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLPerformInteraction.html b/docs/Classes/SDLPerformInteraction.html index b0927195e..7abfcc7c8 100644 --- a/docs/Classes/SDLPerformInteraction.html +++ b/docs/Classes/SDLPerformInteraction.html @@ -3,8 +3,6 @@ <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--initWithInteractionChoiceSetId:">-initWithInteractionChoiceSetId:</a></li> <li><a href="#section--initWithInteractionChoiceSetIdList:">-initWithInteractionChoiceSetIdList:</a></li> <li><a href="#section--initWithInitialPrompt:initialText:interactionChoiceSetID:">-initWithInitialPrompt:initialText:interactionChoiceSetID:</a></li> @@ -42,49 +40,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLPerformInteraction 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 new SDLPerformInteraction object indicated by the NSMutableDictionary -- parameter: dict The dictionary to use</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--initWithInteractionChoiceSetId:"> -initWithInteractionChoiceSetId: </h3> @@ -94,7 +49,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 +64,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 +79,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 +94,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 +109,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 +124,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 +139,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 +154,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> @@ -217,11 +172,11 @@ does not fit on line, it will be truncated</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">NSString</span> <span class="o">*</span><span class="n">initialText</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">initialText</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">initialText</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">initialText</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -236,11 +191,12 @@ what is to be spoken to the user at the start of an interaction</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">initialPrompt</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">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">initialPrompt</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">initialPrompt</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">initialPrompt</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> @@ -256,11 +212,12 @@ from the menu (MANUAL_ONLY), or by either mode (BOTH)</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/SDLInteractionMode.html">SDLInteractionMode</a></span> <span class="o">*</span><span class="n">interactionMode</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLInteractionMode.h@T@SDLInteractionMode">SDLInteractionMode</a></span> <span class="n">_Nonnull</span> <span class="n">interactionMode</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">interactionMode</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLInteractionMode.html">SDLInteractionMode</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">interactionMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLInteractionMode.h@T@SDLInteractionMode">SDLInteractionMode</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -275,11 +232,12 @@ Set IDs</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">interactionChoiceSetIDList</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">interactionChoiceSetIDList</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">interactionChoiceSetIDList</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">interactionChoiceSetIDList</span><span class="p">:</span> <span class="p">[</span><span class="kt">NSNumber</span> </code></pre> @@ -294,11 +252,12 @@ be spoken when the user says <q>help</q> during the VR session</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">helpPrompt</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">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">helpPrompt</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">helpPrompt</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">helpPrompt</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> @@ -313,11 +272,12 @@ be spoken when the listen times out during the VR session</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">timeoutPrompt</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">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">timeoutPrompt</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeoutPrompt</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeoutPrompt</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> @@ -332,11 +292,11 @@ SDL will wait for the user to make a choice (VR or Menu)</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">timeout</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeout</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeout</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -352,11 +312,12 @@ display on-screen during Perform Interaction <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">vrHelp</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">vrHelp</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrHelp</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrHelp</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</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> @@ -370,7 +331,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..bdc164c9e 100644 --- a/docs/Classes/SDLPerformInteractionResponse.html +++ b/docs/Classes/SDLPerformInteractionResponse.html @@ -3,8 +3,6 @@ <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-choiceID">choiceID</a></li> <li><a href="#section-manualTextEntry">manualTextEntry</a></li> <li><a href="#section-triggerSource">triggerSource</a></li> @@ -18,49 +16,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLPerformInteractionResponse 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 new SDLPerformInteractionResponse object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-choiceID"> choiceID </h3> @@ -74,11 +29,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">choiceID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">choiceID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">choiceID</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">choiceID</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -96,11 +51,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">manualTextEntry</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">manualTextEntry</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">manualTextEntry</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">manualTextEntry</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> @@ -116,11 +71,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTriggerSource.html">SDLTriggerSource</a></span> <span class="o">*</span><span class="n">triggerSource</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource">SDLTriggerSource</a></span> <span class="n">triggerSource</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">triggerSource</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTriggerSource.html">SDLTriggerSource</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">triggerSource</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTriggerSource.h@T@SDLTriggerSource">SDLTriggerSource</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> diff --git a/docs/Classes/SDLPermissionItem.html b/docs/Classes/SDLPermissionItem.html index b4f0bd603..fa14d05b0 100644 --- a/docs/Classes/SDLPermissionItem.html +++ b/docs/Classes/SDLPermissionItem.html @@ -3,8 +3,6 @@ <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-rpcName">rpcName</a></li> <li><a href="#section-hmiPermissions">hmiPermissions</a></li> <li><a href="#section-parameterPermissions">parameterPermissions</a></li> @@ -16,28 +14,6 @@ <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-rpcName"> rpcName </h3> diff --git a/docs/Classes/SDLPermissionManager.html b/docs/Classes/SDLPermissionManager.html index 608e88a4a..516db2a03 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:"> @@ -135,20 +130,18 @@ <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">status</span><span class="p">(</span><span class="n">ofRPCs</span> <span class="nv">rpcNames</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">])</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">NSNumber</span><span class="p">]</span></code></pre> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">status</span><span class="p">(</span><span class="n">ofRPCs</span> <span class="nv">rpcNames</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">])</span> <span class="o">-></span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> <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 deleted file mode 100644 index 8d9633934..000000000 --- a/docs/Classes/SDLPermissionStatus.html +++ /dev/null @@ -1,171 +0,0 @@ -<h1>SDLPermissionStatus 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-+ALLOWED">+ALLOWED</a></li> - <li><a href="#section-+DISALLOWED">+DISALLOWED</a></li> - <li><a href="#section-+USER_DISALLOWED">+USER_DISALLOWED</a></li> - <li><a href="#section-+USER_CONSENT_PENDING">+USER_CONSENT_PENDING</a></li> -</ul> - -<h3>Overview</h3> - -<p>Enumeration that describes possible permission states of a policy table entry.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract SDLPermissionStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPermissionStatus</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">SDLPermissionStatus</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>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> - - - - <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>the array</p> - - </div> - - <h3 id="section-+ALLOWED"> - +ALLOWED - </h3> - - <p>@abstract permission: allowed -- returns: permission status: <em>ALLOWED</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPermissionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ALLOWED</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">allowed</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPermissionStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPermissionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">DISALLOWED</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">disallowed</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPermissionStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPermissionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">USER_DISALLOWED</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">user_DISALLOWED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPermissionStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPermissionStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">USER_CONSENT_PENDING</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">user_CONSENT_PENDING</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPermissionStatus</span><span class="o">!</span></code></pre> - - - - <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..cccaaaf6c --- /dev/null +++ b/docs/Classes/SDLPhoneCapability.html @@ -0,0 +1,46 @@ +<h1>SDLPhoneCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <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--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">nullable</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="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLPinchGesture.html b/docs/Classes/SDLPinchGesture.html new file mode 100644 index 000000000..4d8e88cb6 --- /dev/null +++ b/docs/Classes/SDLPinchGesture.html @@ -0,0 +1,148 @@ +<h1>SDLPinchGesture Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithFirstTouch:secondTouch:">-initWithFirstTouch:secondTouch:</a></li> + <li><a href="#section-firstTouch">firstTouch</a></li> + <li><a href="#section-secondTouch">secondTouch</a></li> + <li><a href="#section-distance">distance</a></li> + <li><a href="#section-center">center</a></li> + <li><a href="#section-isValid">isValid</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithFirstTouch:secondTouch:"> + -initWithFirstTouch:secondTouch: + </h3> + + <p>@abstract + Initializes a pinch gesture.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFirstTouch</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLTouch.html">SDLTouch</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">firstTouch</span> + <span class="nf">secondTouch</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLTouch.html">SDLTouch</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">secondTouch</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">firstTouch</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTouch.html">SDLTouch</a></span><span class="p">,</span> <span class="nv">secondTouch</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTouch.html">SDLTouch</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>firstTouch</dt> + <dd><p>First touch of the gesture</p></dd> + <dt>secondTouch</dt> + <dd><p>Second touch of the gesture</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>SDLPinchGesture +Instance of SDLPinchGesture.</p> + </div> + + <h3 id="section-firstTouch"> + firstTouch + </h3> + + <p>@abstract + First touch of a pinch gesture.</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/SDLTouch.html">SDLTouch</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">firstTouch</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">firstTouch</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTouch.html">SDLTouch</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-secondTouch"> + secondTouch + </h3> + + <p>@abstract + Second touch of a pinch gesture.</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/SDLTouch.html">SDLTouch</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">secondTouch</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">secondTouch</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTouch.html">SDLTouch</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-distance"> + distance + </h3> + + <p>@abstract + Distance between first and second touches.</p> + + + + <h4>Objective-C</h4> + <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">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">CGFloat</span> <span class="n">distance</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">distance</span><span class="p">:</span> <span class="kt">CGFloat</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-center"> + center + </h3> + + <p>@abstract + Center point between first and second touches.</p> + + + + <h4>Objective-C</h4> + <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">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">CGPoint</span> <span class="n">center</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">center</span><span class="p">:</span> <span class="kt">CGPoint</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-isValid"> + isValid + </h3> + + <p>@abstract + Returns whether or not the pinch gesture is valid. This is true if both touches + are non null.</p> + + + + <h4>Objective-C</h4> + <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">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">isValid</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isValid</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> + + + + +</section> diff --git a/docs/Classes/SDLPowerModeQualificationStatus.html b/docs/Classes/SDLPowerModeQualificationStatus.html deleted file mode 100644 index 13ef575c9..000000000 --- a/docs/Classes/SDLPowerModeQualificationStatus.html +++ /dev/null @@ -1,86 +0,0 @@ -<h1>SDLPowerModeQualificationStatus 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-+POWER_MODE_UNDEFINED">+POWER_MODE_UNDEFINED</a></li> - <li><a href="#section-+POWER_MODE_EVALUATION_IN_PROGRESS">+POWER_MODE_EVALUATION_IN_PROGRESS</a></li> - <li><a href="#section-+NOT_DEFINED">+NOT_DEFINED</a></li> - <li><a href="#section-+POWER_MODE_OK">+POWER_MODE_OK</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+POWER_MODE_UNDEFINED"> - +POWER_MODE_UNDEFINED - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+POWER_MODE_EVALUATION_IN_PROGRESS"> - +POWER_MODE_EVALUATION_IN_PROGRESS - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+NOT_DEFINED"> - +NOT_DEFINED - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+POWER_MODE_OK"> - +POWER_MODE_OK - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLPowerModeStatus.html b/docs/Classes/SDLPowerModeStatus.html deleted file mode 100644 index 629f0e899..000000000 --- a/docs/Classes/SDLPowerModeStatus.html +++ /dev/null @@ -1,146 +0,0 @@ -<h1>SDLPowerModeStatus 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-+KEY_OUT">+KEY_OUT</a></li> - <li><a href="#section-+KEY_RECENTLY_OUT">+KEY_RECENTLY_OUT</a></li> - <li><a href="#section-+KEY_APPROVED_0">+KEY_APPROVED_0</a></li> - <li><a href="#section-+POST_ACCESORY_0">+POST_ACCESORY_0</a></li> - <li><a href="#section-+ACCESORY_1">+ACCESORY_1</a></li> - <li><a href="#section-+POST_IGNITION_1">+POST_IGNITION_1</a></li> - <li><a href="#section-+IGNITION_ON_2">+IGNITION_ON_2</a></li> - <li><a href="#section-+RUNNING_2">+RUNNING_2</a></li> - <li><a href="#section-+CRANK_3">+CRANK_3</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+KEY_OUT"> - +KEY_OUT - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+KEY_RECENTLY_OUT"> - +KEY_RECENTLY_OUT - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+KEY_APPROVED_0"> - +KEY_APPROVED_0 - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+POST_ACCESORY_0"> - +POST_ACCESORY_0 - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ACCESORY_1"> - +ACCESORY_1 - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+POST_IGNITION_1"> - +POST_IGNITION_1 - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+IGNITION_ON_2"> - +IGNITION_ON_2 - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+RUNNING_2"> - +RUNNING_2 - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+CRANK_3"> - +CRANK_3 - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLPredefinedLayout.html b/docs/Classes/SDLPredefinedLayout.html deleted file mode 100644 index 8754a85c6..000000000 --- a/docs/Classes/SDLPredefinedLayout.html +++ /dev/null @@ -1,278 +0,0 @@ -<h1>SDLPredefinedLayout Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+valueOf:">+valueOf:</a></li> - <li><a href="#section-+values">+values</a></li> - <li><a href="#section-+DEFAULT">+DEFAULT</a></li> - <li><a href="#section-+MEDIA">+MEDIA</a></li> - <li><a href="#section-+NON_MEDIA">+NON_MEDIA</a></li> - <li><a href="#section-+ONSCREEN_PRESETS">+ONSCREEN_PRESETS</a></li> - <li><a href="#section-+NAV_FULLSCREEN_MAP">+NAV_FULLSCREEN_MAP</a></li> - <li><a href="#section-+NAV_LIST">+NAV_LIST</a></li> - <li><a href="#section-+NAV_KEYBOARD">+NAV_KEYBOARD</a></li> - <li><a href="#section-+GRAPHIC_WITH_TEXT">+GRAPHIC_WITH_TEXT</a></li> - <li><a href="#section-+TEXT_WITH_GRAPHIC">+TEXT_WITH_GRAPHIC</a></li> - <li><a href="#section-+TILES_ONLY">+TILES_ONLY</a></li> - <li><a href="#section-+TEXTBUTTONS_ONLY">+TEXTBUTTONS_ONLY</a></li> - <li><a href="#section-+GRAPHIC_WITH_TILES">+GRAPHIC_WITH_TILES</a></li> - <li><a href="#section-+TILES_WITH_GRAPHIC">+TILES_WITH_GRAPHIC</a></li> - <li><a href="#section-+GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS">+GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS</a></li> - <li><a href="#section-+TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC">+TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC</a></li> - <li><a href="#section-+GRAPHIC_WITH_TEXTBUTTONS">+GRAPHIC_WITH_TEXTBUTTONS</a></li> - <li><a href="#section-+TEXTBUTTONS_WITH_GRAPHIC">+TEXTBUTTONS_WITH_GRAPHIC</a></li> - <li><a href="#section-+LARGE_GRAPHIC_WITH_SOFTBUTTONS">+LARGE_GRAPHIC_WITH_SOFTBUTTONS</a></li> - <li><a href="#section-+DOUBLE_GRAPHIC_WITH_SOFTBUTTONS">+DOUBLE_GRAPHIC_WITH_SOFTBUTTONS</a></li> - <li><a href="#section-+LARGE_GRAPHIC_ONLY">+LARGE_GRAPHIC_ONLY</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+DEFAULT"> - +DEFAULT - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+MEDIA"> - +MEDIA - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+NON_MEDIA"> - +NON_MEDIA - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ONSCREEN_PRESETS"> - +ONSCREEN_PRESETS - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+NAV_FULLSCREEN_MAP"> - +NAV_FULLSCREEN_MAP - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+NAV_LIST"> - +NAV_LIST - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+NAV_KEYBOARD"> - +NAV_KEYBOARD - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+GRAPHIC_WITH_TEXT"> - +GRAPHIC_WITH_TEXT - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+TEXT_WITH_GRAPHIC"> - +TEXT_WITH_GRAPHIC - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+TILES_ONLY"> - +TILES_ONLY - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+TEXTBUTTONS_ONLY"> - +TEXTBUTTONS_ONLY - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+GRAPHIC_WITH_TILES"> - +GRAPHIC_WITH_TILES - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+TILES_WITH_GRAPHIC"> - +TILES_WITH_GRAPHIC - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS"> - +GRAPHIC_WITH_TEXT_AND_SOFTBUTTONS - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC"> - +TEXT_AND_SOFTBUTTONS_WITH_GRAPHIC - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+GRAPHIC_WITH_TEXTBUTTONS"> - +GRAPHIC_WITH_TEXTBUTTONS - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+TEXTBUTTONS_WITH_GRAPHIC"> - +TEXTBUTTONS_WITH_GRAPHIC - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+LARGE_GRAPHIC_WITH_SOFTBUTTONS"> - +LARGE_GRAPHIC_WITH_SOFTBUTTONS - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+DOUBLE_GRAPHIC_WITH_SOFTBUTTONS"> - +DOUBLE_GRAPHIC_WITH_SOFTBUTTONS - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+LARGE_GRAPHIC_ONLY"> - +LARGE_GRAPHIC_ONLY - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLPrerecordedSpeech.html b/docs/Classes/SDLPrerecordedSpeech.html deleted file mode 100644 index 9601abc29..000000000 --- a/docs/Classes/SDLPrerecordedSpeech.html +++ /dev/null @@ -1,98 +0,0 @@ -<h1>SDLPrerecordedSpeech 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-+HELP_JINGLE">+HELP_JINGLE</a></li> - <li><a href="#section-+INITIAL_JINGLE">+INITIAL_JINGLE</a></li> - <li><a href="#section-+LISTEN_JINGLE">+LISTEN_JINGLE</a></li> - <li><a href="#section-+POSITIVE_JINGLE">+POSITIVE_JINGLE</a></li> - <li><a href="#section-+NEGATIVE_JINGLE">+NEGATIVE_JINGLE</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+HELP_JINGLE"> - +HELP_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+INITIAL_JINGLE"> - +INITIAL_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+LISTEN_JINGLE"> - +LISTEN_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+POSITIVE_JINGLE"> - +POSITIVE_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+NEGATIVE_JINGLE"> - +NEGATIVE_JINGLE - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLPresetBankCapabilities.html b/docs/Classes/SDLPresetBankCapabilities.html index 61cff40a5..bff9b7a51 100644 --- a/docs/Classes/SDLPresetBankCapabilities.html +++ b/docs/Classes/SDLPresetBankCapabilities.html @@ -3,8 +3,6 @@ <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-onScreenPresetsAvailable">onScreenPresetsAvailable</a></li> </ul> @@ -16,49 +14,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a newly allocated SDLPresetBankCapabilities 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 SDLPresetBankCapabilities object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-onScreenPresetsAvailable"> onScreenPresetsAvailable </h3> @@ -70,11 +25,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">onScreenPresetsAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">onScreenPresetsAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">onScreenPresetsAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">onScreenPresetsAvailable</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLPrimaryAudioSource.html b/docs/Classes/SDLPrimaryAudioSource.html deleted file mode 100644 index c868fc0ac..000000000 --- a/docs/Classes/SDLPrimaryAudioSource.html +++ /dev/null @@ -1,246 +0,0 @@ -<h1>SDLPrimaryAudioSource 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-+NO_SOURCE_SELECTED">+NO_SOURCE_SELECTED</a></li> - <li><a href="#section-+USB">+USB</a></li> - <li><a href="#section-+USB2">+USB2</a></li> - <li><a href="#section-+BLUETOOTH_STEREO_BTST">+BLUETOOTH_STEREO_BTST</a></li> - <li><a href="#section-+LINE_IN">+LINE_IN</a></li> - <li><a href="#section-+IPOD">+IPOD</a></li> - <li><a href="#section-+MOBILE_APP">+MOBILE_APP</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the current primary audio source of SDL (if selected).</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract get SDLPrimaryAudioSource according value string</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</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">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <h4>Parameters</h4> - <dl> - <dt>value</dt> - <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> - - - - <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>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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">NO_SOURCE_SELECTED</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">no_SOURCE_SELECTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">USB</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">usb</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">USB2</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">usb2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">BLUETOOTH_STEREO_BTST</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">bluetooth_STEREO_BTST</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">LINE_IN</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">line_IN</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">IPOD</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">ipod</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLPrimaryAudioSource</span> <span class="o">*</span><span class="p">)</span><span class="n">MOBILE_APP</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">mobile_APP</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLPrimaryAudioSource</span><span class="o">!</span></code></pre> - - - - <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..73d65c866 100644 --- a/docs/Classes/SDLProtocol.html +++ b/docs/Classes/SDLProtocol.html @@ -3,14 +3,11 @@ <h3>Section Contents</h3> <ul> - <li><a href="#section--sendStartSessionWithType:">-sendStartSessionWithType:</a></li> - <li><a href="#section--startServiceWithType:">-startServiceWithType:</a></li> - <li><a href="#section--startSecureServiceWithType:completionHandler:">-startSecureServiceWithType:completionHandler:</a></li> - <li><a href="#section--sendEndSessionWithType:">-sendEndSessionWithType:</a></li> + <li><a href="#section--startServiceWithType:payload:">-startServiceWithType:payload:</a></li> + <li><a href="#section--startSecureServiceWithType:payload:completionHandler:">-startSecureServiceWithType:payload:completionHandler:</a></li> <li><a href="#section--endServiceWithType:">-endServiceWithType:</a></li> <li><a href="#section--sendRPC:">-sendRPC:</a></li> <li><a href="#section--sendRPC:encrypted:error:">-sendRPC:encrypted:error:</a></li> - <li><a href="#section--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--handleBytesFromTransport:">-handleBytesFromTransport:</a></li> @@ -22,8 +19,8 @@ <section class="section task-group-section"> - <h3 id="section--sendStartSessionWithType:"> - -sendStartSessionWithType: + <h3 id="section--startServiceWithType:payload:"> + -startServiceWithType:payload: </h3> <p>Undocumented</p> @@ -33,30 +30,8 @@ - <h3 id="section--startServiceWithType:"> - -startServiceWithType: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--startSecureServiceWithType:completionHandler:"> - -startSecureServiceWithType:completionHandler: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--sendEndSessionWithType:"> - -sendEndSessionWithType: + <h3 id="section--startSecureServiceWithType:payload:completionHandler:"> + -startSecureServiceWithType:payload:completionHandler: </h3> <p>Undocumented</p> @@ -99,17 +74,6 @@ - <h3 id="section--sendRPCRequest:"> - -sendRPCRequest: - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--sendRawData:withServiceType:"> -sendRawData:withServiceType: </h3> diff --git a/docs/Classes/SDLProtocolHeader.html b/docs/Classes/SDLProtocolHeader.html index 666fd1185..e7156a404 100644 --- a/docs/Classes/SDLProtocolHeader.html +++ b/docs/Classes/SDLProtocolHeader.html @@ -7,7 +7,6 @@ <li><a href="#section-_size">_size</a></li> <li><a href="#section-version">version</a></li> <li><a href="#section-size">size</a></li> - <li><a href="#section-compressed">compressed</a></li> <li><a href="#section-encrypted">encrypted</a></li> <li><a href="#section-frameType">frameType</a></li> <li><a href="#section-serviceType">serviceType</a></li> @@ -19,6 +18,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> @@ -71,17 +71,6 @@ - <h3 id="section-compressed"> - compressed - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section-encrypted"> encrypted </h3> @@ -203,4 +192,15 @@ + <h3 id="section-+determineVersion:"> + +determineVersion: + </h3> + + <p>Undocumented</p> + + + + + + </section> diff --git a/docs/Classes/SDLProtocolMessage.html b/docs/Classes/SDLProtocolMessage.html index 0ae618063..e279666b2 100644 --- a/docs/Classes/SDLProtocolMessage.html +++ b/docs/Classes/SDLProtocolMessage.html @@ -10,7 +10,6 @@ <li><a href="#section--size">-size</a></li> <li><a href="#section--description">-description</a></li> <li><a href="#section--rpcDictionary">-rpcDictionary</a></li> - <li><a href="#section-+determineVersion:">+determineVersion:</a></li> </ul> <h3>Overview</h3> @@ -96,15 +95,4 @@ - <h3 id="section-+determineVersion:"> - +determineVersion: - </h3> - - <p>Undocumented</p> - - - - - - </section> diff --git a/docs/Classes/SDLProxy.html b/docs/Classes/SDLProxy.html index 10cab7bc6..182f7681b 100644 --- a/docs/Classes/SDLProxy.html +++ b/docs/Classes/SDLProxy.html @@ -6,26 +6,19 @@ <li><a href="#section-_version">_version</a></li> <li><a href="#section-_bulkSessionID">_bulkSessionID</a></li> <li><a href="#section-_isConnected">_isConnected</a></li> - <li><a href="#section-_alreadyDestructed">_alreadyDestructed</a></li> <li><a href="#section-protocol">protocol</a></li> <li><a href="#section-transport">transport</a></li> <li><a href="#section-proxyListeners">proxyListeners</a></li> <li><a href="#section-startSessionTimer">startSessionTimer</a></li> <li><a href="#section-debugConsoleGroupName">debugConsoleGroupName</a></li> <li><a href="#section-proxyVersion">proxyVersion</a></li> - <li><a href="#section-streamingMediaManager">streamingMediaManager</a></li> <li><a href="#section--initWithTransport:protocol:delegate:">-initWithTransport:protocol:delegate:</a></li> - <li><a href="#section--dispose">-dispose</a></li> <li><a href="#section--addDelegate:">-addDelegate:</a></li> <li><a href="#section--removeDelegate:">-removeDelegate:</a></li> <li><a href="#section--sendRPC:">-sendRPC:</a></li> - <li><a href="#section--sendRPCRequest:">-sendRPCRequest:</a></li> <li><a href="#section--handleRPCDictionary:">-handleRPCDictionary:</a></li> - <li><a href="#section--handleRpcMessage:">-handleRpcMessage:</a></li> <li><a href="#section--handleProtocolMessage:">-handleProtocolMessage:</a></li> <li><a href="#section--addSecurityManagers:forAppId:">-addSecurityManagers:forAppId:</a></li> - <li><a href="#section-+enableSiphonDebug">+enableSiphonDebug</a></li> - <li><a href="#section-+disableSiphonDebug">+disableSiphonDebug</a></li> <li><a href="#section--putFileStream:withRequest:">-putFileStream:withRequest:</a></li> </ul> @@ -68,17 +61,6 @@ - <h3 id="section-_alreadyDestructed"> - _alreadyDestructed - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section-protocol"> protocol </h3> @@ -145,17 +127,6 @@ - <h3 id="section-streamingMediaManager"> - streamingMediaManager - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--initWithTransport:protocol:delegate:"> -initWithTransport:protocol:delegate: </h3> @@ -167,17 +138,6 @@ - <h3 id="section--dispose"> - -dispose - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--addDelegate:"> -addDelegate: </h3> @@ -211,17 +171,6 @@ - <h3 id="section--sendRPCRequest:"> - -sendRPCRequest: - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--handleRPCDictionary:"> -handleRPCDictionary: </h3> @@ -233,17 +182,6 @@ - <h3 id="section--handleRpcMessage:"> - -handleRpcMessage: - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--handleProtocolMessage:"> -handleProtocolMessage: </h3> @@ -266,60 +204,34 @@ - <h3 id="section-+enableSiphonDebug"> - +enableSiphonDebug - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+disableSiphonDebug"> - +disableSiphonDebug - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--putFileStream:withRequest:"> -putFileStream:withRequest: </h3> <p>Puts data into a file on the module -@abstract Performs a putFile for a given input stream, performed in chunks, for handling very large files. -- 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> <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">putFileStream</span><span class="p">:(</span><span class="n">NSInputStream</span> <span class="o">*</span><span class="p">)</span><span class="nv">inputStream</span> - <span class="nf">withRequest</span><span class="p">:(</span><span class="n"><a href="../Classes/SDLPutFile.html">SDLPutFile</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">putFileRPCRequest</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">putFileStream</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSInputStream</span> <span class="o">*</span><span class="p">)</span><span class="nv">inputStream</span> + <span class="nf">withRequest</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLPutFile.html">SDLPutFile</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">putFileRPCRequest</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">putFileStream</span><span class="p">(</span><span class="n">_</span> <span class="nv">inputStream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="o">!</span><span class="p">,</span> <span class="n">withRequest</span> <span class="nv">putFileRPCRequest</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPutFile.html">SDLPutFile</a></span><span class="o">!</span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">putFileStream</span><span class="p">(</span><span class="n">_</span> <span class="nv">inputStream</span><span class="p">:</span> <span class="kt">InputStream</span><span class="p">,</span> <span class="n">withRequest</span> <span class="nv">putFileRPCRequest</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPutFile.html">SDLPutFile</a></span><span class="p">)</span></code></pre> <h4>Parameters</h4> <dl> <dt>inputStream</dt> - <dd><p>A stream containing the data to put to the module.</p> -</dd> + <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..192165952 100644 --- a/docs/Classes/SDLPutFile.html +++ b/docs/Classes/SDLPutFile.html @@ -3,8 +3,6 @@ <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--initWithFileName:fileType:">-initWithFileName:fileType:</a></li> <li><a href="#section--initWithFileName:fileType:persistentFile:">-initWithFileName:fileType:persistentFile:</a></li> <li><a href="#section--initWithFileName:fileType:persistentFile:systemFile:offset:length:">-initWithFileName:fileType:persistentFile:systemFile:offset:length:</a></li> @@ -21,54 +19,20 @@ <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 -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Constructs a new SDLPutFile 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 SDLPutFile object indicated by the dictionary parameter</p> +</div> - - - <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> - +<section class="section task-group-section"> <h3 id="section--initWithFileName:fileType:"> -initWithFileName:fileType: </h3> @@ -78,7 +42,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 +57,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 +72,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> @@ -125,11 +89,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">syncFileName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">syncFileName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">syncFileName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">syncFileName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -145,11 +109,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLFileType.html">SDLFileType</a></span> <span class="o">*</span><span class="n">fileType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">_Nonnull</span> <span class="n">fileType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fileType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLFileType.html">SDLFileType</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">fileType</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -171,11 +135,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">persistentFile</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">persistentFile</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">persistentFile</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">persistentFile</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -191,11 +156,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">systemFile</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">systemFile</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">systemFile</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">systemFile</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -211,11 +176,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">offset</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">offset</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">offset</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">offset</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -231,11 +196,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">length</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">length</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">length</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">length</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLPutFileResponse.html b/docs/Classes/SDLPutFileResponse.html index dbab7dffd..56ce2675c 100644 --- a/docs/Classes/SDLPutFileResponse.html +++ b/docs/Classes/SDLPutFileResponse.html @@ -3,8 +3,6 @@ <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-spaceAvailable">spaceAvailable</a></li> </ul> @@ -16,49 +14,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLPutFileResponse 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 new SDLPutFileResponse object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-spaceAvailable"> spaceAvailable </h3> @@ -68,7 +23,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/SDLRDSData.html b/docs/Classes/SDLRDSData.html new file mode 100644 index 000000000..4d9d3470f --- /dev/null +++ b/docs/Classes/SDLRDSData.html @@ -0,0 +1,204 @@ +<h1>SDLRDSData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithProgramService:radioText:clockText:programIdentification:programType:trafficProgramIdentification:trafficAnnouncementIdentification:region:">-initWithProgramService:radioText:clockText:programIdentification:programType:trafficProgramIdentification:trafficAnnouncementIdentification:region:</a></li> + <li><a href="#section-programService">programService</a></li> + <li><a href="#section-radioText">radioText</a></li> + <li><a href="#section-clockText">clockText</a></li> + <li><a href="#section-programIdentification">programIdentification</a></li> + <li><a href="#section-programType">programType</a></li> + <li><a href="#section-trafficProgramIdentification">trafficProgramIdentification</a></li> + <li><a href="#section-trafficAnnouncementIdentification">trafficAnnouncementIdentification</a></li> + <li><a href="#section-region">region</a></li> +</ul> + +<h3>Overview</h3> + +<p>Include the data defined in Radio Data System, +which is a communications protocol standard for embedding small amounts of digital information +in conventional FM radio broadcasts.</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithProgramService:radioText:clockText:programIdentification:programType:trafficProgramIdentification:trafficAnnouncementIdentification:region:"> + -initWithProgramService:radioText:clockText:programIdentification:programType:trafficProgramIdentification:trafficAnnouncementIdentification:region: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRDSData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section-programService"> + programService + </h3> + + <p>@abstract Program Service Name</p> + +<p>optional, 0-8</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">programService</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">programService</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> + + + + + <h3 id="section-radioText"> + radioText + </h3> + + <p>@abstract Radio Text</p> + +<p>optional, 0-64</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">radioText</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">radioText</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> + + + + + <h3 id="section-clockText"> + clockText + </h3> + + <p>@abstract The clock text in UTC format as YYYY-MM-DDThh:mm:ss.sTZD</p> + +<p>optional, 0-24</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">clockText</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">clockText</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> + + + + + <h3 id="section-programIdentification"> + programIdentification + </h3> + + <p>@abstract Program Identification - the call sign for the radio station</p> + +<p>optional, 0-6</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">nullable</span><span class="p">)</span> + <span class="n">NSString</span> <span class="o">*</span><span class="n">programIdentification</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">programIdentification</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> + + + + + <h3 id="section-programType"> + programType + </h3> + + <p>@abstract The program type - The region should be used to differentiate between EU + and North America program types</p> + +<p>optional, 0-31</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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">programType</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">programType</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-trafficProgramIdentification"> + trafficProgramIdentification + </h3> + + <p>@abstract Traffic Program Identification - Identifies a station that offers traffic</p> + +<p>optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">trafficProgramIdentification</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">trafficProgramIdentification</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-trafficAnnouncementIdentification"> + trafficAnnouncementIdentification + </h3> + + <p>@abstract Traffic Announcement Identification - Indicates an ongoing traffic announcement</p> + +<p>optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">trafficAnnouncementIdentification</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">trafficAnnouncementIdentification</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-region"> + region + </h3> + + <p>@abstract Region</p> + +<p>optional, 0-8</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">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">region</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">region</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> + + + + +</section> diff --git a/docs/Classes/SDLRPCNotification.html b/docs/Classes/SDLRPCNotification.html deleted file mode 100644 index 3b8920c18..000000000 --- a/docs/Classes/SDLRPCNotification.html +++ /dev/null @@ -1,38 +0,0 @@ -<h1>SDLRPCNotification Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section--initWithName:">-initWithName:</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--initWithName:"> - -initWithName: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLRPCNotificationNotification.html b/docs/Classes/SDLRPCNotificationNotification.html index 5d2589ae7..43b3ae5e3 100644 --- a/docs/Classes/SDLRPCNotificationNotification.html +++ b/docs/Classes/SDLRPCNotificationNotification.html @@ -5,6 +5,8 @@ <ul> <li><a href="#section-notification">notification</a></li> <li><a href="#section--initWithName:object:rpcNotification:">-initWithName:object:rpcNotification:</a></li> + <li><a href="#section--isNotificationMemberOfClass:">-isNotificationMemberOfClass:</a></li> + <li><a href="#section--isNotificationKindOfClass:">-isNotificationKindOfClass:</a></li> </ul> <h3>Overview</h3> @@ -35,4 +37,50 @@ + <h3 id="section--isNotificationMemberOfClass:"> + -isNotificationMemberOfClass: + </h3> + + <p>Returns whether or not the containing notification is equal to a class, not including subclasses.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isNotificationMemberOfClass</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">isNotificationMember</span><span class="p">(</span><span class="n">of</span> <span class="nv">aClass</span><span class="p">:</span> <span class="kt">AnyClass</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>aClass</dt> + <dd><p>the class you are questioning</p></dd> + </dl> + + <h3 id="section--isNotificationKindOfClass:"> + -isNotificationKindOfClass: + </h3> + + <p>Returns whether or not the containing notification is a kind of class, including subclasses.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isNotificationKindOfClass</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">isNotificationKind</span><span class="p">(</span><span class="n">of</span> <span class="nv">aClass</span><span class="p">:</span> <span class="kt">AnyClass</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>aClass</dt> + <dd><p>the class you are questioning</p></dd> + </dl> + </section> diff --git a/docs/Classes/SDLRPCRequestFactory.html b/docs/Classes/SDLRPCRequestFactory.html deleted file mode 100644 index b5282e7d0..000000000 --- a/docs/Classes/SDLRPCRequestFactory.html +++ /dev/null @@ -1,794 +0,0 @@ -<h1>SDLRPCRequestFactory Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:correlationID:">+buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:correlationID:</a></li> - <li><a href="#section-+buildAddCommandWithID:menuName:vrCommands:correlationID:">+buildAddCommandWithID:menuName:vrCommands:correlationID:</a></li> - <li><a href="#section-+buildAddCommandWithID:vrCommands:correlationID:">+buildAddCommandWithID:vrCommands:correlationID:</a></li> - <li><a href="#section-+buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:handler:">+buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:handler:</a></li> - <li><a href="#section-+buildAddCommandWithID:menuName:vrCommands:handler:">+buildAddCommandWithID:menuName:vrCommands:handler:</a></li> - <li><a href="#section-+buildAddCommandWithID:vrCommands:handler:">+buildAddCommandWithID:vrCommands:handler:</a></li> - <li><a href="#section-+buildAddSubMenuWithID:menuName:position:correlationID:">+buildAddSubMenuWithID:menuName:position:correlationID:</a></li> - <li><a href="#section-+buildAddSubMenuWithID:menuName:correlationID:">+buildAddSubMenuWithID:menuName:correlationID:</a></li> - <li><a href="#section-+buildAlertWithTTS:alertText1:alertText2:alertText3:playTone:duration:correlationID:">+buildAlertWithTTS:alertText1:alertText2:alertText3:playTone:duration:correlationID:</a></li> - <li><a href="#section-+buildAlertWithTTS:alertText1:alertText2:playTone:duration:correlationID:">+buildAlertWithTTS:alertText1:alertText2:playTone:duration:correlationID:</a></li> - <li><a href="#section-+buildAlertWithTTS:playTone:correlationID:">+buildAlertWithTTS:playTone:correlationID:</a></li> - <li><a href="#section-+buildAlertWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:correlationID:">+buildAlertWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:correlationID:</a></li> - <li><a href="#section-+buildAlertWithTTSChunks:playTone:correlationID:">+buildAlertWithTTSChunks:playTone:correlationID:</a></li> - <li><a href="#section-+buildAlertWithAlertText1:alertText2:alertText3:duration:softButtons:correlationID:">+buildAlertWithAlertText1:alertText2:alertText3:duration:softButtons:correlationID:</a></li> - <li><a href="#section-+buildAlertWithAlertText1:alertText2:alertText3:duration:correlationID:">+buildAlertWithAlertText1:alertText2:alertText3:duration:correlationID:</a></li> - <li><a href="#section-+buildAlertWithAlertText1:alertText2:duration:correlationID:">+buildAlertWithAlertText1:alertText2:duration:correlationID:</a></li> - <li><a href="#section-+buildAlertManeuverwithTTSchunks:softButtons:correlationID:">+buildAlertManeuverwithTTSchunks:softButtons:correlationID:</a></li> - <li><a href="#section-+buildChangeRegistrationWithLanguage:hmiDisplayLanguage:correlationID:">+buildChangeRegistrationWithLanguage:hmiDisplayLanguage:correlationID:</a></li> - <li><a href="#section-+buildCreateInteractionChoiceSetWithID:choiceSet:correlationID:">+buildCreateInteractionChoiceSetWithID:choiceSet:correlationID:</a></li> - <li><a href="#section-+buildDeleteCommandWithID:correlationID:">+buildDeleteCommandWithID:correlationID:</a></li> - <li><a href="#section-+buildDeleteFileWithName:correlationID:">+buildDeleteFileWithName:correlationID:</a></li> - <li><a href="#section-+buildDialNumberWithNumber:">+buildDialNumberWithNumber:</a></li> - <li><a href="#section-+buildListFilesWithCorrelationID:">+buildListFilesWithCorrelationID:</a></li> - <li><a href="#section-+buildDeleteInteractionChoiceSetWithID:correlationID:">+buildDeleteInteractionChoiceSetWithID:correlationID:</a></li> - <li><a href="#section-+buildDeleteSubMenuWithID:correlationID:">+buildDeleteSubMenuWithID:correlationID:</a></li> - <li><a href="#section-+buildEndAudioPassThruWithCorrelationID:">+buildEndAudioPassThruWithCorrelationID:</a></li> - <li><a href="#section-+buildGetDTCsWithECUName:correlationID:">+buildGetDTCsWithECUName:correlationID:</a></li> - <li><a href="#section-+buildGetVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:vin:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID:">+buildGetVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:vin:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID:</a></li> - <li><a href="#section-+buildPerformAudioPassThruWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:maxDuration:bitsPerSample:audioType:muteAudio:correlationID:">+buildPerformAudioPassThruWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:maxDuration:bitsPerSample:audioType:muteAudio:correlationID:</a></li> - <li><a href="#section-+buildPerformInteractionWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:correlationID:">+buildPerformInteractionWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:correlationID:</a></li> - <li><a href="#section-+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:vrHelp:correlationID:">+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:vrHelp:correlationID:</a></li> - <li><a href="#section-+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:correlationID:">+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:correlationID:</a></li> - <li><a href="#section-+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:correlationID:">+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:correlationID:</a></li> - <li><a href="#section-+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:correlationID:">+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:correlationID:</a></li> - <li><a href="#section-+buildPutFileWithFileName:fileType:persistentFile:correlationId:">+buildPutFileWithFileName:fileType:persistentFile:correlationId:</a></li> - <li><a href="#section-+buildPutFileWithFileName:fileType:persisistentFile:correlationID:">+buildPutFileWithFileName:fileType:persisistentFile:correlationID:</a></li> - <li><a href="#section-+buildReadDIDWithECUName:didLocation:correlationID:">+buildReadDIDWithECUName:didLocation:correlationID:</a></li> - <li><a href="#section-+buildRegisterAppInterfaceWithAppName:ttsName:vrSynonyms:isMediaApp:languageDesired:hmiDisplayLanguageDesired:appID:">+buildRegisterAppInterfaceWithAppName:ttsName:vrSynonyms:isMediaApp:languageDesired:hmiDisplayLanguageDesired:appID:</a></li> - <li><a href="#section-+buildRegisterAppInterfaceWithAppName:isMediaApp:languageDesired:appID:">+buildRegisterAppInterfaceWithAppName:isMediaApp:languageDesired:appID:</a></li> - <li><a href="#section-+buildRegisterAppInterfaceWithAppName:languageDesired:appID:">+buildRegisterAppInterfaceWithAppName:languageDesired:appID:</a></li> - <li><a href="#section-+buildResetGlobalPropertiesWithProperties:correlationID:">+buildResetGlobalPropertiesWithProperties:correlationID:</a></li> - <li><a href="#section-+buildSendLocationWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:">+buildSendLocationWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:</a></li> - <li><a href="#section-+buildScrollableMessage:timeout:softButtons:correlationID:">+buildScrollableMessage:timeout:softButtons:correlationID:</a></li> - <li><a href="#section-+buildSetAppIconWithFileName:correlationID:">+buildSetAppIconWithFileName:correlationID:</a></li> - <li><a href="#section-+buildSetDisplayLayout:correlationID:">+buildSetDisplayLayout:correlationID:</a></li> - <li><a href="#section-+buildSetGlobalPropertiesWithHelpText:timeoutText:vrHelpTitle:vrHelp:correlationID:">+buildSetGlobalPropertiesWithHelpText:timeoutText:vrHelpTitle:vrHelp:correlationID:</a></li> - <li><a href="#section-+buildSetGlobalPropertiesWithHelpText:timeoutText:correlationID:">+buildSetGlobalPropertiesWithHelpText:timeoutText:correlationID:</a></li> - <li><a href="#section-+buildSetMediaClockTimerWithHours:minutes:seconds:updateMode:correlationID:">+buildSetMediaClockTimerWithHours:minutes:seconds:updateMode:correlationID:</a></li> - <li><a href="#section-+buildSetMediaClockTimerWithUpdateMode:correlationID:">+buildSetMediaClockTimerWithUpdateMode:correlationID:</a></li> - <li><a href="#section-+buildShowWithMainField1:mainField2:mainField3:mainField4:statusBar:mediaClock:mediaTrack:alignment:graphic:softButtons:customPresets:correlationID:">+buildShowWithMainField1:mainField2:mainField3:mainField4:statusBar:mediaClock:mediaTrack:alignment:graphic:softButtons:customPresets:correlationID:</a></li> - <li><a href="#section-+buildShowWithMainField1:mainField2:statusBar:mediaClock:mediaTrack:alignment:correlationID:">+buildShowWithMainField1:mainField2:statusBar:mediaClock:mediaTrack:alignment:correlationID:</a></li> - <li><a href="#section-+buildShowWithMainField1:mainField2:alignment:correlationID:">+buildShowWithMainField1:mainField2:alignment:correlationID:</a></li> - <li><a href="#section-+buildSliderDynamicFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID:">+buildSliderDynamicFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID:</a></li> - <li><a href="#section-+buildSliderStaticFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID:">+buildSliderStaticFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID:</a></li> - <li><a href="#section-+buildSoftButtonWithType:text:image:highlighted:buttonID:systemAction:handler:">+buildSoftButtonWithType:text:image:highlighted:buttonID:systemAction:handler:</a></li> - <li><a href="#section-+buildSpeakWithTTSChunks:correlationID:">+buildSpeakWithTTSChunks:correlationID:</a></li> - <li><a href="#section-+buildSpeakWithTTS:correlationID:">+buildSpeakWithTTS:correlationID:</a></li> - <li><a href="#section-+buildSubscribeButtonWithName:correlationID:">+buildSubscribeButtonWithName:correlationID:</a></li> - <li><a href="#section-+buildSubscribeButtonWithName:handler:">+buildSubscribeButtonWithName:handler:</a></li> - <li><a href="#section-+buildSubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID:">+buildSubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID:</a></li> - <li><a href="#section-+buildShowConstantTBTWithString:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:correlationID:">+buildShowConstantTBTWithString:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:correlationID:</a></li> - <li><a href="#section-+buildUnregisterAppInterfaceWithCorrelationID:">+buildUnregisterAppInterfaceWithCorrelationID:</a></li> - <li><a href="#section-+buildUnsubscribeButtonWithName:correlationID:">+buildUnsubscribeButtonWithName:correlationID:</a></li> - <li><a href="#section-+buildUnsubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID:">+buildUnsubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID:</a></li> - <li><a href="#section-+buildUpdateTurnListWithTurnList:softButtons:correlationID:">+buildUpdateTurnListWithTurnList:softButtons:correlationID:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:correlationID:"> - +buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAddCommandWithID:menuName:vrCommands:correlationID:"> - +buildAddCommandWithID:menuName:vrCommands:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAddCommandWithID:vrCommands:correlationID:"> - +buildAddCommandWithID:vrCommands:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:handler:"> - +buildAddCommandWithID:menuName:parentID:position:vrCommands:iconValue:iconType:handler: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAddCommandWithID:menuName:vrCommands:handler:"> - +buildAddCommandWithID:menuName:vrCommands:handler: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAddCommandWithID:vrCommands:handler:"> - +buildAddCommandWithID:vrCommands:handler: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAddSubMenuWithID:menuName:position:correlationID:"> - +buildAddSubMenuWithID:menuName:position:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAddSubMenuWithID:menuName:correlationID:"> - +buildAddSubMenuWithID:menuName:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAlertWithTTS:alertText1:alertText2:alertText3:playTone:duration:correlationID:"> - +buildAlertWithTTS:alertText1:alertText2:alertText3:playTone:duration:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAlertWithTTS:alertText1:alertText2:playTone:duration:correlationID:"> - +buildAlertWithTTS:alertText1:alertText2:playTone:duration:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAlertWithTTS:playTone:correlationID:"> - +buildAlertWithTTS:playTone:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAlertWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:correlationID:"> - +buildAlertWithTTSChunks:alertText1:alertText2:alertText3:playTone:duration:softButtons:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAlertWithTTSChunks:playTone:correlationID:"> - +buildAlertWithTTSChunks:playTone:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAlertWithAlertText1:alertText2:alertText3:duration:softButtons:correlationID:"> - +buildAlertWithAlertText1:alertText2:alertText3:duration:softButtons:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAlertWithAlertText1:alertText2:alertText3:duration:correlationID:"> - +buildAlertWithAlertText1:alertText2:alertText3:duration:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAlertWithAlertText1:alertText2:duration:correlationID:"> - +buildAlertWithAlertText1:alertText2:duration:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildAlertManeuverwithTTSchunks:softButtons:correlationID:"> - +buildAlertManeuverwithTTSchunks:softButtons:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildChangeRegistrationWithLanguage:hmiDisplayLanguage:correlationID:"> - +buildChangeRegistrationWithLanguage:hmiDisplayLanguage:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildCreateInteractionChoiceSetWithID:choiceSet:correlationID:"> - +buildCreateInteractionChoiceSetWithID:choiceSet:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildDeleteCommandWithID:correlationID:"> - +buildDeleteCommandWithID:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildDeleteFileWithName:correlationID:"> - +buildDeleteFileWithName:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildDialNumberWithNumber:"> - +buildDialNumberWithNumber: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildListFilesWithCorrelationID:"> - +buildListFilesWithCorrelationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildDeleteInteractionChoiceSetWithID:correlationID:"> - +buildDeleteInteractionChoiceSetWithID:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildDeleteSubMenuWithID:correlationID:"> - +buildDeleteSubMenuWithID:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildEndAudioPassThruWithCorrelationID:"> - +buildEndAudioPassThruWithCorrelationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildGetDTCsWithECUName:correlationID:"> - +buildGetDTCsWithECUName:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildGetVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:vin:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID:"> - +buildGetVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:vin:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildPerformAudioPassThruWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:maxDuration:bitsPerSample:audioType:muteAudio:correlationID:"> - +buildPerformAudioPassThruWithInitialPrompt:audioPassThruDisplayText1:audioPassThruDisplayText2:samplingRate:maxDuration:bitsPerSample:audioType:muteAudio:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildPerformInteractionWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:correlationID:"> - +buildPerformInteractionWithInitialChunks:initialText:interactionChoiceSetIDList:helpChunks:timeoutChunks:interactionMode:timeout:vrHelp:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:vrHelp:correlationID:"> - +buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:vrHelp:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:correlationID:"> - +buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:vrHelp:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:correlationID:"> - +buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetIDList:helpPrompt:timeoutPrompt:interactionMode:timeout:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:correlationID:"> - +buildPerformInteractionWithInitialPrompt:initialText:interactionChoiceSetID:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildPutFileWithFileName:fileType:persistentFile:correlationId:"> - +buildPutFileWithFileName:fileType:persistentFile:correlationId: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildPutFileWithFileName:fileType:persisistentFile:correlationID:"> - +buildPutFileWithFileName:fileType:persisistentFile:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildReadDIDWithECUName:didLocation:correlationID:"> - +buildReadDIDWithECUName:didLocation:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildRegisterAppInterfaceWithAppName:ttsName:vrSynonyms:isMediaApp:languageDesired:hmiDisplayLanguageDesired:appID:"> - +buildRegisterAppInterfaceWithAppName:ttsName:vrSynonyms:isMediaApp:languageDesired:hmiDisplayLanguageDesired:appID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildRegisterAppInterfaceWithAppName:isMediaApp:languageDesired:appID:"> - +buildRegisterAppInterfaceWithAppName:isMediaApp:languageDesired:appID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildRegisterAppInterfaceWithAppName:languageDesired:appID:"> - +buildRegisterAppInterfaceWithAppName:languageDesired:appID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildResetGlobalPropertiesWithProperties:correlationID:"> - +buildResetGlobalPropertiesWithProperties:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSendLocationWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image:"> - +buildSendLocationWithLongitude:latitude:locationName:locationDescription:address:phoneNumber:image: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildScrollableMessage:timeout:softButtons:correlationID:"> - +buildScrollableMessage:timeout:softButtons:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSetAppIconWithFileName:correlationID:"> - +buildSetAppIconWithFileName:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSetDisplayLayout:correlationID:"> - +buildSetDisplayLayout:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSetGlobalPropertiesWithHelpText:timeoutText:vrHelpTitle:vrHelp:correlationID:"> - +buildSetGlobalPropertiesWithHelpText:timeoutText:vrHelpTitle:vrHelp:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSetGlobalPropertiesWithHelpText:timeoutText:correlationID:"> - +buildSetGlobalPropertiesWithHelpText:timeoutText:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSetMediaClockTimerWithHours:minutes:seconds:updateMode:correlationID:"> - +buildSetMediaClockTimerWithHours:minutes:seconds:updateMode:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSetMediaClockTimerWithUpdateMode:correlationID:"> - +buildSetMediaClockTimerWithUpdateMode:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildShowWithMainField1:mainField2:mainField3:mainField4:statusBar:mediaClock:mediaTrack:alignment:graphic:softButtons:customPresets:correlationID:"> - +buildShowWithMainField1:mainField2:mainField3:mainField4:statusBar:mediaClock:mediaTrack:alignment:graphic:softButtons:customPresets:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildShowWithMainField1:mainField2:statusBar:mediaClock:mediaTrack:alignment:correlationID:"> - +buildShowWithMainField1:mainField2:statusBar:mediaClock:mediaTrack:alignment:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildShowWithMainField1:mainField2:alignment:correlationID:"> - +buildShowWithMainField1:mainField2:alignment:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSliderDynamicFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID:"> - +buildSliderDynamicFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSliderStaticFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID:"> - +buildSliderStaticFooterWithNumTicks:position:sliderHeader:sliderFooter:timeout:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSoftButtonWithType:text:image:highlighted:buttonID:systemAction:handler:"> - +buildSoftButtonWithType:text:image:highlighted:buttonID:systemAction:handler: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSpeakWithTTSChunks:correlationID:"> - +buildSpeakWithTTSChunks:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSpeakWithTTS:correlationID:"> - +buildSpeakWithTTS:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSubscribeButtonWithName:correlationID:"> - +buildSubscribeButtonWithName:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSubscribeButtonWithName:handler:"> - +buildSubscribeButtonWithName:handler: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildSubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID:"> - +buildSubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildShowConstantTBTWithString:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:correlationID:"> - +buildShowConstantTBTWithString:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildUnregisterAppInterfaceWithCorrelationID:"> - +buildUnregisterAppInterfaceWithCorrelationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildUnsubscribeButtonWithName:correlationID:"> - +buildUnsubscribeButtonWithName:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildUnsubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID:"> - +buildUnsubscribeVehicleDataWithGPS:speed:rpm:fuelLevel:fuelLevelState:instantFuelConsumption:externalTemperature:prndl:tirePressure:odometer:beltStatus:bodyInformation:deviceStatus:driverBraking:wiperStatus:headLampStatus:engineTorque:accPedalPosition:steeringWheelAngle:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildUpdateTurnListWithTurnList:softButtons:correlationID:"> - +buildUpdateTurnListWithTurnList:softButtons:correlationID: - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLRPCResponseNotification.html b/docs/Classes/SDLRPCResponseNotification.html index c8125934f..7f3b61e2a 100644 --- a/docs/Classes/SDLRPCResponseNotification.html +++ b/docs/Classes/SDLRPCResponseNotification.html @@ -5,6 +5,8 @@ <ul> <li><a href="#section-response">response</a></li> <li><a href="#section--initWithName:object:rpcResponse:">-initWithName:object:rpcResponse:</a></li> + <li><a href="#section--isResponseMemberOfClass:">-isResponseMemberOfClass:</a></li> + <li><a href="#section--isResponseKindOfClass:">-isResponseKindOfClass:</a></li> </ul> <h3>Overview</h3> @@ -35,4 +37,50 @@ + <h3 id="section--isResponseMemberOfClass:"> + -isResponseMemberOfClass: + </h3> + + <p>Returns whether or not the containing response is equal to a class, not including subclasses.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isResponseMemberOfClass</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">isResponseMember</span><span class="p">(</span><span class="n">of</span> <span class="nv">aClass</span><span class="p">:</span> <span class="kt">AnyClass</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>aClass</dt> + <dd><p>the class you are questioning</p></dd> + </dl> + + <h3 id="section--isResponseKindOfClass:"> + -isResponseKindOfClass: + </h3> + + <p>Returns whether or not the containing response is a kind of class, including subclasses.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isResponseKindOfClass</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">isResponseKind</span><span class="p">(</span><span class="n">of</span> <span class="nv">aClass</span><span class="p">:</span> <span class="kt">AnyClass</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>aClass</dt> + <dd><p>the class you are questioning</p></dd> + </dl> + </section> diff --git a/docs/Classes/SDLRadioControlCapabilities.html b/docs/Classes/SDLRadioControlCapabilities.html new file mode 100644 index 000000000..e4cb66a38 --- /dev/null +++ b/docs/Classes/SDLRadioControlCapabilities.html @@ -0,0 +1,259 @@ +<h1>SDLRadioControlCapabilities Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:">-initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:</a></li> + <li><a href="#section-moduleName">moduleName</a></li> + <li><a href="#section-radioEnableAvailable">radioEnableAvailable</a></li> + <li><a href="#section-radioBandAvailable">radioBandAvailable</a></li> + <li><a href="#section-radioFrequencyAvailable">radioFrequencyAvailable</a></li> + <li><a href="#section-hdChannelAvailable">hdChannelAvailable</a></li> + <li><a href="#section-rdsDataAvailable">rdsDataAvailable</a></li> + <li><a href="#section-availableHDsAvailable">availableHDsAvailable</a></li> + <li><a href="#section-stateAvailable">stateAvailable</a></li> + <li><a href="#section-signalStrengthAvailable">signalStrengthAvailable</a></li> + <li><a href="#section-signalChangeThresholdAvailable">signalChangeThresholdAvailable</a></li> +</ul> + +<h3>Overview</h3> + +<p>Contains information about a radio control module’s capabilities.</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable:"> + -initWithModuleName:radioEnableAvailable:radioBandAvailable:radioFrequencyAvailable:hdChannelAvailable:rdsDataAvailable:availableHDsAvailable:stateAvailable:signalStrengthAvailable:signalChangeThresholdAvailable: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRadioControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section-moduleName"> + moduleName + </h3> + + <p>@abstract The short friendly name of the climate control module. + It should not be used to identify a module by mobile application.</p> + +<p>Max string length 100 chars</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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleName</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">moduleName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-radioEnableAvailable"> + radioEnableAvailable + </h3> + + <p>@abstract Availability of the control of enable/disable radio. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">radioEnableAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">radioEnableAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-radioBandAvailable"> + radioBandAvailable + </h3> + + <p>@abstract Availability of the control of radio band. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">radioBandAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">radioBandAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-radioFrequencyAvailable"> + radioFrequencyAvailable + </h3> + + <p>@abstract Availability of the control of radio frequency. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">radioFrequencyAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">radioFrequencyAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-hdChannelAvailable"> + hdChannelAvailable + </h3> + + <p>@abstract Availability of the control of HD radio channel. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">hdChannelAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">hdChannelAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-rdsDataAvailable"> + rdsDataAvailable + </h3> + + <p>@abstract Availability of the getting Radio Data System (RDS) data. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">rdsDataAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rdsDataAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-availableHDsAvailable"> + availableHDsAvailable + </h3> + + <p>@abstract Availability of the getting the number of available HD channels. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">availableHDsAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">availableHDsAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-stateAvailable"> + stateAvailable + </h3> + + <p>@abstract Availability of the getting the Radio state. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">stateAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">stateAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-signalStrengthAvailable"> + signalStrengthAvailable + </h3> + + <p>@abstract Availability of the getting the signal strength. + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">signalStrengthAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">signalStrengthAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-signalChangeThresholdAvailable"> + signalChangeThresholdAvailable + </h3> + + <p>@abstract Availability of the getting the signal Change Threshold + True: Available, False: Not Available, Not present: Not Available.</p> + +<p>Optional, Boolean</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">signalChangeThresholdAvailable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">signalChangeThresholdAvailable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + +</section> diff --git a/docs/Classes/SDLRadioControlData.html b/docs/Classes/SDLRadioControlData.html new file mode 100644 index 000000000..6643ba759 --- /dev/null +++ b/docs/Classes/SDLRadioControlData.html @@ -0,0 +1,271 @@ +<h1>SDLRadioControlData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:">-initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:</a></li> + <li><a href="#section-frequencyInteger">frequencyInteger</a></li> + <li><a href="#section-frequencyFraction">frequencyFraction</a></li> + <li><a href="#section-band">band</a></li> + <li><a href="#section-rdsData">rdsData</a></li> + <li><a href="#section-availableHDs">availableHDs</a></li> + <li><a href="#section-hdChannel">hdChannel</a></li> + <li><a href="#section-signalStrength">signalStrength</a></li> + <li><a href="#section-signalChangeThreshold">signalChangeThreshold</a></li> + <li><a href="#section-radioEnable">radioEnable</a></li> + <li><a href="#section-state">state</a></li> +</ul> + +<h3>Overview</h3> + +<p>Include information (both read-only and changeable data) about a remote control radio module.</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable:"> + -initWithFrequencyInteger:frequencyFraction:band:hdChannel:radioEnable: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRadioControlData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + + + + + + <h3 id="section-frequencyInteger"> + frequencyInteger + </h3> + + <p>@abstract The integer part of the frequency ie for 101.7 this value should be 101</p> + +<p>Integer</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">frequencyInteger</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">frequencyInteger</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-frequencyFraction"> + frequencyFraction + </h3> + + <p>@abstract The fractional part of the frequency for 101.7 is 7</p> + +<p>Integer</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">frequencyFraction</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">frequencyFraction</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-band"> + band + </h3> + + <p>@abstract Radio band value</p> + +<p>SDLRadioBand</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLRadioBand.h@T@SDLRadioBand">SDLRadioBand</a></span> <span class="n">band</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">band</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLRadioBand.h@T@SDLRadioBand">SDLRadioBand</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-rdsData"> + rdsData + </h3> + + <p>@abstract Read only parameter. See RDSData data type for details.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + This property is readonly and cannot be set on the module. + +</div> + +<p>SDLRDSData</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLRDSData.html">SDLRDSData</a></span> <span class="o">*</span><span class="n">rdsData</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rdsData</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLRDSData.html">SDLRDSData</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-availableHDs"> + availableHDs + </h3> + + <p>@abstract number of HD sub-channels if available</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + This property is readonly and cannot be set on the module. + +</div> + +<p>Integer value Min Value - 1 Max Value -3</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">availableHDs</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">availableHDs</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-hdChannel"> + hdChannel + </h3> + + <p>@abstract Current HD sub-channel if available</p> + +<p>Integer value Min Value - 1 Max Value -3</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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">hdChannel</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">hdChannel</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-signalStrength"> + signalStrength + </h3> + + <p>@abstract Signal Strength Value</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + This property is readonly and cannot be set on the module. + +</div> + +<p>Integer value Min Value - 0 Max Value - 100</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">signalStrength</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">signalStrength</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-signalChangeThreshold"> + signalChangeThreshold + </h3> + + <p>@abstract If the signal strength falls below the set value for this parameter, the radio will tune to an alternative frequency</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + This property is readonly and cannot be set on the module. + +</div> + +<p>Integer value Min Value - 0 Max Value - 100</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">signalChangeThreshold</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">signalChangeThreshold</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-radioEnable"> + radioEnable + </h3> + + <p>@abstract True if the radio is on, false is the radio is off. When the radio is disabled, no data other than radioEnable is included in a GetInteriorVehicleData response</p> + +<p>Boolean value</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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">radioEnable</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">radioEnable</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + + <h3 id="section-state"> + state + </h3> + + <p>Read only parameter. See RadioState data type for details.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + This property is readonly and cannot be set on the module. + +</div> + +<p>SDLRadioState</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">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLRadioState.h@T@SDLRadioState">SDLRadioState</a></span> <span class="n">state</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">state</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLRadioState.h@T@SDLRadioState">SDLRadioState</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> + + + + +</section> diff --git a/docs/Classes/SDLReadDID.html b/docs/Classes/SDLReadDID.html index 92f196740..5a59fb149 100644 --- a/docs/Classes/SDLReadDID.html +++ b/docs/Classes/SDLReadDID.html @@ -3,8 +3,6 @@ <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--initWithECUName:didLocation:">-initWithECUName:didLocation:</a></li> <li><a href="#section-ecuName">ecuName</a></li> <li><a href="#section-didLocation">didLocation</a></li> @@ -25,49 +23,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLReadDID 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 new SDLReadDID object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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--initWithECUName:didLocation:"> -initWithECUName:didLocation: </h3> @@ -77,7 +32,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> @@ -93,11 +48,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">ecuName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">ecuName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">ecuName</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ecuName</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -119,11 +74,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">didLocation</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">didLocation</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">didLocation</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">didLocation</span><span class="p">:</span> <span class="p">[</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLReadDIDResponse.html b/docs/Classes/SDLReadDIDResponse.html index 1bd6eb9b4..1222e3ccf 100644 --- a/docs/Classes/SDLReadDIDResponse.html +++ b/docs/Classes/SDLReadDIDResponse.html @@ -3,8 +3,6 @@ <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-didResult">didResult</a></li> </ul> @@ -16,36 +14,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - <h3 id="section-didResult"> didResult </h3> @@ -55,7 +23,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..40eba6b0d --- /dev/null +++ b/docs/Classes/SDLRectangle.html @@ -0,0 +1,147 @@ +<h1>SDLRectangle Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <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--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="kt">float</span><span class="p">)</span><span class="nv">x</span> + <span class="nf">y</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">y</span> + <span class="nf">width</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">width</span> + <span class="nf">height</span><span class="p">:(</span><span class="kt">float</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">Float</span><span class="p">,</span> <span class="nv">y</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">height</span><span class="p">:</span> <span class="kt">Float</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">Any</span><span class="o">!</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 X-coordinate of the user control +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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">x</span><span class="p">;</span></code></pre> + + + + + + <h3 id="section-y"> + y + </h3> + + <p>The Y-coordinate of the user control +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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">y</span><span class="p">;</span></code></pre> + + + + + + <h3 id="section-width"> + width + </h3> + + <p>The width of the user control’s bounding 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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">width</span><span class="p">;</span></code></pre> + + + + + + <h3 id="section-height"> + height + </h3> + + <p>The height of the user control’s bounding 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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">height</span><span class="p">;</span></code></pre> + + + + + +</section> diff --git a/docs/Classes/SDLRegisterAppInterface.html b/docs/Classes/SDLRegisterAppInterface.html index bd39e42f9..0abe2e9d2 100644 --- a/docs/Classes/SDLRegisterAppInterface.html +++ b/docs/Classes/SDLRegisterAppInterface.html @@ -3,8 +3,6 @@ <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--initWithLifecycleConfiguration:">-initWithLifecycleConfiguration:</a></li> <li><a href="#section--initWithAppName:appId:languageDesired:">-initWithAppName:appId:languageDesired:</a></li> <li><a href="#section--initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:">-initWithAppName:appId:languageDesired:isMediaApp:appType:shortAppName:</a></li> @@ -93,7 +91,6 @@ </p></p> <p>@since SDL 1.0</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLUnregisterAppInterface SDLOnAppInterfaceUnregistered @@ -102,48 +99,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLRegisterAppInterface 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 new SDLRegisterAppInterface 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--initWithLifecycleConfiguration:"> -initWithLifecycleConfiguration: </h3> @@ -153,7 +108,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 +123,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 +138,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 +153,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> @@ -215,11 +170,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span> <span class="o">*</span><span class="n">syncMsgVersion</span><span class="p">;</span></code></pre> + <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/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">syncMsgVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">syncMsgVersion</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span><span class="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">syncMsgVersion</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -242,11 +198,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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="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">appName</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -264,17 +220,22 @@ <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> <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">ttsName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">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="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> + <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> @@ -292,11 +253,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">ngnMediaScreenAppName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSString</span> <span class="o">*</span><span class="n">ngnMediaScreenAppName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">ngnMediaScreenAppName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ngnMediaScreenAppName</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> @@ -314,11 +276,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">vrSynonyms</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">vrSynonyms</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrSynonyms</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrSynonyms</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -336,11 +299,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">isMediaApplication</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">isMediaApplication</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">isMediaApplication</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isMediaApplication</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -358,11 +322,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">languageDesired</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">_Nonnull</span> <span class="n">languageDesired</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">languageDesired</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">languageDesired</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -382,11 +346,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">hmiDisplayLanguageDesired</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">_Nonnull</span> <span class="n">hmiDisplayLanguageDesired</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hmiDisplayLanguageDesired</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">hmiDisplayLanguageDesired</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -399,17 +364,22 @@ <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> <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">appHMIType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="o">></span> <span class="o">*</span><span class="n">appHMIType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">appHMIType</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">appHMIType</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLAppHMIType.h@T@SDLAppHMIType">SDLAppHMIType</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -429,11 +399,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hashID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hashID</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hashID</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">hashID</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> @@ -449,11 +419,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDeviceInfo.html">SDLDeviceInfo</a></span> <span class="o">*</span><span class="n">deviceInfo</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDeviceInfo.html">SDLDeviceInfo</a></span> <span class="o">*</span><span class="n">deviceInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceInfo</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeviceInfo.html">SDLDeviceInfo</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">deviceInfo</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeviceInfo.html">SDLDeviceInfo</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> @@ -471,11 +441,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appID</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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="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">appID</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -491,11 +461,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAppInfo.html">SDLAppInfo</a></span> <span class="o">*</span><span class="n">appInfo</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLAppInfo.html">SDLAppInfo</a></span> <span class="o">*</span><span class="n">appInfo</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">appInfo</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAppInfo.html">SDLAppInfo</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">appInfo</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAppInfo.html">SDLAppInfo</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> diff --git a/docs/Classes/SDLRegisterAppInterfaceResponse.html b/docs/Classes/SDLRegisterAppInterfaceResponse.html index 0e6952057..fc9d9affd 100644 --- a/docs/Classes/SDLRegisterAppInterfaceResponse.html +++ b/docs/Classes/SDLRegisterAppInterfaceResponse.html @@ -3,8 +3,6 @@ <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-syncMsgVersion">syncMsgVersion</a></li> <li><a href="#section-language">language</a></li> <li><a href="#section-hmiDisplayLanguage">hmiDisplayLanguage</a></li> @@ -17,6 +15,7 @@ <li><a href="#section-prerecordedSpeech">prerecordedSpeech</a></li> <li><a href="#section-vrCapabilities">vrCapabilities</a></li> <li><a href="#section-audioPassThruCapabilities">audioPassThruCapabilities</a></li> + <li><a href="#section-pcmStreamCapabilities">pcmStreamCapabilities</a></li> <li><a href="#section-vehicleType">vehicleType</a></li> <li><a href="#section-supportedDiagModes">supportedDiagModes</a></li> <li><a href="#section-hmiCapabilities">hmiCapabilities</a></li> @@ -32,50 +31,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLRegisterAppInterfaceResponse 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 SDLRegisterAppInterfaceResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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-syncMsgVersion"> syncMsgVersion </h3> @@ -91,11 +46,12 @@ parameter <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/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span> <span class="o">*</span><span class="n">syncMsgVersion</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span> <span class="o">*</span><span class="n">syncMsgVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">syncMsgVersion</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span><span class="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">syncMsgVersion</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</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> @@ -105,7 +61,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 @@ -117,11 +72,11 @@ parameter <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/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">language</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">language</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLLanguage.html">SDLLanguage</a></span><span class="o">!</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">language</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -131,7 +86,6 @@ parameter </h3> <p>The currently active display language on Sync</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLLanguage @@ -144,11 +98,12 @@ parameter <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/SDLLanguage.html">SDLLanguage</a></span> <span class="o">*</span><span class="n">hmiDisplayLanguage</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">hmiDisplayLanguage</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hmiDisplayLanguage</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">hmiDisplayLanguage</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -168,12 +123,12 @@ parameter <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> + <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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</a></span> <span class="o">*</span><span class="n">displayCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">displayCapabilities</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</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">displayCapabilities</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</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> @@ -193,11 +148,12 @@ parameter <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">buttonCapabilities</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonCapabilities</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -207,7 +163,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 @@ -219,11 +174,12 @@ parameter <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">softButtonCapabilities</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtonCapabilities</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtonCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButtonCapabilities.html">SDLSoftButtonCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -233,7 +189,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 @@ -245,12 +200,12 @@ parameter <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> + <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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</a></span> <span class="o">*</span><span class="n">presetBankCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">presetBankCapabilities</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</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">presetBankCapabilities</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLPresetBankCapabilities.html">SDLPresetBankCapabilities</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> @@ -270,11 +225,12 @@ parameter <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">hmiZoneCapabilities</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLHMIZoneCapabilities.h@T@SDLHMIZoneCapabilities">SDLHMIZoneCapabilities</a></span><span class="o">></span> <span class="o">*</span><span class="n">hmiZoneCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hmiZoneCapabilities</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">hmiZoneCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLHMIZoneCapabilities.h@T@SDLHMIZoneCapabilities">SDLHMIZoneCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -294,11 +250,12 @@ parameter <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">speechCapabilities</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="o">></span> <span class="o">*</span><span class="n">speechCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">speechCapabilities</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">speechCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -318,11 +275,12 @@ parameter <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">prerecordedSpeech</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span><span class="o">></span> <span class="o">*</span><span class="n">prerecordedSpeech</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">prerecordedSpeech</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">prerecordedSpeech</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLPrerecordedSpeech.h@T@SDLPrerecordedSpeech">SDLPrerecordedSpeech</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -342,11 +300,12 @@ parameter <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">vrCapabilities</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLVrCapabilities.h@T@SDLVRCapabilities">SDLVRCapabilities</a></span><span class="o">></span> <span class="o">*</span><span class="n">vrCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrCapabilities</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLVrCapabilities.h@T@SDLVRCapabilities">SDLVRCapabilities</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> @@ -366,11 +325,35 @@ parameter <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">audioPassThruCapabilities</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">audioPassThruCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioPassThruCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-pcmStreamCapabilities"> + pcmStreamCapabilities + </h3> + + <div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAudioPassThruCapabilities + +</div> + + + + <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">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span> <span class="o">*</span><span class="n">pcmStreamCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">audioPassThruCapabilities</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">pcmStreamCapabilities</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAudioPassThruCapabilities.html">SDLAudioPassThruCapabilities</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -380,7 +363,6 @@ parameter </h3> <p>Specifies the vehicle’s type</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLVehicleType @@ -392,11 +374,11 @@ parameter <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/SDLVehicleType.html">SDLVehicleType</a></span> <span class="o">*</span><span class="n">vehicleType</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleType.html">SDLVehicleType</a></span> <span class="o">*</span><span class="n">vehicleType</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vehicleType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleType.html">SDLVehicleType</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">vehicleType</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleType.html">SDLVehicleType</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> @@ -412,11 +394,12 @@ parameter <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">supportedDiagModes</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">supportedDiagModes</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">supportedDiagModes</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">supportedDiagModes</span><span class="p">:</span> <span class="p">[</span><span class="kt">NSNumber</span> </code></pre> @@ -436,11 +419,12 @@ parameter <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/SDLHMICapabilities.html">SDLHMICapabilities</a></span> <span class="o">*</span><span class="n">hmiCapabilities</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLHMICapabilities.html">SDLHMICapabilities</a></span> <span class="o">*</span><span class="n">hmiCapabilities</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hmiCapabilities</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHMICapabilities.html">SDLHMICapabilities</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">hmiCapabilities</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLHMICapabilities.html">SDLHMICapabilities</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> @@ -456,11 +440,11 @@ parameter <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">NSString</span> <span class="o">*</span><span class="n">sdlVersion</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">sdlVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">sdlVersion</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">sdlVersion</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> @@ -476,11 +460,12 @@ parameter <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">NSString</span> <span class="o">*</span><span class="n">systemSoftwareVersion</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSString</span> <span class="o">*</span><span class="n">systemSoftwareVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">systemSoftwareVersion</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">systemSoftwareVersion</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> diff --git a/docs/Classes/SDLRemoteControlCapabilities.html b/docs/Classes/SDLRemoteControlCapabilities.html new file mode 100644 index 000000000..182d700d3 --- /dev/null +++ b/docs/Classes/SDLRemoteControlCapabilities.html @@ -0,0 +1,94 @@ +<h1>SDLRemoteControlCapabilities Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:">-initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:</a></li> + <li><a href="#section-climateControlCapabilities">climateControlCapabilities</a></li> + <li><a href="#section-radioControlCapabilities">radioControlCapabilities</a></li> + <li><a href="#section-buttonCapabilities">buttonCapabilities</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities:"> + -initWithClimateControlCapabilities:radioControlCapabilities:buttonCapabilities: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-climateControlCapabilities"> + climateControlCapabilities + </h3> + + <p>@abstract If included, the platform supports RC climate controls. + For this baseline version, maxsize=1. i.e. only one climate control module is supported.</p> + +<p>Optional, Array of SDLClimateControlCapabilities, Array length 1 - 100</p> + + + + <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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">climateControlCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">climateControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-radioControlCapabilities"> + radioControlCapabilities + </h3> + + <p>@abstract If included, the platform supports RC radio controls. + For this baseline version, maxsize=1. i.e. only one radio control module is supported.</p> + +<p>Optional, Array of SDLRadioControlCapabilities, Array length 1 - 100</p> + + + + <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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">radioControlCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">radioControlCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-buttonCapabilities"> + buttonCapabilities + </h3> + + <p>@abstract If included, the platform supports RC button controls with the included button names.</p> + +<p>Optional, Array of SDLButtonCapabilities, Array length 1 - 100</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">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonCapabilities</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> diff --git a/docs/Classes/SDLRequestType.html b/docs/Classes/SDLRequestType.html deleted file mode 100644 index bba9dbe05..000000000 --- a/docs/Classes/SDLRequestType.html +++ /dev/null @@ -1,278 +0,0 @@ -<h1>SDLRequestType 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-+HTTP">+HTTP</a></li> - <li><a href="#section-+FILE_RESUME">+FILE_RESUME</a></li> - <li><a href="#section-+AUTH_REQUEST">+AUTH_REQUEST</a></li> - <li><a href="#section-+AUTH_CHALLENGE">+AUTH_CHALLENGE</a></li> - <li><a href="#section-+AUTH_ACK">+AUTH_ACK</a></li> - <li><a href="#section-+PROPRIETARY">+PROPRIETARY</a></li> - <li><a href="#section-+QUERY_APPS">+QUERY_APPS</a></li> - <li><a href="#section-+LAUNCH_APP">+LAUNCH_APP</a></li> - <li><a href="#section-+LOCK_SCREEN_ICON_URL">+LOCK_SCREEN_ICON_URL</a></li> - <li><a href="#section-+TRAFFIC_MESSAGE_CHANNEL">+TRAFFIC_MESSAGE_CHANNEL</a></li> - <li><a href="#section-+DRIVER_PROFILE">+DRIVER_PROFILE</a></li> - <li><a href="#section-+VOICE_SEARCH">+VOICE_SEARCH</a></li> - <li><a href="#section-+NAVIGATION">+NAVIGATION</a></li> - <li><a href="#section-+PHONE">+PHONE</a></li> - <li><a href="#section-+CLIMATE">+CLIMATE</a></li> - <li><a href="#section-+SETTINGS">+SETTINGS</a></li> - <li><a href="#section-+VEHICLE_DIAGNOSTICS">+VEHICLE_DIAGNOSTICS</a></li> - <li><a href="#section-+EMERGENCY">+EMERGENCY</a></li> - <li><a href="#section-+MEDIA">+MEDIA</a></li> - <li><a href="#section-+FOTA">+FOTA</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+HTTP"> - +HTTP - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+FILE_RESUME"> - +FILE_RESUME - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+AUTH_REQUEST"> - +AUTH_REQUEST - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+AUTH_CHALLENGE"> - +AUTH_CHALLENGE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+AUTH_ACK"> - +AUTH_ACK - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+PROPRIETARY"> - +PROPRIETARY - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+QUERY_APPS"> - +QUERY_APPS - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+LAUNCH_APP"> - +LAUNCH_APP - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+LOCK_SCREEN_ICON_URL"> - +LOCK_SCREEN_ICON_URL - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+TRAFFIC_MESSAGE_CHANNEL"> - +TRAFFIC_MESSAGE_CHANNEL - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+DRIVER_PROFILE"> - +DRIVER_PROFILE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+VOICE_SEARCH"> - +VOICE_SEARCH - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+NAVIGATION"> - +NAVIGATION - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+PHONE"> - +PHONE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+CLIMATE"> - +CLIMATE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+SETTINGS"> - +SETTINGS - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+VEHICLE_DIAGNOSTICS"> - +VEHICLE_DIAGNOSTICS - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+EMERGENCY"> - +EMERGENCY - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+MEDIA"> - +MEDIA - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+FOTA"> - +FOTA - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLResetGlobalProperties.html b/docs/Classes/SDLResetGlobalProperties.html index 6b7927a57..3cb741268 100644 --- a/docs/Classes/SDLResetGlobalProperties.html +++ b/docs/Classes/SDLResetGlobalProperties.html @@ -3,8 +3,6 @@ <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--initWithProperties:">-initWithProperties:</a></li> <li><a href="#section-properties">properties</a></li> </ul> @@ -28,50 +26,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLResetGlobalProperties 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 new SDLResetGlobalProperties object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--initWithProperties:"> -initWithProperties: </h3> @@ -81,7 +35,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> @@ -97,11 +51,12 @@ indicating which global properties to reset to their default value</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">properties</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">properties</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">properties</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">properties</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Type Definitions.html#/c:SDLGlobalProperty.h@T@SDLGlobalProperty">SDLGlobalProperty</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> diff --git a/docs/Classes/SDLResetGlobalPropertiesResponse.html b/docs/Classes/SDLResetGlobalPropertiesResponse.html deleted file mode 100644 index 70436d317..000000000 --- a/docs/Classes/SDLResetGlobalPropertiesResponse.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLResetGlobalPropertiesResponse 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>Reset Global Properties Response is sent, when SDLResetGlobalProperties has been called</p> - -<p>Since SmartDeviceLink 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLResetGlobalPropertiesResponse 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 new SDLResetGlobalPropertiesResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLResult.html b/docs/Classes/SDLResult.html deleted file mode 100644 index 84ddc5bf3..000000000 --- a/docs/Classes/SDLResult.html +++ /dev/null @@ -1,711 +0,0 @@ -<h1>SDLResult 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-+SUCCESS">+SUCCESS</a></li> - <li><a href="#section-+INVALID_DATA">+INVALID_DATA</a></li> - <li><a href="#section-+CHAR_LIMIT_EXCEEDED">+CHAR_LIMIT_EXCEEDED</a></li> - <li><a href="#section-+UNSUPPORTED_REQUEST">+UNSUPPORTED_REQUEST</a></li> - <li><a href="#section-+OUT_OF_MEMORY">+OUT_OF_MEMORY</a></li> - <li><a href="#section-+TOO_MANY_PENDING_REQUESTS">+TOO_MANY_PENDING_REQUESTS</a></li> - <li><a href="#section-+INVALID_ID">+INVALID_ID</a></li> - <li><a href="#section-+DUPLICATE_NAME">+DUPLICATE_NAME</a></li> - <li><a href="#section-+TOO_MANY_APPLICATIONS">+TOO_MANY_APPLICATIONS</a></li> - <li><a href="#section-+APPLICATION_REGISTERED_ALREADY">+APPLICATION_REGISTERED_ALREADY</a></li> - <li><a href="#section-+UNSUPPORTED_VERSION">+UNSUPPORTED_VERSION</a></li> - <li><a href="#section-+WRONG_LANGUAGE">+WRONG_LANGUAGE</a></li> - <li><a href="#section-+APPLICATION_NOT_REGISTERED">+APPLICATION_NOT_REGISTERED</a></li> - <li><a href="#section-+IN_USE">+IN_USE</a></li> - <li><a href="#section-+VEHICLE_DATA_NOT_ALLOWED">+VEHICLE_DATA_NOT_ALLOWED</a></li> - <li><a href="#section-+VEHICLE_DATA_NOT_AVAILABLE">+VEHICLE_DATA_NOT_AVAILABLE</a></li> - <li><a href="#section-+REJECTED">+REJECTED</a></li> - <li><a href="#section-+ABORTED">+ABORTED</a></li> - <li><a href="#section-+IGNORED">+IGNORED</a></li> - <li><a href="#section-+UNSUPPORTED_RESOURCE">+UNSUPPORTED_RESOURCE</a></li> - <li><a href="#section-+FILE_NOT_FOUND">+FILE_NOT_FOUND</a></li> - <li><a href="#section-+GENERIC_ERROR">+GENERIC_ERROR</a></li> - <li><a href="#section-+DISALLOWED">+DISALLOWED</a></li> - <li><a href="#section-+USER_DISALLOWED">+USER_DISALLOWED</a></li> - <li><a href="#section-+TIMED_OUT">+TIMED_OUT</a></li> - <li><a href="#section-+CANCEL_ROUTE">+CANCEL_ROUTE</a></li> - <li><a href="#section-+TRUNCATED_DATA">+TRUNCATED_DATA</a></li> - <li><a href="#section-+RETRY">+RETRY</a></li> - <li><a href="#section-+WARNINGS">+WARNINGS</a></li> - <li><a href="#section-+SAVED">+SAVED</a></li> - <li><a href="#section-+INVALID_CERT">+INVALID_CERT</a></li> - <li><a href="#section-+EXPIRED_CERT">+EXPIRED_CERT</a></li> - <li><a href="#section-+RESUME_FAILED">+RESUME_FAILED</a></li> -</ul> - -<h3>Overview</h3> - -<p>Defines the possible result codes returned by SDL to the application in a response to a requested operation</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</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">SDLResult</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>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> - - - - <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>the array</p> - - </div> - - <h3 id="section-+SUCCESS"> - +SUCCESS - </h3> - - <p>@abstract The request succeeded</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">SUCCESS</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">success</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+INVALID_DATA"> - +INVALID_DATA - </h3> - - <p>@abstract Result code : Invalid Data</p> - -<p>@discussion The data sent is invalid. For example: - <li>Invalid Json syntax</li> - <li>Parameters out of bounds (number or enum range)</li> - <li>Mandatory parameters not provided</li> - <li>Parameter provided with wrong type</li> - <li>Invalid characters</li> - <li>Empty string</li></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">INVALID_DATA</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">invalid_DATA</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+CHAR_LIMIT_EXCEEDED"> - +CHAR_LIMIT_EXCEEDED - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section-+UNSUPPORTED_REQUEST"> - +UNSUPPORTED_REQUEST - </h3> - - <p>@abstract The request is not supported by SDL</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">UNSUPPORTED_REQUEST</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">unsupported_REQUEST</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+OUT_OF_MEMORY"> - +OUT_OF_MEMORY - </h3> - - <p>@abstract The system could not process the request because the necessary memory couldn’t be allocated</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">OUT_OF_MEMORY</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">out_OF_MEMORY</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+TOO_MANY_PENDING_REQUESTS"> - +TOO_MANY_PENDING_REQUESTS - </h3> - - <p>@abstract There are too many requests pending (means that the response has not been delivered yet).</p> - -<p>@discussion There is a limit of 1000 pending requests at a time.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">TOO_MANY_PENDING_REQUESTS</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">too_MANY_PENDING_REQUESTS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+INVALID_ID"> - +INVALID_ID - </h3> - - <p>@abstract One of the provided IDs is not valid. -@discussion For example: -<li>CorrelationID</li> -<li>CommandID</li> -<li>MenuID</li></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">INVALID_ID</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">invalid_ID</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+DUPLICATE_NAME"> - +DUPLICATE_NAME - </h3> - - <p>@abstract The provided name or synonym is a duplicate of some already-defined name or synonym.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">DUPLICATE_NAME</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">duplicate_NAME</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+TOO_MANY_APPLICATIONS"> - +TOO_MANY_APPLICATIONS - </h3> - - <p>There are already too many registered applications.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">TOO_MANY_APPLICATIONS</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">too_MANY_APPLICATIONS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+APPLICATION_REGISTERED_ALREADY"> - +APPLICATION_REGISTERED_ALREADY - </h3> - - <p>RegisterApplication has been called again, after a RegisterApplication was successful before.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">APPLICATION_REGISTERED_ALREADY</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">application_REGISTERED_ALREADY</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+UNSUPPORTED_VERSION"> - +UNSUPPORTED_VERSION - </h3> - - <p>The Head Unit doesn’t support the protocol that is requested by the mobile application.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">UNSUPPORTED_VERSION</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">unsupported_VERSION</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+WRONG_LANGUAGE"> - +WRONG_LANGUAGE - </h3> - - <p>The requested language is currently not supported. Might be because of a mismatch of the currently active language on the head unit and the requested language.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">WRONG_LANGUAGE</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">wrong_LANGUAGE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+APPLICATION_NOT_REGISTERED"> - +APPLICATION_NOT_REGISTERED - </h3> - - <p>A command can not be executed because no application has been registered with RegisterApplication.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">APPLICATION_NOT_REGISTERED</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">application_NOT_REGISTERED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+IN_USE"> - +IN_USE - </h3> - - <p>The data may not be changed, because it is currently in use. For example when trying to delete a command set that is currently involved in an interaction.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">IN_USE</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">in_USE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLE_DATA_NOT_ALLOWED"> - +VEHICLE_DATA_NOT_ALLOWED - </h3> - - <p>The user has turned off access to vehicle data, and it is globally unavailable to mobile applications.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLE_DATA_NOT_ALLOWED</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">vehicle_DATA_NOT_ALLOWED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLE_DATA_NOT_AVAILABLE"> - +VEHICLE_DATA_NOT_AVAILABLE - </h3> - - <p>The requested vehicle data is not available on this vehicle or is not published.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLE_DATA_NOT_AVAILABLE</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">vehicle_DATA_NOT_AVAILABLE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+REJECTED"> - +REJECTED - </h3> - - <p>The requested command was rejected, e.g. because mobile app is in background and cannot perform any HMI commands. Or an HMI command (e.g. Speak) is rejected because a higher priority HMI command (e.g. Alert) is playing.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">REJECTED</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">rejected</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ABORTED"> - +ABORTED - </h3> - - <p>A command was aborted, for example due to user interaction (e.g. user pressed button). Or an HMI command (e.g. Speak) is aborted because a higher priority HMI command (e.g. Alert) was requested.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">ABORTED</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">aborted</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+IGNORED"> - +IGNORED - </h3> - - <p>A command was ignored, because the intended result is already in effect. For example, SetMediaClockTimer was used to pause the media clock although the clock is paused already.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">IGNORED</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">ignored</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+UNSUPPORTED_RESOURCE"> - +UNSUPPORTED_RESOURCE - </h3> - - <p>A button that was requested for subscription is not supported under the current system.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">UNSUPPORTED_RESOURCE</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">unsupported_RESOURCE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+FILE_NOT_FOUND"> - +FILE_NOT_FOUND - </h3> - - <p>A specified file could not be found on the head unit.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">FILE_NOT_FOUND</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">file_NOT_FOUND</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+GENERIC_ERROR"> - +GENERIC_ERROR - </h3> - - <p>Provided data is valid but something went wrong in the lower layers.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">GENERIC_ERROR</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">generic_ERROR</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+DISALLOWED"> - +DISALLOWED - </h3> - - <p>RPC is not authorized in local policy table.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">DISALLOWED</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">disallowed</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+USER_DISALLOWED"> - +USER_DISALLOWED - </h3> - - <p>RPC is included in a functional group explicitly blocked by the user.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">USER_DISALLOWED</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">user_DISALLOWED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+TIMED_OUT"> - +TIMED_OUT - </h3> - - <p>Overlay reached the maximum timeout and closed.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">TIMED_OUT</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">timed_OUT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+CANCEL_ROUTE"> - +CANCEL_ROUTE - </h3> - - <p>User selected to Cancel Route.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">CANCEL_ROUTE</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">cancel_ROUTE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+TRUNCATED_DATA"> - +TRUNCATED_DATA - </h3> - - <p>The RPC (e.g. ReadDID) executed successfully but the data exceeded the platform maximum threshold and thus, only part of the data is available.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">TRUNCATED_DATA</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">truncated_DATA</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+RETRY"> - +RETRY - </h3> - - <p>The user interrupted the RPC (e.g. PerformAudioPassThru) and indicated to start over. Note, the app must issue the new RPC.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">RETRY</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">retry</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+WARNINGS"> - +WARNINGS - </h3> - - <p>The RPC (e.g. SubscribeVehicleData) executed successfully but one or more items have a warning or failure.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">WARNINGS</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">warnings</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+SAVED"> - +SAVED - </h3> - - <p>The RPC (e.g. Slider) executed successfully and the user elected to save the current position / value.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">SAVED</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">saved</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+INVALID_CERT"> - +INVALID_CERT - </h3> - - <p>The certificate provided during authentication is invalid.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">INVALID_CERT</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">invalid_CERT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+EXPIRED_CERT"> - +EXPIRED_CERT - </h3> - - <p>The certificate provided during authentication is expired.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">EXPIRED_CERT</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">expired_CERT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+RESUME_FAILED"> - +RESUME_FAILED - </h3> - - <p>The provided hash ID does not match the hash of the current set of registered data or the core could not resume the previous data.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLResult</span> <span class="o">*</span><span class="p">)</span><span class="n">RESUME_FAILED</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">resume_FAILED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLResult</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLSamplingRate.html b/docs/Classes/SDLSamplingRate.html deleted file mode 100644 index 4ff708fbc..000000000 --- a/docs/Classes/SDLSamplingRate.html +++ /dev/null @@ -1,166 +0,0 @@ -<h1>SDLSamplingRate 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-+_8KHZ">+_8KHZ</a></li> - <li><a href="#section-+_16KHZ">+_16KHZ</a></li> - <li><a href="#section-+_22KHZ">+_22KHZ</a></li> - <li><a href="#section-+_44KHZ">+_44KHZ</a></li> -</ul> - -<h3>Overview</h3> - -<p>Describes different sampling rates for PerformAudioPassThru</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract get SDLSamplingRate according value string</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSamplingRate</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">SDLSamplingRate</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>SDLSamplingRate object</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract declare an array to store all possible SDLSamplingRate 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>the array</p> - - </div> - - <h3 id="section-+_8KHZ"> - +_8KHZ - </h3> - - <p>@abstract Sampling rate of 8 kHz</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSamplingRate</span> <span class="o">*</span><span class="p">)</span><span class="n">_8KHZ</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">_8KHZ</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSamplingRate</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SamplingRate of <em>8KHZ</em></p> - - </div> - - <h3 id="section-+_16KHZ"> - +_16KHZ - </h3> - - <p>@abstract Sampling rate of 16 kHz</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSamplingRate</span> <span class="o">*</span><span class="p">)</span><span class="n">_16KHZ</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">_16KHZ</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSamplingRate</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SamplingRate of <em>16KHZ</em></p> - - </div> - - <h3 id="section-+_22KHZ"> - +_22KHZ - </h3> - - <p>@abstract Sampling rate of 22 kHz</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSamplingRate</span> <span class="o">*</span><span class="p">)</span><span class="n">_22KHZ</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">_22KHZ</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSamplingRate</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SamplingRate of <em>22KHZ</em></p> - - </div> - - <h3 id="section-+_44KHZ"> - +_44KHZ - </h3> - - <p>@abstract Sampling rate of 44 kHz</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSamplingRate</span> <span class="o">*</span><span class="p">)</span><span class="n">_44KHZ</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">_44KHZ</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSamplingRate</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SamplingRate of <em>44KHZ</em></p> - - </div> - -</section> diff --git a/docs/Classes/SDLScreenParams.html b/docs/Classes/SDLScreenParams.html index 6f9aec01a..c38304d36 100644 --- a/docs/Classes/SDLScreenParams.html +++ b/docs/Classes/SDLScreenParams.html @@ -3,8 +3,6 @@ <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-resolution">resolution</a></li> <li><a href="#section-touchEventAvailable">touchEventAvailable</a></li> </ul> @@ -15,28 +13,6 @@ <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-resolution"> resolution </h3> diff --git a/docs/Classes/SDLScrollableMessage.html b/docs/Classes/SDLScrollableMessage.html index 18b0a9fc8..7b32549c5 100644 --- a/docs/Classes/SDLScrollableMessage.html +++ b/docs/Classes/SDLScrollableMessage.html @@ -3,8 +3,6 @@ <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--initWithMessage:">-initWithMessage:</a></li> <li><a href="#section--initWithMessage:timeout:softButtons:">-initWithMessage:timeout:softButtons:</a></li> <li><a href="#section-scrollableMessageBody">scrollableMessageBody</a></li> @@ -24,50 +22,6 @@ Function Group: ScrollableMessage <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLScrollableMessage 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 new SDLScrollableMessage object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--initWithMessage:"> -initWithMessage: </h3> @@ -77,7 +31,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 +46,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> @@ -111,11 +65,12 @@ parameter <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">NSString</span> <span class="o">*</span><span class="n">scrollableMessageBody</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">scrollableMessageBody</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">scrollableMessageBody</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">scrollableMessageBody</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -133,11 +88,11 @@ last action <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">timeout</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeout</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeout</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -156,11 +111,12 @@ system defined <q>Close</q> SoftButton will be displayed <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">softButtons</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtons</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</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> diff --git a/docs/Classes/SDLScrollableMessageResponse.html b/docs/Classes/SDLScrollableMessageResponse.html deleted file mode 100644 index 72aa85c97..000000000 --- a/docs/Classes/SDLScrollableMessageResponse.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLScrollableMessageResponse 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>Scrollable Message Response is sent, when SDLScrollableMessage has been called</p> - -<p>Since SmartDeviceLink 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLScrollableMessageResponse 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 new SDLScrollableMessageResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLSendHapticData.html b/docs/Classes/SDLSendHapticData.html new file mode 100644 index 000000000..770e142b7 --- /dev/null +++ b/docs/Classes/SDLSendHapticData.html @@ -0,0 +1,61 @@ +<h1>SDLSendHapticData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <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--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">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHapticRectData</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">hapticRectData</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">hapticRectData</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span><span class="p">])</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>hapticRectData</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">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/SDLHapticRect.html">SDLHapticRect</a></span> <span class="o">*></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="p">[</span><span class="kt"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</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> + + + + +</section> diff --git a/docs/Classes/SDLSendLocation.html b/docs/Classes/SDLSendLocation.html index 1214449c2..1005cf7de 100644 --- a/docs/Classes/SDLSendLocation.html +++ b/docs/Classes/SDLSendLocation.html @@ -56,11 +56,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">longitudeDegrees</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">longitudeDegrees</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">longitudeDegrees</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">longitudeDegrees</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -76,11 +77,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">latitudeDegrees</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">latitudeDegrees</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">latitudeDegrees</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> + <pre class="highlight"><code><span class="kd">@NSCopying</span> <span class="k">var</span> <span class="nv">latitudeDegrees</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -96,11 +98,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locationName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locationName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationName</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> @@ -116,11 +118,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locationDescription</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">locationDescription</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationDescription</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationDescription</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> @@ -136,11 +138,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">addressLines</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">addressLines</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">addressLines</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">]</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">addressLines</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> @@ -156,11 +159,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">phoneNumber</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">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">phoneNumber</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">phoneNumber</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">phoneNumber</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> @@ -176,11 +179,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">locationImage</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">locationImage</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">locationImage</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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">locationImage</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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> @@ -196,11 +199,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDeliveryMode.html">SDLDeliveryMode</a></span> <span class="o">*</span><span class="n">deliveryMode</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</a></span> <span class="n">deliveryMode</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">deliveryMode</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDeliveryMode.html">SDLDeliveryMode</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">deliveryMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</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> @@ -216,11 +219,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="n">timeStamp</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="n">timeStamp</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeStamp</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDateTime.html">SDLDateTime</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">timeStamp</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDateTime.html">SDLDateTime</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> @@ -236,11 +239,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="n">address</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="n">address</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">address</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</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">address</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLOasisAddress.html">SDLOasisAddress</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> diff --git a/docs/Classes/SDLSendLocationResponse.html b/docs/Classes/SDLSendLocationResponse.html deleted file mode 100644 index 64e84f81d..000000000 --- a/docs/Classes/SDLSendLocationResponse.html +++ /dev/null @@ -1,38 +0,0 @@ -<h1>SDLSendLocationResponse 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..1efb99767 100644 --- a/docs/Classes/SDLSetAppIcon.html +++ b/docs/Classes/SDLSetAppIcon.html @@ -3,8 +3,6 @@ <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--initWithFileName:">-initWithFileName:</a></li> <li><a href="#section-syncFileName">syncFileName</a></li> </ul> @@ -19,49 +17,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSetAppIcon 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 new SDLSetAppIcon object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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--initWithFileName:"> -initWithFileName: </h3> @@ -71,7 +26,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> @@ -89,11 +44,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">syncFileName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">syncFileName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">syncFileName</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">syncFileName</span><span class="p">:</span> <span class="kt">String</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/SDLSetAppIconResponse.html b/docs/Classes/SDLSetAppIconResponse.html deleted file mode 100644 index 81ee865eb..000000000 --- a/docs/Classes/SDLSetAppIconResponse.html +++ /dev/null @@ -1,47 +0,0 @@ -<h1>SDLSetAppIconResponse 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>SDLSetAppIconResponse is sent, when SDLSetAppIcon has been called. - * Since<b>SmartDeviceLink 2.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLSetDisplayLayout.html b/docs/Classes/SDLSetDisplayLayout.html index 96828e60f..ac9effe19 100644 --- a/docs/Classes/SDLSetDisplayLayout.html +++ b/docs/Classes/SDLSetDisplayLayout.html @@ -3,8 +3,6 @@ <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--initWithPredefinedLayout:">-initWithPredefinedLayout:</a></li> <li><a href="#section--initWithLayout:">-initWithLayout:</a></li> <li><a href="#section-displayLayout">displayLayout</a></li> @@ -19,50 +17,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSetDisplayLayout 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 new SDLSetDisplayLayout object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--initWithPredefinedLayout:"> -initWithPredefinedLayout: </h3> @@ -72,7 +26,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 +41,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> @@ -105,11 +59,11 @@ presets. Currently defined for GEN2</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">NSString</span> <span class="o">*</span><span class="n">displayLayout</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">displayLayout</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">displayLayout</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">displayLayout</span><span class="p">:</span> <span class="kt">String</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/SDLSetDisplayLayoutResponse.html b/docs/Classes/SDLSetDisplayLayoutResponse.html index cf7eece72..85a18e236 100644 --- a/docs/Classes/SDLSetDisplayLayoutResponse.html +++ b/docs/Classes/SDLSetDisplayLayoutResponse.html @@ -3,8 +3,6 @@ <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-displayCapabilities">displayCapabilities</a></li> <li><a href="#section-buttonCapabilities">buttonCapabilities</a></li> <li><a href="#section-softButtonCapabilities">softButtonCapabilities</a></li> @@ -19,39 +17,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSetDisplayLayoutResponse 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>Undocumented</p> - - - - <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> - - - - - <h3 id="section-displayCapabilities"> displayCapabilities </h3> @@ -61,7 +26,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 +41,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 +56,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 +71,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..7dd45a5da 100644 --- a/docs/Classes/SDLSetGlobalProperties.html +++ b/docs/Classes/SDLSetGlobalProperties.html @@ -3,8 +3,6 @@ <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--initWithHelpText:timeoutText:">-initWithHelpText:timeoutText:</a></li> <li><a href="#section--initWithHelpText:timeoutText:vrHelpTitle:vrHelp:">-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:</a></li> <li><a href="#section--initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:">-initWithHelpText:timeoutText:vrHelpTitle:vrHelp:menuTitle:menuIcon:keyboardProperties:</a></li> @@ -30,50 +28,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSetGlobalProperties 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 new SDLSetGlobalProperties object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--initWithHelpText:timeoutText:"> -initWithHelpText:timeoutText: </h3> @@ -83,7 +37,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 +52,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 +67,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> @@ -138,11 +92,12 @@ started by PTT <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">helpPrompt</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">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">helpPrompt</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">helpPrompt</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">helpPrompt</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> @@ -158,11 +113,12 @@ started by PTT <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">timeoutPrompt</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">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">timeoutPrompt</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeoutPrompt</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeoutPrompt</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> @@ -188,11 +144,11 @@ started by PTT <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">NSString</span> <span class="o">*</span><span class="n">vrHelpTitle</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">vrHelpTitle</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrHelpTitle</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrHelpTitle</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> @@ -223,11 +179,12 @@ started by PTT <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">vrHelp</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">vrHelp</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrHelp</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">vrHelp</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVRHelpItem.html">SDLVRHelpItem</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> @@ -241,7 +198,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 +213,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 +228,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 deleted file mode 100644 index 1f1a78ea6..000000000 --- a/docs/Classes/SDLSetGlobalPropertiesResponse.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLSetGlobalPropertiesResponse 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>Set Global Properties Response is sent, when SDLSetGlobalProperties has been called</p> - -<p>Since SmartDeviceLink 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSetGlobalPropertiesResponse 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 new SDLSetGlobalPropertiesResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLSetInteriorVehicleData.html b/docs/Classes/SDLSetInteriorVehicleData.html new file mode 100644 index 000000000..6f970b22e --- /dev/null +++ b/docs/Classes/SDLSetInteriorVehicleData.html @@ -0,0 +1,50 @@ +<h1>SDLSetInteriorVehicleData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithModuleData:">-initWithModuleData:</a></li> + <li><a href="#section-moduleData">moduleData</a></li> +</ul> + +<h3>Overview</h3> + +<p>This RPC allows a remote control type mobile application to +change the settings of a specific remote control module.</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithModuleData:"> + -initWithModuleData: + </h3> + + <p>Undocumented</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSetInteriorVehicleData</span> <span class="p">:</span> <span class="nc"><a href="../Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + + + + + + <h3 id="section-moduleData"> + moduleData + </h3> + + <p>The module data to set for the requested RC module.</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/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleData</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">moduleData</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLModuleData.html">SDLModuleData</a></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/SDLSetInteriorVehicleDataResponse.html b/docs/Classes/SDLSetInteriorVehicleDataResponse.html new file mode 100644 index 000000000..855a708de --- /dev/null +++ b/docs/Classes/SDLSetInteriorVehicleDataResponse.html @@ -0,0 +1,33 @@ +<h1>SDLSetInteriorVehicleDataResponse Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-moduleData">moduleData</a></li> +</ul> + +<h3>Overview</h3> + +<p>Used to set the values of one remote control module</p> + + +<section class="section task-group-section"> + <h3 id="section-moduleData"> + moduleData + </h3> + + <p>The module data to set for the requested remote control module.</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/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">moduleData</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">moduleData</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLModuleData.html">SDLModuleData</a></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/SDLSetMediaClockTimer.html b/docs/Classes/SDLSetMediaClockTimer.html index 0c69cbe6d..c3db6c049 100644 --- a/docs/Classes/SDLSetMediaClockTimer.html +++ b/docs/Classes/SDLSetMediaClockTimer.html @@ -3,8 +3,6 @@ <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--initWithUpdateMode:hours:minutes:seconds:">-initWithUpdateMode:hours:minutes:seconds:</a></li> <li><a href="#section--initWithUpdateMode:">-initWithUpdateMode:</a></li> <li><a href="#section-startTime">startTime</a></li> @@ -25,50 +23,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSetMediaClockTimer 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 new SDLSetMediaClockTimer object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--initWithUpdateMode:hours:minutes:seconds:"> -initWithUpdateMode:hours:minutes:seconds: </h3> @@ -78,7 +32,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 +47,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> @@ -117,11 +71,11 @@ parameter <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/SDLStartTime.html">SDLStartTime</a></span> <span class="o">*</span><span class="n">startTime</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLStartTime.html">SDLStartTime</a></span> <span class="o">*</span><span class="n">startTime</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">startTime</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLStartTime.html">SDLStartTime</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">startTime</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLStartTime.html">SDLStartTime</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> @@ -137,11 +91,11 @@ parameter <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/SDLStartTime.html">SDLStartTime</a></span> <span class="o">*</span><span class="n">endTime</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLStartTime.html">SDLStartTime</a></span> <span class="o">*</span><span class="n">endTime</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">endTime</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLStartTime.html">SDLStartTime</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">endTime</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLStartTime.html">SDLStartTime</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> @@ -165,11 +119,11 @@ parameter <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/SDLUpdateMode.html">SDLUpdateMode</a></span> <span class="o">*</span><span class="n">updateMode</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode">SDLUpdateMode</a></span> <span class="n">_Nonnull</span> <span class="n">updateMode</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">updateMode</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLUpdateMode.html">SDLUpdateMode</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">updateMode</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLUpdateMode.h@T@SDLUpdateMode">SDLUpdateMode</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/SDLSetMediaClockTimerResponse.html b/docs/Classes/SDLSetMediaClockTimerResponse.html deleted file mode 100644 index 427d2b9de..000000000 --- a/docs/Classes/SDLSetMediaClockTimerResponse.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLSetMediaClockTimerResponse 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>Set Media Clock Timer Response is sent, when SDLSetMediaClockTimer has been called</p> - -<p>Since SmartDeviceLink 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSetMediaClockTimerResponse 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 new SDLSetMediaClockTimerResponse object indicated by the NSMutableDictionary - parameter - <p></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> - -</section> diff --git a/docs/Classes/SDLShow.html b/docs/Classes/SDLShow.html index 4bbbe2185..69345b399 100644 --- a/docs/Classes/SDLShow.html +++ b/docs/Classes/SDLShow.html @@ -3,12 +3,12 @@ <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--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 +21,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> @@ -48,51 +49,38 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init + <h3 id="section--initWithMainField1:mainField2:alignment:"> + -initWithMainField1:mainField2:alignment: </h3> - <p>@abstract Constructs a new SDLShow object</p> + <p>Undocumented</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> + <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> - <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 id="section--initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment:"> + -initWithMainField1:mainField1Type:mainField2:mainField2Type:alignment: </h3> - <p>@abstract Constructs a new SDLShow object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>Undocumented</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> + <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> - <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--initWithMainField1:mainField2:alignment:"> - -initWithMainField1:mainField2:alignment: + <h3 id="section--initWithMainField1:mainField2:mainField3:mainField4:alignment:"> + -initWithMainField1:mainField2:mainField3:mainField4:alignment: </h3> <p>Undocumented</p> @@ -100,14 +88,14 @@ <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:"> - -initWithMainField1:mainField2:mainField3:mainField4:alignment: + <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> @@ -115,7 +103,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> @@ -130,14 +118,14 @@ <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:"> - -initWithMainField1:mainField2:mainField3:mainField4:alignment:statusBar:mediaClock:mediaTrack:graphic:softButtons:customPresets: + <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> @@ -145,7 +133,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> @@ -172,11 +160,11 @@ line in a two-line display <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">NSString</span> <span class="o">*</span><span class="n">mainField1</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</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">String</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">mainField1</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> @@ -204,11 +192,11 @@ line in a two-line display <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">NSString</span> <span class="o">*</span><span class="n">mainField2</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</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">String</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">mainField2</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> @@ -237,11 +225,11 @@ line in a two-line display <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">NSString</span> <span class="o">*</span><span class="n">mainField3</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</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">String</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">mainField3</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> @@ -270,11 +258,11 @@ line in a two-line display <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">NSString</span> <span class="o">*</span><span class="n">mainField4</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</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">String</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">mainField4</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> @@ -300,11 +288,11 @@ line in a two-line display <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/SDLTextAlignment.html">SDLTextAlignment</a></span> <span class="o">*</span><span class="n">alignment</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span> <span class="n">alignment</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">alignment</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTextAlignment.html">SDLTextAlignment</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">alignment</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</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> @@ -332,11 +320,11 @@ line in a two-line display <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">NSString</span> <span class="o">*</span><span class="n">statusBar</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">statusBar</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">statusBar</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">statusBar</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> @@ -363,11 +351,11 @@ line in a two-line display <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">NSString</span> <span class="o">*</span><span class="n">mediaClock</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">mediaClock</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">mediaClock</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">mediaClock</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> @@ -390,11 +378,11 @@ line in a two-line display <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">NSString</span> <span class="o">*</span><span class="n">mediaTrack</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">mediaTrack</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">mediaTrack</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">mediaTrack</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> @@ -414,11 +402,11 @@ line in a two-line display <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/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">graphic</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">graphic</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">graphic</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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">graphic</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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> @@ -438,11 +426,11 @@ line in a two-line display <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/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">secondaryGraphic</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">secondaryGraphic</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">secondaryGraphic</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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">secondaryGraphic</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImage.html">SDLImage</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> @@ -469,11 +457,12 @@ line in a two-line display <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">softButtons</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtons</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</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> @@ -497,11 +486,38 @@ line in a two-line display <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">customPresets</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">customPresets</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">customPresets</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> + + + + + <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">nonatomic</span><span class="p">,</span> <span class="n">nullable</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">customPresets</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> + <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="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/SDLShowConstantTBT.html b/docs/Classes/SDLShowConstantTBT.html index 6e19d631e..db614ddb0 100644 --- a/docs/Classes/SDLShowConstantTBT.html +++ b/docs/Classes/SDLShowConstantTBT.html @@ -3,8 +3,6 @@ <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--initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:">-initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:</a></li> <li><a href="#section-navigationText1">navigationText1</a></li> <li><a href="#section-navigationText2">navigationText2</a></li> @@ -21,44 +19,17 @@ <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"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - +<section class="section task-group-section"> <h3 id="section--initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons:"> -initWithNavigationText1:navigationText2:eta:timeToDestination:totalDistance:turnIcon:nextTurnIcon:distanceToManeuver:distanceToManeuverScale:maneuverComplete:softButtons: </h3> @@ -68,7 +39,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 +54,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 +69,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 +84,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 +99,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 +114,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 +129,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 +144,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 +159,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 +174,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 +189,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 +204,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 deleted file mode 100644 index d80b92985..000000000 --- a/docs/Classes/SDLShowConstantTBTResponse.html +++ /dev/null @@ -1,47 +0,0 @@ -<h1>SDLShowConstantTBTResponse 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>SDLShowConstantTBTResponse is sent, when SDLShowConstantTBT has been called. - * Since<b>SmartDeviceLink 2.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLShowResponse.html b/docs/Classes/SDLShowResponse.html deleted file mode 100644 index 9cc9d6d86..000000000 --- a/docs/Classes/SDLShowResponse.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLShowResponse 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>Show Response is sent, when Show has been called</p> - -<p>Since SmartDeviceLink 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLShowResponse 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 new SDLShowResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLSingleTireStatus.html b/docs/Classes/SDLSingleTireStatus.html index 039c901f3..827ca11b3 100644 --- a/docs/Classes/SDLSingleTireStatus.html +++ b/docs/Classes/SDLSingleTireStatus.html @@ -3,8 +3,6 @@ <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-status">status</a></li> </ul> @@ -16,49 +14,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a newly allocated SDLSingleTireStatus 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 SDLSingleTireStatus object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-status"> status </h3> @@ -68,11 +23,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLComponentVolumeStatus.html">SDLComponentVolumeStatus</a></span> <span class="o">*</span><span class="n">status</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLComponentVolumeStatus.h@T@SDLComponentVolumeStatus">SDLComponentVolumeStatus</a></span> <span class="n">_Nonnull</span> <span class="n">status</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">status</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLComponentVolumeStatus.html">SDLComponentVolumeStatus</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">status</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLComponentVolumeStatus.h@T@SDLComponentVolumeStatus">SDLComponentVolumeStatus</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/SDLSiphonServer.html b/docs/Classes/SDLSiphonServer.html deleted file mode 100644 index 680d50eb9..000000000 --- a/docs/Classes/SDLSiphonServer.html +++ /dev/null @@ -1,122 +0,0 @@ -<h1>SDLSiphonServer Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+enableSiphonDebug">+enableSiphonDebug</a></li> - <li><a href="#section-+disableSiphonDebug">+disableSiphonDebug</a></li> - <li><a href="#section-+_siphonRawTransportDataFromApp:msgBytesLength:">+_siphonRawTransportDataFromApp:msgBytesLength:</a></li> - <li><a href="#section-+_siphonRawTransportDataFromSDL:msgBytesLength:">+_siphonRawTransportDataFromSDL:msgBytesLength:</a></li> - <li><a href="#section-+_siphonNSLogData:">+_siphonNSLogData:</a></li> - <li><a href="#section-+_siphonFormattedTraceData:">+_siphonFormattedTraceData:</a></li> - <li><a href="#section-+_siphonIsActive">+_siphonIsActive</a></li> - <li><a href="#section-+init">+init</a></li> - <li><a href="#section-+dealloc">+dealloc</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+enableSiphonDebug"> - +enableSiphonDebug - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+disableSiphonDebug"> - +disableSiphonDebug - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+_siphonRawTransportDataFromApp:msgBytesLength:"> - +_siphonRawTransportDataFromApp:msgBytesLength: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+_siphonRawTransportDataFromSDL:msgBytesLength:"> - +_siphonRawTransportDataFromSDL:msgBytesLength: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+_siphonNSLogData:"> - +_siphonNSLogData: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+_siphonFormattedTraceData:"> - +_siphonFormattedTraceData: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+_siphonIsActive"> - +_siphonIsActive - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+init"> - +init - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+dealloc"> - +dealloc - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLSlider.html b/docs/Classes/SDLSlider.html index 5e5f76893..7081948b0 100644 --- a/docs/Classes/SDLSlider.html +++ b/docs/Classes/SDLSlider.html @@ -3,8 +3,6 @@ <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--initWithNumTicks:position:">-initWithNumTicks:position:</a></li> <li><a href="#section--initWithNumTicks:position:sliderHeader:sliderFooter:timeout:">-initWithNumTicks:position:sliderHeader:sliderFooter:timeout:</a></li> <li><a href="#section--initWithNumTicks:position:sliderHeader:sliderFooters:timeout:">-initWithNumTicks:position:sliderHeader:sliderFooters:timeout:</a></li> @@ -25,49 +23,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSlider 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 new SDLSlider object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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--initWithNumTicks:position:"> -initWithNumTicks:position: </h3> @@ -77,7 +32,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 +47,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 +62,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> @@ -124,11 +79,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">numTicks</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">numTicks</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">numTicks</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">numTicks</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -144,11 +99,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">position</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">position</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">position</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">position</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -164,11 +119,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">sliderHeader</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">sliderHeader</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">sliderHeader</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">sliderHeader</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -192,11 +147,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">sliderFooter</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">sliderFooter</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">sliderFooter</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">sliderFooter</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> @@ -216,11 +172,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">timeout</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeout</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeout</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLSliderResponse.html b/docs/Classes/SDLSliderResponse.html index 7f3620d54..90a0b1847 100644 --- a/docs/Classes/SDLSliderResponse.html +++ b/docs/Classes/SDLSliderResponse.html @@ -3,8 +3,6 @@ <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-sliderPosition">sliderPosition</a></li> </ul> @@ -16,50 +14,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSliderResponse 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 new SDLSliderResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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-sliderPosition"> sliderPosition </h3> @@ -69,11 +23,12 @@ parameter <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">sliderPosition</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">sliderPosition</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">sliderPosition</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">sliderPosition</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLSoftButton.html b/docs/Classes/SDLSoftButton.html index 0f543b340..c8197eeff 100644 --- a/docs/Classes/SDLSoftButton.html +++ b/docs/Classes/SDLSoftButton.html @@ -3,9 +3,7 @@ <h3>Section Contents</h3> <ul> - <li><a href="#section--init">-init</a></li> <li><a href="#section--initWithHandler:">-initWithHandler:</a></li> - <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> <li><a href="#section--initWithType:text:image:highlighted:buttonId:systemAction:handler:">-initWithType:text:image:highlighted:buttonId:systemAction:handler:</a></li> <li><a href="#section-handler">handler</a></li> <li><a href="#section-type">type</a></li> @@ -22,17 +20,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--initWithHandler:"> -initWithHandler: </h3> @@ -44,17 +31,6 @@ - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - - - <h3 id="section--initWithType:text:image:highlighted:buttonId:systemAction:handler:"> -initWithType:text:image:highlighted:buttonId:systemAction:handler: </h3> diff --git a/docs/Classes/SDLSoftButtonCapabilities.html b/docs/Classes/SDLSoftButtonCapabilities.html index 00068c945..ec25b9809 100644 --- a/docs/Classes/SDLSoftButtonCapabilities.html +++ b/docs/Classes/SDLSoftButtonCapabilities.html @@ -3,8 +3,6 @@ <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-shortPressAvailable">shortPressAvailable</a></li> <li><a href="#section-longPressAvailable">longPressAvailable</a></li> <li><a href="#section-upDownAvailable">upDownAvailable</a></li> @@ -19,49 +17,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a newly allocated SDLSoftButtonCapabilities 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 SDLSoftButtonCapabilities object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-shortPressAvailable"> shortPressAvailable </h3> @@ -75,11 +30,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">shortPressAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">shortPressAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">shortPressAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">shortPressAvailable</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -97,11 +53,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">longPressAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">longPressAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">longPressAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">longPressAvailable</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -119,11 +76,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">upDownAvailable</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">upDownAvailable</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">upDownAvailable</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">upDownAvailable</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -139,11 +97,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">imageSupported</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">imageSupported</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">imageSupported</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">imageSupported</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLSoftButtonType.html b/docs/Classes/SDLSoftButtonType.html deleted file mode 100644 index e2c3a7a29..000000000 --- a/docs/Classes/SDLSoftButtonType.html +++ /dev/null @@ -1,146 +0,0 @@ -<h1>SDLSoftButtonType 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-+TEXT">+TEXT</a></li> - <li><a href="#section-+IMAGE">+IMAGE</a></li> - <li><a href="#section-+BOTH">+BOTH</a></li> -</ul> - -<h3>Overview</h3> - -<p>SoftButtonType (TEXT / IMAGE / BOTH)</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract get SDLSoftButtonType according value string -- parameter: value NSString -- returns: SDLSoftButtonType object</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSoftButtonType</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">SDLSoftButtonType</span><span class="o">!</span></code></pre> - - - - <h4>Parameters</h4> - <dl> - <dt>value</dt> - <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> - - - - <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>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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSoftButtonType</span> <span class="o">*</span><span class="p">)</span><span class="n">TEXT</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">text</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSoftButtonType</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSoftButtonType</span> <span class="o">*</span><span class="p">)</span><span class="n">IMAGE</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">image</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSoftButtonType</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSoftButtonType</span> <span class="o">*</span><span class="p">)</span><span class="n">BOTH</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">both</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSoftButtonType</span><span class="o">!</span></code></pre> - - - - <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..dac4331d9 100644 --- a/docs/Classes/SDLSpeak.html +++ b/docs/Classes/SDLSpeak.html @@ -3,8 +3,6 @@ <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--initWithTTS:">-initWithTTS:</a></li> <li><a href="#section--initWithTTSChunks:">-initWithTTSChunks:</a></li> <li><a href="#section-ttsChunks">ttsChunks</a></li> @@ -41,54 +39,15 @@ <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> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSpeak 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 new SDLSpeak object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> +<p>@since SmartDeviceLink 1.0</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAlert - - - <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> +</div> - - <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> - +<section class="section task-group-section"> <h3 id="section--initWithTTS:"> -initWithTTS: </h3> @@ -98,7 +57,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 +72,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 +87,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 @@ -138,11 +96,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">ttsChunks</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">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">_Nonnull</span> <span class="n">ttsChunks</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">ttsChunks</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">ttsChunks</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> diff --git a/docs/Classes/SDLSpeakResponse.html b/docs/Classes/SDLSpeakResponse.html deleted file mode 100644 index cf65e3a78..000000000 --- a/docs/Classes/SDLSpeakResponse.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLSpeakResponse 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>Speak Response is sent, when Speak has been called</p> - -<p>Since SmartDeviceLink 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSpeakResponse 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 new SDLSpeakResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLSpeechCapabilities.html b/docs/Classes/SDLSpeechCapabilities.html deleted file mode 100644 index e8500ced3..000000000 --- a/docs/Classes/SDLSpeechCapabilities.html +++ /dev/null @@ -1,140 +0,0 @@ -<h1>SDLSpeechCapabilities 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-+TEXT">+TEXT</a></li> - <li><a href="#section-+SAPI_PHONEMES">+SAPI_PHONEMES</a></li> - <li><a href="#section-+LHPLUS_PHONEMES">+LHPLUS_PHONEMES</a></li> - <li><a href="#section-+PRE_RECORDED">+PRE_RECORDED</a></li> - <li><a href="#section-+SILENCE">+SILENCE</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract get SDLSpeechCapabilities according value string</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSpeechCapabilities</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">SDLSpeechCapabilities</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>SDLSpeechCapabilities object</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract declare an array to store all possible SDLSpeechCapabilities 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>the array of all possible values</p> - - </div> - - <h3 id="section-+TEXT"> - +TEXT - </h3> - - <p>@abstract The SDL platform can speak text phrases.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSpeechCapabilities</span> <span class="o">*</span><span class="p">)</span><span class="n">TEXT</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">text</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSpeechCapabilities</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLSpeechCapabilities of value: <em>TEXT</em></p> - - </div> - - <h3 id="section-+SAPI_PHONEMES"> - +SAPI_PHONEMES - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+LHPLUS_PHONEMES"> - +LHPLUS_PHONEMES - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+PRE_RECORDED"> - +PRE_RECORDED - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+SILENCE"> - +SILENCE - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLStartTime.html b/docs/Classes/SDLStartTime.html index 8fa5d4936..0a16d843c 100644 --- a/docs/Classes/SDLStartTime.html +++ b/docs/Classes/SDLStartTime.html @@ -3,8 +3,6 @@ <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--initWithHours:minutes:seconds:">-initWithHours:minutes:seconds:</a></li> <li><a href="#section-hours">hours</a></li> <li><a href="#section-minutes">minutes</a></li> @@ -19,49 +17,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a newly allocated SDLStartTime 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 SDLStartTime object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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--initWithHours:minutes:seconds:"> -initWithHours:minutes:seconds: </h3> @@ -71,7 +26,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> @@ -90,11 +45,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">hours</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">hours</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">hours</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">hours</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -110,11 +65,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">minutes</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">minutes</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">minutes</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">minutes</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -130,11 +85,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">seconds</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">seconds</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">seconds</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">seconds</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLStreamingMediaConfiguration.html b/docs/Classes/SDLStreamingMediaConfiguration.html new file mode 100644 index 000000000..5a1160a1c --- /dev/null +++ b/docs/Classes/SDLStreamingMediaConfiguration.html @@ -0,0 +1,252 @@ +<h1>SDLStreamingMediaConfiguration Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-securityManagers">securityManagers</a></li> + <li><a href="#section-maximumDesiredEncryption">maximumDesiredEncryption</a></li> + <li><a href="#section-customVideoEncoderSettings">customVideoEncoderSettings</a></li> + <li><a href="#section-dataSource">dataSource</a></li> + <li><a href="#section-window">window</a></li> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:">-initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:</a></li> + <li><a href="#section--initWithSecurityManagers:">-initWithSecurityManagers:</a></li> + <li><a href="#section-+secureConfigurationWithSecurityManagers:">+secureConfigurationWithSecurityManagers:</a></li> + <li><a href="#section-+insecureConfiguration">+insecureConfiguration</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section-securityManagers"> + securityManagers + </h3> + + <p>Set security managers which could be used. This is primarily used with video streaming applications to authenticate and perhaps encrypt traffic data.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">>></span> <span class="o">*</span><span class="n">securityManagers</span><span class="p">;</span></code></pre> + + + + + + <h3 id="section-maximumDesiredEncryption"> + maximumDesiredEncryption + </h3> + + <p>What encryption level video/audio streaming should be. The default is SDLStreamingEncryptionFlagAuthenticateAndEncrypt.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span> <span class="n">maximumDesiredEncryption</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">maximumDesiredEncryption</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-customVideoEncoderSettings"> + customVideoEncoderSettings + </h3> + + <p>Properties to use for applications that utilitze the video encoder for streaming. See VTCompressionProperties.h for more details. For example, you can set kVTCompressionPropertyKey_ExpectedFrameRate to set your expected framerate.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="n">customVideoEncoderSettings</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">customVideoEncoderSettings</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-dataSource"> + dataSource + </h3> + + <p>Usable to change run time video stream setup behavior. Only use this and modify the results if you <em>really</em> know what you’re doing. The head unit defaults are generally good.</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">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span> + <span class="n">dataSource</span><span class="p">;</span></code></pre> + + + + + + <h3 id="section-window"> + window + </h3> + + <p>Set the window your video streaming content is within.</p> + +<p>Activates the haptic view parser when set. If the window contains <code>UIView</code> based views, these will be discovered and automatically sent to the head unit if it uses a haptic interface. Whether or not it supports the haptic interace, this library will also use that information to attempt to return the touched view to you in <code><a href="../Protocols/SDLTouchManagerDelegate.html">SDLTouchManagerDelegate</a></code>.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>Apps using views outside of the <code>UIView</code> heirarchy (such as OpenGL) are currently unsupported. If you app uses partial views in the heirarchy, only those views will be discovered. Your OpenGL views will not be discoverable to a haptic interface head unit and you will have to manually make these views discoverable via the <code><a href="../Classes/SDLSendHapticData.html">SDLSendHapticData</a></code> RPC request.</p> + +</div> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + <p>This is a weak property and it’s therefore your job to hold a strong reference to this window.</p> + +</div> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIWindow</span> <span class="o">*</span><span class="n">window</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">weak</span> <span class="k">var</span> <span class="nv">window</span><span class="p">:</span> <span class="kt">UIWindow</span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--init"> + -init + </h3> + + <p>Create an insecure video streaming configuration. No security managers will be provided and the encryption flag will be set to None. If you’d like custom video encoder settings, you can set the property manually.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">init</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="p">()</span></code></pre> + + + + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + + <h3 id="section--initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window:"> + -initWithSecurityManagers:encryptionFlag:videoSettings:dataSource:window: + </h3> + + <p>Manually set all the properties to the streaming media configuration</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> +<span class="nf">initWithSecurityManagers</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">>></span> <span class="o">*</span><span class="p">)</span><span class="nv">securityManagers</span> + <span class="nf">encryptionFlag</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span><span class="p">)</span><span class="nv">encryptionFlag</span> + <span class="nf">videoSettings</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">videoSettings</span> + <span class="nf">dataSource</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLStreamingMediaManagerDataSource</span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> + <span class="nf">window</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIWindow</span> <span class="o">*</span><span class="p">)</span><span class="nv">window</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>securityManagers</dt> + <dd><p>The security managers to use or nil for none.</p></dd> + <dt>encryptionFlag</dt> + <dd><p>The maximum encrpytion supported. If the connected head unit supports less than set here, it will still connect, but if it supports more than set here, it will not connect.</p></dd> + <dt>videoSettings</dt> + <dd><p>Custom video encoder settings to be used in video streaming.</p></dd> + <dt>window</dt> + <dd><p>The UIWindow you are running the content that is being streamed on, to use for haptics if needed and possible (only works for UIViews)</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + + <h3 id="section--initWithSecurityManagers:"> + -initWithSecurityManagers: + </h3> + + <p>Create a secure configuration for each of the security managers provided.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSecurityManagers</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">>></span> <span class="o">*</span><span class="p">)</span><span class="nv">securityManagers</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>securityManagers</dt> + <dd><p>The security managers to be used. The encryption flag will be set to AuthenticateAndEncrypt if any security managers are set.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + + <h3 id="section-+secureConfigurationWithSecurityManagers:"> + +secureConfigurationWithSecurityManagers: + </h3> + + <p>Create a secure configuration for each of the security managers provided.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">secureConfigurationWithSecurityManagers</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">>></span> <span class="o">*</span><span class="p">)</span><span class="nv">securityManagers</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>securityManagers</dt> + <dd><p>The security managers to be used. The encryption flag will be set to AuthenticateAndEncrypt if any security managers are set.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + + <h3 id="section-+insecureConfiguration"> + +insecureConfiguration + </h3> + + <p>Create an insecure video streaming configuration. No security managers will be provided and the encryption flag will be set to None. If you’d like custom video encoder settings, you can set the property manually. This is equivalent to <code>init</code>.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">insecureConfiguration</span><span class="p">;</span></code></pre> + + + + + <div> + <h4>Return Value</h4> + <p>The configuration</p> + </div> + +</section> diff --git a/docs/Classes/SDLStreamingMediaManager.html b/docs/Classes/SDLStreamingMediaManager.html index 2ebb4b0b2..879455738 100644 --- a/docs/Classes/SDLStreamingMediaManager.html +++ b/docs/Classes/SDLStreamingMediaManager.html @@ -3,25 +3,25 @@ <h3>Section Contents</h3> <ul> - <li><a href="#section-videoSessionConnected">videoSessionConnected</a></li> - <li><a href="#section-audioSessionConnected">audioSessionConnected</a></li> - <li><a href="#section-videoSessionEncrypted">videoSessionEncrypted</a></li> - <li><a href="#section-audioSessionEncrypted">audioSessionEncrypted</a></li> <li><a href="#section-touchManager">touchManager</a></li> - <li><a href="#section-videoEncoderSettings">videoEncoderSettings</a></li> - <li><a href="#section-displayCapabilties">displayCapabilties</a></li> - <li><a href="#section-defaultVideoEncoderSettings">defaultVideoEncoderSettings</a></li> + <li><a href="#section-focusableItemManager">focusableItemManager</a></li> + <li><a href="#section-streamingSupported">streamingSupported</a></li> + <li><a href="#section-videoConnected">videoConnected</a></li> + <li><a href="#section-videoEncrypted">videoEncrypted</a></li> + <li><a href="#section-audioConnected">audioConnected</a></li> + <li><a href="#section-audioEncrypted">audioEncrypted</a></li> + <li><a href="#section-videoStreamingPaused">videoStreamingPaused</a></li> <li><a href="#section-screenSize">screenSize</a></li> + <li><a href="#section-videoFormat">videoFormat</a></li> + <li><a href="#section-supportedFormats">supportedFormats</a></li> <li><a href="#section-pixelBufferPool">pixelBufferPool</a></li> - <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--startVideoSessionWithTLS:startBlock:">-startVideoSessionWithTLS:startBlock:</a></li> - <li><a href="#section--stopVideoSession">-stopVideoSession</a></li> + <li><a href="#section-requestedEncryptionType">requestedEncryptionType</a></li> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithConnectionManager:configuration:">-initWithConnectionManager:configuration:</a></li> + <li><a href="#section--startWithProtocol:">-startWithProtocol:</a></li> + <li><a href="#section--stop">-stop</a></li> <li><a href="#section--sendVideoData:">-sendVideoData:</a></li> - <li><a href="#section--startAudioSessionWithStartBlock:">-startAudioSessionWithStartBlock:</a></li> - <li><a href="#section--startAudioSessionWithTLS:startBlock:">-startAudioSessionWithTLS:startBlock:</a></li> - <li><a href="#section--stopAudioSession">-stopAudioSession</a></li> + <li><a href="#section--sendVideoData:presentationTimestamp:">-sendVideoData:presentationTimestamp:</a></li> <li><a href="#section--sendAudioData:">-sendAudioData:</a></li> </ul> @@ -31,133 +31,155 @@ <section class="section task-group-section"> - <h3 id="section-videoSessionConnected"> - videoSessionConnected + <h3 id="section-touchManager"> + touchManager </h3> - <p>Undocumented</p> + <p>Touch Manager responsible for providing touch event notifications.</p> + <h4>Objective-C</h4> + <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">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTouchManager.html">SDLTouchManager</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">touchManager</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">touchManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTouchManager.html">SDLTouchManager</a></span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + - <h3 id="section-audioSessionConnected"> - audioSessionConnected + <h3 id="section-focusableItemManager"> + focusableItemManager </h3> - <p>Undocumented</p> + <p>A haptic interface that can be updated to reparse views within the window you’ve provided. Send a <code><a href="../Constants.html#/c:@SDLDidUpdateProjectionView">SDLDidUpdateProjectionView</a></code> notification or call the <code>updateInterfaceLayout</code> method to reparse. The <q>output</q> of this haptic interface occurs in the <code><a href="../Classes/SDLStreamingMediaManager.html#/c:objc(cs)SDLStreamingMediaManager(py)touchManager">touchManager</a></code> property where it will call the delegate.</p> + <h4>Objective-C</h4> + <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">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLFocusableItemLocatorType</span><span class="o">></span> + <span class="n">focusableItemManager</span><span class="p">;</span></code></pre> + - <h3 id="section-videoSessionEncrypted"> - videoSessionEncrypted + + <h3 id="section-streamingSupported"> + streamingSupported </h3> - <p>Undocumented</p> + <p>Whether or not video streaming is supported</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLRegisterAppInterface SDLDisplayCapabilities + +</div> + <h4>Objective-C</h4> + <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">getter</span><span class="o">=</span><span class="n">isStreamingSupported</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">streamingSupported</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isStreamingSupported</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> + - <h3 id="section-audioSessionEncrypted"> - audioSessionEncrypted + <h3 id="section-videoConnected"> + videoConnected </h3> - <p>Undocumented</p> + <p>Whether or not the video session is connected.</p> + <h4>Objective-C</h4> + <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">getter</span><span class="o">=</span><span class="n">isVideoConnected</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">videoConnected</span><span class="p">;</span></code></pre> + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isVideoConnected</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> + - <h3 id="section-touchManager"> - touchManager + + <h3 id="section-videoEncrypted"> + videoEncrypted </h3> - <p>Touch Manager responsible for providing touch event notifications.</p> + <p>Whether or not the video session is encrypted. This may be different than the requestedEncryptionType.</p> <h4>Objective-C</h4> - <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">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTouchManager.html">SDLTouchManager</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">touchManager</span><span class="p">;</span></code></pre> + <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">getter</span><span class="o">=</span><span class="n">isVideoEncrypted</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">videoEncrypted</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">touchManager</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTouchManager.html">SDLTouchManager</a></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">isVideoEncrypted</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> - <h3 id="section-videoEncoderSettings"> - videoEncoderSettings + <h3 id="section-audioConnected"> + audioConnected </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. - -</div> + <p>Whether or not the audio session is connected.</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">null_resettable</span><span class="p">)</span> - <span class="n">NSDictionary</span> <span class="o">*</span><span class="n">videoEncoderSettings</span><span class="p">;</span></code></pre> + <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">getter</span><span class="o">=</span><span class="n">isAudioConnected</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">audioConnected</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">videoEncoderSettings</span><span class="p">:</span> <span class="p">[</span><span class="kt">AnyHashable</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]</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">isAudioConnected</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> - <h3 id="section-displayCapabilties"> - displayCapabilties + <h3 id="section-audioEncrypted"> + audioEncrypted </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. - -</div> + <p>Whether or not the audio session is encrypted. This may be different than the requestedEncryptionType.</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">null_resettable</span><span class="p">)</span> - <span class="n"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</a></span> <span class="o">*</span><span class="n">displayCapabilties</span><span class="p">;</span></code></pre> + <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">getter</span><span class="o">=</span><span class="n">isAudioEncrypted</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">audioEncrypted</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">displayCapabilties</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLDisplayCapabilities.html">SDLDisplayCapabilities</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">isAudioEncrypted</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> - <h3 id="section-defaultVideoEncoderSettings"> - defaultVideoEncoderSettings + <h3 id="section-videoStreamingPaused"> + videoStreamingPaused </h3> - <p>Provides default video encoder settings used.</p> + <p>Whether or not the video stream is paused due to either the application being backgrounded, the HMI state being either NONE or BACKGROUND, or the video stream not being ready.</p> <h4>Objective-C</h4> - <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">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> - <span class="n">NSDictionary</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">defaultVideoEncoderSettings</span><span class="p">;</span></code></pre> + <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">getter</span><span class="o">=</span><span class="n">isVideoStreamingPaused</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">BOOL</span> <span class="n">videoStreamingPaused</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">defaultVideoEncoderSettings</span><span class="p">:</span> <span class="p">[</span><span class="kt">AnyHashable</span> <span class="p">:</span> <span class="kt">Any</span><span class="p">]</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">isVideoStreamingPaused</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> @@ -180,12 +202,49 @@ + <h3 id="section-videoFormat"> + videoFormat + </h3> + + <p>This is the agreed upon format of video encoder that is in use, or nil if not currently connected.</p> + + + + <h4>Objective-C</h4> + <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">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*</span><span class="n">videoFormat</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">videoFormat</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-supportedFormats"> + supportedFormats + </h3> + + <p>A list of all supported video formats by this manager</p> + + + + <h4>Objective-C</h4> + <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">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</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="p">[</span><span class="kt"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span><span class="p">]</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + <h3 id="section-pixelBufferPool"> pixelBufferPool </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). @@ -206,19 +265,29 @@ - <h3 id="section--initWithProtocol:"> - -initWithProtocol: + <h3 id="section-requestedEncryptionType"> + requestedEncryptionType </h3> - <p>Undocumented</p> + <p>The requested encryption type when a session attempts to connect. This setting applies to both video and audio sessions.</p> + +<p>DEFAULT: SDLStreamingEncryptionFlagAuthenticateAndEncrypt</p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">readwrite</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span> <span class="n">requestedEncryptionType</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">requestedEncryptionType</span><span class="p">:</span> <span class="kt"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + - <h3 id="section--initWithProtocol:displayCapabilities:"> - -initWithProtocol:displayCapabilities: + <h3 id="section--init"> + -init </h3> <p>Undocumented</p> @@ -228,80 +297,68 @@ - <h3 id="section--startVideoSessionWithStartBlock:"> - -startVideoSessionWithStartBlock: + <h3 id="section--initWithConnectionManager:configuration:"> + -initWithConnectionManager:configuration: </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> - -<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> + <p>Create a new streaming media manager for navigation and VPM apps with a specified configuration</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">startVideoSessionWithStartBlock</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@SDLStreamingStartBlock">SDLStreamingStartBlock</a></span><span class="p">)</span><span class="nv">startBlock</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span> +<span class="nf">initWithConnectionManager</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">connectionManager</span> + <span class="nf">configuration</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">configuration</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">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>startBlock</dt> - <dd><p>A block that will be called with the result of attempting to start a video session</p> -</dd> + <dt>connectionManager</dt> + <dd><p>The pass-through for RPCs</p></dd> + <dt>configuration</dt> + <dd><p>The configuration of this streaming media session</p></dd> </dl> + <div> + <h4>Return Value</h4> + <p>A new streaming manager</p> + </div> - <h3 id="section--startVideoSessionWithTLS:startBlock:"> - -startVideoSessionWithTLS:startBlock: + <h3 id="section--startWithProtocol:"> + -startWithProtocol: </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.</p> + <p>Start the manager with a completion block that will be called when startup completes. This is used internally. To use an SDLStreamingMediaManager, you should use the manager found on <code><a href="../Classes/SDLManager.html">SDLManager</a></code>.</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">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> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startWithProtocol</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span></code></pre> <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="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> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">start</span><span class="p">(</span><span class="n">with</span> <span class="nv">protocol</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span><span class="p">)</span></code></pre> - <h4>Parameters</h4> - <dl> - <dt>encryptionFlag</dt> - <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--stopVideoSession"> - -stopVideoSession + <h3 id="section--stop"> + -stop </h3> - <p>This method will stop a running video session if there is one running.</p> + <p>Stop the manager. This method is used internally.</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="n">stopVideoSession</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">stop</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">stopVideoSession</span><span class="p">()</span></code></pre> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">stop</span><span class="p">()</span></code></pre> @@ -326,68 +383,42 @@ <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:"> - -startAudioSessionWithStartBlock: + <h3 id="section--sendVideoData:presentationTimestamp:"> + -sendVideoData:presentationTimestamp: </h3> - <p>This method will attempt to start an audio session</p> + <p>This method receives raw image data and will run iOS8+’s hardware video encoder to turn the data into a video stream, which will then be passed to the connected head unit.</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">startAudioSessionWithStartBlock</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@SDLStreamingStartBlock">SDLStreamingStartBlock</a></span><span class="p">)</span><span class="nv">startBlock</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendVideoData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">CVImageBufferRef</span><span class="p">)</span><span class="nv">imageBuffer</span> + <span class="nf">presentationTimestamp</span><span class="p">:(</span><span class="n">CMTime</span><span class="p">)</span><span class="nv">presentationTimestamp</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">startAudioSession</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> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">sendVideoData</span><span class="p">(</span><span class="n">_</span> <span class="nv">imageBuffer</span><span class="p">:</span> <span class="kt">CVImageBuffer</span><span class="p">,</span> <span class="nv">presentationTimestamp</span><span class="p">:</span> <span class="kt">CMTime</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> <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> + <dt>imageBuffer</dt> + <dd><p>A CVImageBufferRef to be encoded by Video Toolbox</p></dd> + <dt>presentationTimestamp</dt> + <dd><p>A presentation timestamp for the frame, or kCMTimeInvalid if timestamp is unknown. If it’s valid, it must be greater than the previous one.</p></dd> </dl> - - <h3 id="section--startAudioSessionWithTLS:startBlock:"> - -startAudioSessionWithTLS:startBlock: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section--stopAudioSession"> - -stopAudioSession - </h3> - - <p>This method will stop a running audio session if there is one running.</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="n">stopAudioSession</span><span class="p">;</span></code></pre> - - - <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">stopAudioSession</span><span class="p">()</span></code></pre> - - - + <div> + <h4>Return Value</h4> + <p>Whether or not the data was successfully encoded and sent.</p> + </div> <h3 id="section--sendAudioData:"> -sendAudioData: @@ -398,24 +429,22 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendAudioData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">pcmAudioData</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendAudioData</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">audioData</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="kd">func</span> <span class="nf">sendAudioData</span><span class="p">(</span><span class="n">_</span> <span class="nv">pcmAudioData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> + <pre class="highlight"><code><span class="kd">func</span> <span class="nf">sendAudioData</span><span class="p">(</span><span class="n">_</span> <span class="nv">audioData</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre> <h4>Parameters</h4> <dl> - <dt>pcmAudioData</dt> - <dd><p>The data in PCM audio format, to be played</p> -</dd> + <dt>audioData</dt> + <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..1e7151503 100644 --- a/docs/Classes/SDLSubscribeButton.html +++ b/docs/Classes/SDLSubscribeButton.html @@ -3,9 +3,7 @@ <h3>Section Contents</h3> <ul> - <li><a href="#section--init">-init</a></li> <li><a href="#section--initWithHandler:">-initWithHandler:</a></li> - <li><a href="#section--initWithDictionary:">-initWithDictionary:</a></li> <li><a href="#section--initWithButtonName:handler:">-initWithButtonName:handler:</a></li> <li><a href="#section-handler">handler</a></li> <li><a href="#section-buttonName">buttonName</a></li> @@ -64,29 +62,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Construct an SDLSubscribeButton</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> - - - - <div> - <h4>Return Value</h4> - <p>An SDLSubscribeButton object</p> - - </div> - <h3 id="section--initWithHandler:"> -initWithHandler: </h3> @@ -96,52 +71,25 @@ <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">initWithHandler</span><span class="p">:(</span><span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCNotificationHandler">SDLRPCNotificationHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHandler</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">)</span><span class="nv">handler</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">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCNotificationHandler">SDLRPCNotificationHandler</a></span><span class="o">!</span><span class="p">)</span></code></pre> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre> <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:"> - -initWithDictionary: - </h3> - - <p>@abstract Constructs a new SDLSubscribeButton object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--initWithButtonName:handler:"> -initWithButtonName:handler: </h3> @@ -151,7 +99,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></code></pre> @@ -162,7 +110,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. @@ -172,11 +119,12 @@ parameter <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"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCNotificationHandler">SDLRPCNotificationHandler</a></span> <span class="n">handler</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span> <span class="n">_Nonnull</span> <span class="n">handler</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCNotificationHandler">SDLRPCNotificationHandler</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">handler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -191,11 +139,11 @@ parameter <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/SDLButtonName.html">SDLButtonName</a></span> <span class="o">*</span><span class="n">buttonName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="n">_Nonnull</span> <span class="n">buttonName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLButtonName.html">SDLButtonName</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">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</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/SDLSubscribeButtonResponse.html b/docs/Classes/SDLSubscribeButtonResponse.html deleted file mode 100644 index c53b27aa7..000000000 --- a/docs/Classes/SDLSubscribeButtonResponse.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLSubscribeButtonResponse 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>SubscribeButton Response is sent, when SDLSubscribeButton has been called</p> - -<p>Since SmartDeviceLink 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSubscribeButtonResponse 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 new SDLSubscribeButtonResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLSubscribeVehicleData.html b/docs/Classes/SDLSubscribeVehicleData.html index 4497a7bd9..d8c0d7e13 100644 --- a/docs/Classes/SDLSubscribeVehicleData.html +++ b/docs/Classes/SDLSubscribeVehicleData.html @@ -3,8 +3,6 @@ <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--initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:">-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:</a></li> <li><a href="#section-gps">gps</a></li> <li><a href="#section-speed">speed</a></li> @@ -50,50 +48,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSubscribeVehicleData 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 new SDLSubscribeVehicleData object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:"> -initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus: </h3> @@ -103,7 +57,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> @@ -118,11 +72,11 @@ parameter <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">gps</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -136,11 +90,11 @@ parameter <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">speed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -154,11 +108,11 @@ parameter <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">rpm</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">rpm</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -172,11 +126,11 @@ parameter <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">fuelLevel</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">fuelLevel</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -190,11 +144,12 @@ parameter <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">fuelLevel_State</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -208,11 +163,12 @@ parameter <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">instantFuelConsumption</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">instantFuelConsumption</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -226,11 +182,12 @@ parameter <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">externalTemperature</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">externalTemperature</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -244,11 +201,11 @@ parameter <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">prndl</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">prndl</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -262,11 +219,12 @@ parameter <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">tirePressure</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -280,11 +238,11 @@ parameter <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">odometer</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">odometer</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -298,11 +256,11 @@ parameter <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">beltStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -316,11 +274,12 @@ parameter <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">bodyInformation</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -334,11 +293,12 @@ parameter <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">deviceStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -352,11 +312,12 @@ parameter <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">driverBraking</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">driverBraking</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -370,11 +331,12 @@ parameter <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">wiperStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">wiperStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -388,11 +350,12 @@ parameter <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">headLampStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -406,11 +369,12 @@ parameter <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">engineTorque</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">engineTorque</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -425,11 +389,12 @@ subscribed.</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">accPedalPosition</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">accPedalPosition</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -444,11 +409,12 @@ subscribed.</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">steeringWheelAngle</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">steeringWheelAngle</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -462,7 +428,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 +443,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 +458,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 +473,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 +488,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..a4dca20e2 100644 --- a/docs/Classes/SDLSubscribeVehicleDataResponse.html +++ b/docs/Classes/SDLSubscribeVehicleDataResponse.html @@ -3,8 +3,6 @@ <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-gps">gps</a></li> <li><a href="#section-speed">speed</a></li> <li><a href="#section-rpm">rpm</a></li> @@ -39,50 +37,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLSubscribeVehicleDataResponse 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 new SDLSubscribeVehicleDataResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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-gps"> gps </h3> @@ -92,11 +46,11 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">gps</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -110,11 +64,11 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">speed</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -128,11 +82,11 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">rpm</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">rpm</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">rpm</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -146,11 +100,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">fuelLevel</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">fuelLevel</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">fuelLevel</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -164,11 +119,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">fuelLevel_State</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -182,12 +138,12 @@ parameter <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> + <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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">instantFuelConsumption</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">instantFuelConsumption</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -201,11 +157,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">externalTemperature</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">externalTemperature</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">externalTemperature</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -219,11 +176,11 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">prndl</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">prndl</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">prndl</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -237,11 +194,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">tirePressure</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -255,11 +213,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">odometer</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">odometer</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">odometer</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -273,11 +232,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">beltStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -291,11 +251,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">bodyInformation</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -309,11 +270,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">deviceStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -327,11 +289,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">driverBraking</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">driverBraking</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">driverBraking</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -345,11 +308,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">wiperStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">wiperStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">wiperStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -363,11 +327,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">headLampStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -381,11 +346,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">engineTorque</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">engineTorque</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">engineTorque</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -399,11 +365,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">accPedalPosition</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">accPedalPosition</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">accPedalPosition</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -417,11 +384,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">steeringWheelAngle</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">steeringWheelAngle</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">steeringWheelAngle</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -435,7 +403,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 +418,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 +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> @@ -480,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> @@ -495,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> diff --git a/docs/Classes/SDLSyncMsgVersion.html b/docs/Classes/SDLSyncMsgVersion.html index dbcb9bd33..5a2a668da 100644 --- a/docs/Classes/SDLSyncMsgVersion.html +++ b/docs/Classes/SDLSyncMsgVersion.html @@ -3,11 +3,10 @@ <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--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> @@ -18,100 +17,76 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init + <h3 id="section--initWithMajorVersion:minorVersion:patchVersion:"> + -initWithMajorVersion:minorVersion:patchVersion: </h3> - <p>@abstract Constructs a newly allocated SDLSyncMsgVersion object</p> + <p>Undocumented</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> + <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> - <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 id="section-majorVersion"> + majorVersion </h3> - <p>@abstract Constructs a newly allocated SDLSyncMsgVersion object indicated by the dictionary parameter -- parameter: dict The dictionary to use</p> + <p>@abstract The major version indicates versions that is not-compatible to previous versions</p> + +<p>Required, Integer, 1 - 10</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> + <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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">majorVersion</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">majorVersion</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> - <h4>Parameters</h4> - <dl> - <dt>dict</dt> - <dd><p>The dictionary to use</p> -</dd> - </dl> - - <h3 id="section--initWithMajorVersion:minorVersion:"> - -initWithMajorVersion:minorVersion: - </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">SDLRPCStruct</span></code></pre> - - - - - <h3 id="section-majorVersion"> - majorVersion + <h3 id="section-minorVersion"> + minorVersion </h3> - <p>@abstract The major version indicates versions that is not-compatible to previous versions</p> + <p>@abstract The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p> -<p>Required, Integer, 1 - 10</p> +<p>Required, Integer, 0 - 1000</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">majorVersion</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">minorVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">majorVersion</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">minorVersion</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> - <h3 id="section-minorVersion"> - minorVersion + <h3 id="section-patchVersion"> + patchVersion </h3> - <p>@abstract The minor version indicates a change to a previous version that should still allow to be run on an older version (with limited functionality)</p> - -<p>Required, Integer, 0 - 1000</p> + <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">minorVersion</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">patchVersion</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">minorVersion</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">patchVersion</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLSyncPData.html b/docs/Classes/SDLSyncPData.html deleted file mode 100644 index 72fb4f6a1..000000000 --- a/docs/Classes/SDLSyncPData.html +++ /dev/null @@ -1,38 +0,0 @@ -<h1>SDLSyncPData 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/SDLSyncPDataResponse.html b/docs/Classes/SDLSyncPDataResponse.html deleted file mode 100644 index ea88f6020..000000000 --- a/docs/Classes/SDLSyncPDataResponse.html +++ /dev/null @@ -1,38 +0,0 @@ -<h1>SDLSyncPDataResponse 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/SDLSystemAction.html b/docs/Classes/SDLSystemAction.html deleted file mode 100644 index 373ef1a3b..000000000 --- a/docs/Classes/SDLSystemAction.html +++ /dev/null @@ -1,128 +0,0 @@ -<h1>SDLSystemAction Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+valueOf:">+valueOf:</a></li> - <li><a href="#section-+values">+values</a></li> - <li><a href="#section-+DEFAULT_ACTION">+DEFAULT_ACTION</a></li> - <li><a href="#section-+STEAL_FOCUS">+STEAL_FOCUS</a></li> - <li><a href="#section-+KEEP_CONTEXT">+KEEP_CONTEXT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Enumeration that describes system actions that can be triggered.</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLSystemAction -- parameter: value String -- returns: SDLSystemAction</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemAction</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">SDLSystemAction</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>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> - - - - <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 SDLSystemAction</p> - - </div> - - <h3 id="section-+DEFAULT_ACTION"> - +DEFAULT_ACTION - </h3> - - <p>@abstract Default_Action</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemAction</span> <span class="o">*</span><span class="p">)</span><span class="n">DEFAULT_ACTION</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">default_</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemAction</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+STEAL_FOCUS"> - +STEAL_FOCUS - </h3> - - <p>@abstract Steal_Focus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemAction</span> <span class="o">*</span><span class="p">)</span><span class="n">STEAL_FOCUS</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">steal_FOCUS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemAction</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+KEEP_CONTEXT"> - +KEEP_CONTEXT - </h3> - - <p>@abstract Keep_Context</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemAction</span> <span class="o">*</span><span class="p">)</span><span class="n">KEEP_CONTEXT</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">keep_CONTEXT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemAction</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLSystemCapability.html b/docs/Classes/SDLSystemCapability.html new file mode 100644 index 000000000..9d9ba02fb --- /dev/null +++ b/docs/Classes/SDLSystemCapability.html @@ -0,0 +1,162 @@ +<h1>SDLSystemCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <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--initWithRemoteControlCapability:">-initWithRemoteControlCapability:</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> + <li><a href="#section-remoteControlCapability">remoteControlCapability</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--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--initWithRemoteControlCapability:"> + -initWithRemoteControlCapability: + </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> + + + + + + <h3 id="section-remoteControlCapability"> + remoteControlCapability + </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/SDLSystemContext.html b/docs/Classes/SDLSystemContext.html deleted file mode 100644 index a2f9ea2f4..000000000 --- a/docs/Classes/SDLSystemContext.html +++ /dev/null @@ -1,194 +0,0 @@ -<h1>SDLSystemContext 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-+MAIN">+MAIN</a></li> - <li><a href="#section-+VRSESSION">+VRSESSION</a></li> - <li><a href="#section-+MENU">+MENU</a></li> - <li><a href="#section-+HMI_OBSCURED">+HMI_OBSCURED</a></li> - <li><a href="#section-+ALERT">+ALERT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR).</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLSystemContext</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemContext</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">SDLSystemContext</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>SDLSystemContext</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLSystemContext</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 SDLSystemContext</p> - - </div> - - <h3 id="section-+MAIN"> - +MAIN - </h3> - - <p>@abstract No user interaction (user-initiated or app-initiated) is in progress.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemContext</span> <span class="o">*</span><span class="p">)</span><span class="n">MAIN</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">main</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemContext</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLSystemContext object of value <em>MAIN</em></p> - - </div> - - <h3 id="section-+VRSESSION"> - +VRSESSION - </h3> - - <p>@abstract VR-oriented, user-initiated or app-initiated interaction is in-progress.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemContext</span> <span class="o">*</span><span class="p">)</span><span class="n">VRSESSION</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">vrsession</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemContext</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLSystemContext object of value <em>VRSESSION</em></p> - - </div> - - <h3 id="section-+MENU"> - +MENU - </h3> - - <p>@abstract Menu-oriented, user-initiated or app-initiated interaction is in-progress.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemContext</span> <span class="o">*</span><span class="p">)</span><span class="n">MENU</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">menu</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemContext</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLSystemContext object of value <em>MENU</em></p> - - </div> - - <h3 id="section-+HMI_OBSCURED"> - +HMI_OBSCURED - </h3> - - <p>@abstract The app’s display HMI is currently being obscured by either a system or other app’s overlay.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemContext</span> <span class="o">*</span><span class="p">)</span><span class="n">HMI_OBSCURED</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">hmi_OBSCURED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemContext</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLSystemContext object of value <em>HMI_OBSCURED</em></p> - - </div> - - <h3 id="section-+ALERT"> - +ALERT - </h3> - - <p>@abstract Broadcast only to whichever app has an alert currently being displayed.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLSystemContext</span> <span class="o">*</span><span class="p">)</span><span class="n">ALERT</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">alert</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLSystemContext</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLSystemContext object of value <em>ALERT</em></p> - - </div> - -</section> diff --git a/docs/Classes/SDLTBTState.html b/docs/Classes/SDLTBTState.html deleted file mode 100644 index 3aa239755..000000000 --- a/docs/Classes/SDLTBTState.html +++ /dev/null @@ -1,158 +0,0 @@ -<h1>SDLTBTState 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-+ROUTE_UPDATE_REQUEST">+ROUTE_UPDATE_REQUEST</a></li> - <li><a href="#section-+ROUTE_ACCEPTED">+ROUTE_ACCEPTED</a></li> - <li><a href="#section-+ROUTE_REFUSED">+ROUTE_REFUSED</a></li> - <li><a href="#section-+ROUTE_CANCELLED">+ROUTE_CANCELLED</a></li> - <li><a href="#section-+ETA_REQUEST">+ETA_REQUEST</a></li> - <li><a href="#section-+NEXT_TURN_REQUEST">+NEXT_TURN_REQUEST</a></li> - <li><a href="#section-+ROUTE_STATUS_REQUEST">+ROUTE_STATUS_REQUEST</a></li> - <li><a href="#section-+ROUTE_SUMMARY_REQUEST">+ROUTE_SUMMARY_REQUEST</a></li> - <li><a href="#section-+TRIP_STATUS_REQUEST">+TRIP_STATUS_REQUEST</a></li> - <li><a href="#section-+ROUTE_UPDATE_REQUEST_TIMEOUT">+ROUTE_UPDATE_REQUEST_TIMEOUT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ROUTE_UPDATE_REQUEST"> - +ROUTE_UPDATE_REQUEST - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ROUTE_ACCEPTED"> - +ROUTE_ACCEPTED - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ROUTE_REFUSED"> - +ROUTE_REFUSED - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ROUTE_CANCELLED"> - +ROUTE_CANCELLED - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ETA_REQUEST"> - +ETA_REQUEST - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+NEXT_TURN_REQUEST"> - +NEXT_TURN_REQUEST - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ROUTE_STATUS_REQUEST"> - +ROUTE_STATUS_REQUEST - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ROUTE_SUMMARY_REQUEST"> - +ROUTE_SUMMARY_REQUEST - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+TRIP_STATUS_REQUEST"> - +TRIP_STATUS_REQUEST - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+ROUTE_UPDATE_REQUEST_TIMEOUT"> - +ROUTE_UPDATE_REQUEST_TIMEOUT - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLTTSChunk.html b/docs/Classes/SDLTTSChunk.html index 0fbbbb1d8..ca05f3cd8 100644 --- a/docs/Classes/SDLTTSChunk.html +++ b/docs/Classes/SDLTTSChunk.html @@ -3,8 +3,6 @@ <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--initWithText:type:">-initWithText:type:</a></li> <li><a href="#section-+textChunksFromString:">+textChunksFromString:</a></li> <li><a href="#section-+sapiChunksFromString:">+sapiChunksFromString:</a></li> @@ -49,48 +47,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a newly allocated SDLTTSChunk 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 SDLTTSChunk 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--initWithText:type:"> -initWithText:type: </h3> @@ -100,7 +56,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 +71,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 +86,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 +101,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 +116,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 +131,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> @@ -192,11 +148,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span></code></pre> + <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">NSString</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">text</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">text</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">text</span><span class="p">:</span> <span class="kt">String</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -212,11 +168,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLSpeechCapabilities.html">SDLSpeechCapabilities</a></span> <span class="o">*</span><span class="n">type</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="n">_Nonnull</span> <span class="n">type</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">type</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLSpeechCapabilities.html">SDLSpeechCapabilities</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">type</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> diff --git a/docs/Classes/SDLTTSChunkFactory.html b/docs/Classes/SDLTTSChunkFactory.html deleted file mode 100644 index fa8d158d5..000000000 --- a/docs/Classes/SDLTTSChunkFactory.html +++ /dev/null @@ -1,38 +0,0 @@ -<h1>SDLTTSChunkFactory Class Reference</h1> - -<h3>Section Contents</h3> - -<ul> - <li><a href="#section-+buildTTSChunkForString:type:">+buildTTSChunkForString:type:</a></li> - <li><a href="#section-+buildTTSChunksFromSimple:">+buildTTSChunksFromSimple:</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+buildTTSChunkForString:type:"> - +buildTTSChunkForString:type: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+buildTTSChunksFromSimple:"> - +buildTTSChunksFromSimple: - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLTemperature.html b/docs/Classes/SDLTemperature.html new file mode 100644 index 000000000..5b1cd02e4 --- /dev/null +++ b/docs/Classes/SDLTemperature.html @@ -0,0 +1,66 @@ +<h1>SDLTemperature Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithUnit:value:">-initWithUnit:value:</a></li> + <li><a href="#section-unit">unit</a></li> + <li><a href="#section-value">value</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithUnit:value:"> + -initWithUnit:value: + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section-unit"> + unit + </h3> + + <p>@abstract Temperature Unit</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="../Type Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</a></span> <span class="n">_Nonnull</span> <span class="n">unit</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">unit</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-value"> + value + </h3> + + <p>@abstract Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL</p> + +<p>FLoat value</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"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">value</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> + + + + +</section> diff --git a/docs/Classes/SDLTextAlignment.html b/docs/Classes/SDLTextAlignment.html deleted file mode 100644 index 926c7bb7e..000000000 --- a/docs/Classes/SDLTextAlignment.html +++ /dev/null @@ -1,142 +0,0 @@ -<h1>SDLTextAlignment 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-+LEFT_ALIGNED">+LEFT_ALIGNED</a></li> - <li><a href="#section-+RIGHT_ALIGNED">+RIGHT_ALIGNED</a></li> - <li><a href="#section-+CENTERED">+CENTERED</a></li> -</ul> - -<h3>Overview</h3> - -<p>The list of possible alignments of text in a field. May only work on some display types.</p> - -<p>@since SDL 1.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">SDLTextAlignment</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">SDLTextAlignment</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 SDLTextAlignment</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 SDLTextAlignment</p> - - </div> - - <h3 id="section-+LEFT_ALIGNED"> - +LEFT_ALIGNED - </h3> - - <p>@abstract Text aligned left.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextAlignment</span> <span class="o">*</span><span class="p">)</span><span class="n">LEFT_ALIGNED</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">left_ALIGNED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextAlignment</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>A SDLTextAlignment object with value of <em>LEFT_ALIGNED</em></p> - - </div> - - <h3 id="section-+RIGHT_ALIGNED"> - +RIGHT_ALIGNED - </h3> - - <p>@abstract Text aligned right.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextAlignment</span> <span class="o">*</span><span class="p">)</span><span class="n">RIGHT_ALIGNED</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">right_ALIGNED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextAlignment</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>A SDLTextAlignment object with value of <em>RIGHT_ALIGNED</em></p> - - </div> - - <h3 id="section-+CENTERED"> - +CENTERED - </h3> - - <p>@abstract Text aligned centered.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextAlignment</span> <span class="o">*</span><span class="p">)</span><span class="n">CENTERED</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">centered</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextAlignment</span><span class="o">!</span></code></pre> - - - - <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..bc0731b23 100644 --- a/docs/Classes/SDLTextField.html +++ b/docs/Classes/SDLTextField.html @@ -3,8 +3,6 @@ <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-name">name</a></li> <li><a href="#section-characterSet">characterSet</a></li> <li><a href="#section-width">width</a></li> @@ -63,54 +61,11 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a newly allocated SDLTextField 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 SDLTextField 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-name"> name </h3> <p>@abstract The enumeration identifying the field.</p> - <div class="aside aside-see"> <p class="aside-title">See</p> SDLTextFieldName @@ -122,11 +77,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLTextFieldName.html">SDLTextFieldName</a></span> <span class="o">*</span><span class="n">name</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLTextFieldName.h@T@SDLTextFieldName">SDLTextFieldName</a></span> <span class="n">_Nonnull</span> <span class="n">name</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTextFieldName.html">SDLTextFieldName</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">name</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTextFieldName.h@T@SDLTextFieldName">SDLTextFieldName</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -136,7 +91,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 @@ -148,11 +102,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLCharacterSet.html">SDLCharacterSet</a></span> <span class="o">*</span><span class="n">characterSet</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="n">_Nonnull</span> <span class="n">characterSet</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">characterSet</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLCharacterSet.html">SDLCharacterSet</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">characterSet</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLCharacterSet.h@T@SDLCharacterSet">SDLCharacterSet</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> @@ -168,11 +122,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</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> + <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"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">width</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -188,11 +142,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">rows</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">rows</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rows</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rows</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> diff --git a/docs/Classes/SDLTextFieldName.html b/docs/Classes/SDLTextFieldName.html deleted file mode 100644 index 19d9c9a5b..000000000 --- a/docs/Classes/SDLTextFieldName.html +++ /dev/null @@ -1,782 +0,0 @@ -<h1>SDLTextFieldName 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-+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> - <li><a href="#section-+statusBar">+statusBar</a></li> - <li><a href="#section-+mediaClock">+mediaClock</a></li> - <li><a href="#section-+mediaTrack">+mediaTrack</a></li> - <li><a href="#section-+alertText1">+alertText1</a></li> - <li><a href="#section-+alertText2">+alertText2</a></li> - <li><a href="#section-+alertText3">+alertText3</a></li> - <li><a href="#section-+scrollableMessageBody">+scrollableMessageBody</a></li> - <li><a href="#section-+initialInteractionText">+initialInteractionText</a></li> - <li><a href="#section-+navigationText1">+navigationText1</a></li> - <li><a href="#section-+navigationText2">+navigationText2</a></li> - <li><a href="#section-+ETA">+ETA</a></li> - <li><a href="#section-+totalDistance">+totalDistance</a></li> - <li><a href="#section-+audioPassThruDisplayText1">+audioPassThruDisplayText1</a></li> - <li><a href="#section-+audioPassThruDisplayText2">+audioPassThruDisplayText2</a></li> - <li><a href="#section-+sliderHeader">+sliderHeader</a></li> - <li><a href="#section-+sliderFooter">+sliderFooter</a></li> - <li><a href="#section-+menuName">+menuName</a></li> - <li><a href="#section-+secondaryText">+secondaryText</a></li> - <li><a href="#section-+tertiaryText">+tertiaryText</a></li> - <li><a href="#section-+menuTitle">+menuTitle</a></li> - <li><a href="#section-+locationName">+locationName</a></li> - <li><a href="#section-+locationDescription">+locationDescription</a></li> - <li><a href="#section-+addressLines">+addressLines</a></li> - <li><a href="#section-+phoneNumber">+phoneNumber</a></li> -</ul> - -<h3>Overview</h3> - -<p>Names of the text fields that can appear on a SDL display.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLTextFieldName</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</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">SDLTextFieldName</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>SDLTextFieldName</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLTextFieldName</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 SDLTextFieldName</p> - - </div> - - <h3 id="section-+mainField1"> - +mainField1 - </h3> - - <p>@abstract The first line of the first set of main fields of the persistent display. Applies to SDLShow.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">mainField1</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">mainField1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>mainField1</em></p> - - </div> - - <h3 id="section-+mainField2"> - +mainField2 - </h3> - - <p>@abstract The second line of the first set of main fields of the persistent display. Applies to SDLShow.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">mainField2</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">mainField2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>mainField2</em></p> - - </div> - - <h3 id="section-+mainField3"> - +mainField3 - </h3> - - <p>@abstract The first line of the second set of main fields of the persistent display. Applies to SDLShow.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">mainField3</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">mainField3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>mainField3</em></p> - - </div> - - <h3 id="section-+mainField4"> - +mainField4 - </h3> - - <p>@abstract The second line of the second set of main fields of the persistent display. Applies to SDLShow.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">mainField4</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">mainField4</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>mainField4</em></p> - - </div> - - <h3 id="section-+statusBar"> - +statusBar - </h3> - - <p>@abstract The status bar on the NGN display. Applies to SDLShow.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">statusBar</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">statusBar</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>statusBar</em></p> - - </div> - - <h3 id="section-+mediaClock"> - +mediaClock - </h3> - - <p>@abstract Text value for MediaClock field. Must be properly formatted according to MediaClockFormat. Applies to SDLShow.</p> - -<p>@discussion This field is commonly used to show elapsed or remaining time in an audio track or audio capture.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">mediaClock</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">mediaClock</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>mediaClock</em></p> - - </div> - - <h3 id="section-+mediaTrack"> - +mediaTrack - </h3> - - <p>@abstract The track field of NGN type ACMs. This field is only available for media applications on a NGN display. Applies to SDLShow.</p> - -<p>@discussion This field is commonly used to show the current track number</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">mediaTrack</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">mediaTrack</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>mediaTrack</em></p> - - </div> - - <h3 id="section-+alertText1"> - +alertText1 - </h3> - - <p>@abstract The first line of the alert text field. Applies to SDLAlert.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">alertText1</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">alertText1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>alertText1</em></p> - - </div> - - <h3 id="section-+alertText2"> - +alertText2 - </h3> - - <p>@abstract The second line of the alert text field. Applies to SDLAlert.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">alertText2</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">alertText2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>alertText2</em></p> - - </div> - - <h3 id="section-+alertText3"> - +alertText3 - </h3> - - <p>@abstract The third line of the alert text field. Applies to SDLAlert.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">alertText3</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">alertText3</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>alertText3</em></p> - - </div> - - <h3 id="section-+scrollableMessageBody"> - +scrollableMessageBody - </h3> - - <p>@abstract Long form body of text that can include newlines and tabs. Applies to SDLScrollableMessage.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">scrollableMessageBody</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">scrollableMessageBody</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>scrollableMessageBody</em></p> - - </div> - - <h3 id="section-+initialInteractionText"> - +initialInteractionText - </h3> - - <p>@abstract First line suggestion for a user response (in the case of VR enabled interaction).</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">initialInteractionText</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">initialInteractionText</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>initialInteractionText</em></p> - - </div> - - <h3 id="section-+navigationText1"> - +navigationText1 - </h3> - - <p>@abstract First line of navigation text.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">navigationText1</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">navigationText1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>navigationText1</em></p> - - </div> - - <h3 id="section-+navigationText2"> - +navigationText2 - </h3> - - <p>@abstract Second line of navigation text.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">navigationText2</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">navigationText2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>navigationText2</em></p> - - </div> - - <h3 id="section-+ETA"> - +ETA - </h3> - - <p>@abstract Estimated Time of Arrival time for navigation.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">ETA</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">eta</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>ETA</em></p> - - </div> - - <h3 id="section-+totalDistance"> - +totalDistance - </h3> - - <p>@abstract Total distance to destination for navigation.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">totalDistance</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">totalDistance</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>totalDistance</em></p> - - </div> - - <h3 id="section-+audioPassThruDisplayText1"> - +audioPassThruDisplayText1 - </h3> - - <p>@abstract First line of text for audio pass thru.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">audioPassThruDisplayText1</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">audioPassThruDisplayText1</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>audioPassThruDisplayText1</em></p> - - </div> - - <h3 id="section-+audioPassThruDisplayText2"> - +audioPassThruDisplayText2 - </h3> - - <p>@abstract Second line of text for audio pass thru.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">audioPassThruDisplayText2</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">audioPassThruDisplayText2</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>audioPassThruDisplayText2</em></p> - - </div> - - <h3 id="section-+sliderHeader"> - +sliderHeader - </h3> - - <p>@abstract Header text for slider.</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">sliderHeader</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">sliderHeader</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>sliderHeader</em></p> - - </div> - - <h3 id="section-+sliderFooter"> - +sliderFooter - </h3> - - <p>@abstract Footer text for slider</p> - -<p>@since SDL 2.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">sliderFooter</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">sliderFooter</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>sliderFooter</em></p> - - </div> - - <h3 id="section-+menuName"> - +menuName - </h3> - - <p>Primary text for SDLChoice</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">menuName</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">menu</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>menuName</em></p> - - </div> - - <h3 id="section-+secondaryText"> - +secondaryText - </h3> - - <p>Secondary text for SDLChoice</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">secondaryText</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">secondaryText</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>secondaryText</em></p> - - </div> - - <h3 id="section-+tertiaryText"> - +tertiaryText - </h3> - - <p>Tertiary text for SDLChoice</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">tertiaryText</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">tertiaryText</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>tertiaryText</em></p> - - </div> - - <h3 id="section-+menuTitle"> - +menuTitle - </h3> - - <p>Optional text to label an app menu button (for certain touchscreen platforms)</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">menuTitle</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">menuTitle</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>menuTitle</em></p> - - </div> - - <h3 id="section-+locationName"> - +locationName - </h3> - - <p>Optional name / title of intended location for SDLSendLocation</p> - -<p>@since SDL 4.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">locationName</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">location</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>locationName</em></p> - - </div> - - <h3 id="section-+locationDescription"> - +locationDescription - </h3> - - <p>Optional description of intended location / establishment (if applicable) for SDLSendLocation</p> - -<p>@since SDL 4.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">locationDescription</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">locationDescription</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>locationDescription</em></p> - - </div> - - <h3 id="section-+addressLines"> - +addressLines - </h3> - - <p>Optional location address (if applicable) for SDLSendLocation</p> - -<p>@since SDL 4.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">addressLines</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">addressLines</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>addressLines</em></p> - - </div> - - <h3 id="section-+phoneNumber"> - +phoneNumber - </h3> - - <p>Optional hone number of intended location / establishment (if applicable) for SDLSendLocation</p> - -<p>@since SDL 4.0</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTextFieldName</span> <span class="o">*</span><span class="p">)</span><span class="n">phoneNumber</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">phoneNumber</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTextFieldName</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLTextFieldName with value of <em>phoneNumber</em></p> - - </div> - -</section> diff --git a/docs/Classes/SDLTimerMode.html b/docs/Classes/SDLTimerMode.html deleted file mode 100644 index 93d9261ce..000000000 --- a/docs/Classes/SDLTimerMode.html +++ /dev/null @@ -1,74 +0,0 @@ -<h1>SDLTimerMode 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-+UP">+UP</a></li> - <li><a href="#section-+DOWN">+DOWN</a></li> - <li><a href="#section-+NONE">+NONE</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+UP"> - +UP - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+DOWN"> - +DOWN - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+NONE"> - +NONE - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLTireStatus.html b/docs/Classes/SDLTireStatus.html index 72a931341..f07b2a1b6 100644 --- a/docs/Classes/SDLTireStatus.html +++ b/docs/Classes/SDLTireStatus.html @@ -3,8 +3,6 @@ <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-pressureTelltale">pressureTelltale</a></li> <li><a href="#section-leftFront">leftFront</a></li> <li><a href="#section-rightFront">rightFront</a></li> @@ -20,28 +18,6 @@ <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-pressureTelltale"> pressureTelltale </h3> diff --git a/docs/Classes/SDLTouch.html b/docs/Classes/SDLTouch.html new file mode 100644 index 000000000..41a8ad0d3 --- /dev/null +++ b/docs/Classes/SDLTouch.html @@ -0,0 +1,145 @@ +<h1>SDLTouch Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithTouchEvent:">-initWithTouchEvent:</a></li> + <li><a href="#section-identifier">identifier</a></li> + <li><a href="#section-location">location</a></li> + <li><a href="#section-timeStamp">timeStamp</a></li> + <li><a href="#section-isFirstFinger">isFirstFinger</a></li> + <li><a href="#section-isSecondFinger">isSecondFinger</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithTouchEvent:"> + -initWithTouchEvent: + </h3> + + <p>@abstract + Initializes a touch.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTouchEvent</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLTouchEvent.html">SDLTouchEvent</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">touchEvent</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">touchEvent</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLTouchEvent.html">SDLTouchEvent</a></span><span class="p">)</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>touchEvent</dt> + <dd><p>Incoming touch event from onOnTouchEvent notification.</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>SDLTouch +Instance of SDLTouch.</p> + </div> + + <h3 id="section-identifier"> + identifier + </h3> + + <p>@abstract + Identifier of the touch’s finger. Refer to SDLTouchIdentifier for valid + identifiers.</p> + + + + <h4>Objective-C</h4> + <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">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSInteger</span> <span class="n">identifier</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">Int</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-location"> + location + </h3> + + <p>@abstract + Location of touch point, in the head unit’s coordinate system.</p> + + + + <h4>Objective-C</h4> + <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">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">CGPoint</span> <span class="n">location</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">location</span><span class="p">:</span> <span class="kt">CGPoint</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-timeStamp"> + timeStamp + </h3> + + <p>@abstract + Timestamp in which the touch occured.</p> + + + + <h4>Objective-C</h4> + <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">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">timeStamp</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeStamp</span><span class="p">:</span> <span class="kt">UInt</span> <span class="p">{</span> <span class="k">get</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-isFirstFinger"> + isFirstFinger + </h3> + + <p>@abstract + Returns whether or not this touch is a first finger.</p> + + + + <h4>Objective-C</h4> + <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">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">isFirstFinger</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isFirstFinger</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> + + + + + <h3 id="section-isSecondFinger"> + isSecondFinger + </h3> + + <p>@abstract + Returns whether or not this touch is a second finger.</p> + + + + <h4>Objective-C</h4> + <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">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">isSecondFinger</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">isSecondFinger</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> + + + + +</section> diff --git a/docs/Classes/SDLTouchCoord.html b/docs/Classes/SDLTouchCoord.html index 5effd07bb..7bb7a86ff 100644 --- a/docs/Classes/SDLTouchCoord.html +++ b/docs/Classes/SDLTouchCoord.html @@ -3,8 +3,6 @@ <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-x">x</a></li> <li><a href="#section-y">y</a></li> </ul> @@ -15,28 +13,6 @@ <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-x"> x </h3> diff --git a/docs/Classes/SDLTouchEvent.html b/docs/Classes/SDLTouchEvent.html index d9ef95c1d..6e6284586 100644 --- a/docs/Classes/SDLTouchEvent.html +++ b/docs/Classes/SDLTouchEvent.html @@ -3,8 +3,6 @@ <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-touchEventId">touchEventId</a></li> <li><a href="#section-timeStamp">timeStamp</a></li> <li><a href="#section-coord">coord</a></li> @@ -16,28 +14,6 @@ <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-touchEventId"> touchEventId </h3> @@ -51,11 +27,11 @@ If a touch event has type end, the id should be removed from the set of touches. <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">touchEventId</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">touchEventId</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">touchEventId</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">touchEventId</span><span class="p">:</span> <span class="kt">NSNumber</span> </code></pre> @@ -77,11 +53,12 @@ If a touch event has type end, the id should be removed from the set of touches. <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">timeStamp</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">timeStamp</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeStamp</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">timeStamp</span><span class="p">:</span> <span class="p">[</span><span class="kt">NSNumber</span> </code></pre> @@ -95,11 +72,12 @@ If a touch event has type end, the id should be removed from the set of touches. <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">coord</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTouchCoord.html">SDLTouchCoord</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">coord</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">coord</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">coord</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTouchCoord.html">SDLTouchCoord</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> diff --git a/docs/Classes/SDLTouchEventCapabilities.html b/docs/Classes/SDLTouchEventCapabilities.html index 1c7610a06..b360bd919 100644 --- a/docs/Classes/SDLTouchEventCapabilities.html +++ b/docs/Classes/SDLTouchEventCapabilities.html @@ -3,8 +3,6 @@ <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-pressAvailable">pressAvailable</a></li> <li><a href="#section-multiTouchAvailable">multiTouchAvailable</a></li> <li><a href="#section-doublePressAvailable">doublePressAvailable</a></li> @@ -16,28 +14,6 @@ <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-pressAvailable"> pressAvailable </h3> diff --git a/docs/Classes/SDLTouchManager.html b/docs/Classes/SDLTouchManager.html index 88f076596..fa9fcc870 100644 --- a/docs/Classes/SDLTouchManager.html +++ b/docs/Classes/SDLTouchManager.html @@ -4,11 +4,14 @@ <ul> <li><a href="#section-touchEventDelegate">touchEventDelegate</a></li> + <li><a href="#section-touchEventHandler">touchEventHandler</a></li> <li><a href="#section-tapDistanceThreshold">tapDistanceThreshold</a></li> <li><a href="#section-tapTimeThreshold">tapTimeThreshold</a></li> <li><a href="#section-movementTimeThreshold">movementTimeThreshold</a></li> <li><a href="#section-touchEnabled">touchEnabled</a></li> <li><a href="#section--cancelPendingTouches">-cancelPendingTouches</a></li> + <li><a href="#section--init">-init</a></li> + <li><a href="#section--initWithHitTester:">-initWithHitTester:</a></li> </ul> <h3>Overview</h3> @@ -21,22 +24,48 @@ touchEventDelegate </h3> - <p>Undocumented</p> + <p>Notified of processed touches such as pinches, pans, and taps</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">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLTouchManagerDelegate.html">SDLTouchManagerDelegate</a></span><span class="o">></span> + <span class="n">touchEventDelegate</span><span class="p">;</span></code></pre> + <h3 id="section-touchEventHandler"> + touchEventHandler + </h3> + + <p>@abstract + Returns all OnTouchEvent notifications as SDLTouch and SDLTouchType objects.</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Type Definitions.html#/c:SDLTouchManager.h@T@SDLTouchEventHandler">SDLTouchEventHandler</a></span> <span class="n">touchEventHandler</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">touchEventHandler</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLTouchManager.h@T@SDLTouchEventHandler">SDLTouchEventHandler</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + <h3 id="section-tapDistanceThreshold"> tapDistanceThreshold </h3> - <p>@abstract - Distance between two taps on the screen, in the head unit’s coordinate system, used - for registering double-tap callbacks. -@remark - Default is 50 pixels.</p> + <p>Distance between two taps on the screen, in the head unit’s coordinate system, used for registering double-tap callbacks.</p> +<div class="aside aside-note"> + <p class="aside-title">Note</p> + Defaults to 50 px. + +</div> @@ -44,6 +73,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 +94,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 +116,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 +139,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,7 +160,46 @@ <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> + + + + + <h3 id="section--init"> + -init + </h3> + + <p>Undocumented</p> + + + + + + + <h3 id="section--initWithHitTester:"> + -initWithHitTester: + </h3> + + <p>Initialize a touch manager with a hit tester if available</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHitTester</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n">SDLHapticHitTester</span><span class="o">></span><span class="p">)</span><span class="nv">hitTester</span><span class="p">;</span></code></pre> + + + <h4>Parameters</h4> + <dl> + <dt>hitTester</dt> + <dd><p>The hit tester to be used to correlate a point with a view</p></dd> + </dl> + <div> + <h4>Return Value</h4> + <p>The initialized touch manager</p> + </div> </section> diff --git a/docs/Classes/SDLTouchType.html b/docs/Classes/SDLTouchType.html deleted file mode 100644 index 2d2091a9f..000000000 --- a/docs/Classes/SDLTouchType.html +++ /dev/null @@ -1,74 +0,0 @@ -<h1>SDLTouchType 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-+BEGIN">+BEGIN</a></li> - <li><a href="#section-+MOVE">+MOVE</a></li> - <li><a href="#section-+END">+END</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+values"> - +values - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+BEGIN"> - +BEGIN - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+MOVE"> - +MOVE - </h3> - - <p>Undocumented</p> - - - - - - - <h3 id="section-+END"> - +END - </h3> - - <p>Undocumented</p> - - - - - - -</section> diff --git a/docs/Classes/SDLTriggerSource.html b/docs/Classes/SDLTriggerSource.html deleted file mode 100644 index 1c0dd6486..000000000 --- a/docs/Classes/SDLTriggerSource.html +++ /dev/null @@ -1,148 +0,0 @@ -<h1>SDLTriggerSource 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-+MENU">+MENU</a></li> - <li><a href="#section-+VR">+VR</a></li> - <li><a href="#section-+KEYBOARD">+KEYBOARD</a></li> -</ul> - -<h3>Overview</h3> - -<p>Indicates whether choice/command was selected via VR or via a menu selection (using SEEKRIGHT/SEEKLEFT, TUNEUP, TUNEDOWN, OK buttons)</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLTriggerSource -- parameter: value The value of the string to get an object for -- returns: SDLTriggerSource</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTriggerSource</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">SDLTriggerSource</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>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> - - - - <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 SDLTriggerSource</p> - - </div> - - <h3 id="section-+MENU"> - +MENU - </h3> - - <p>@abstract Selection made via menu -- returns: SDLTriggerSource with value of <em>MENU</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTriggerSource</span> <span class="o">*</span><span class="p">)</span><span class="n">MENU</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">menu</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTriggerSource</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTriggerSource</span> <span class="o">*</span><span class="p">)</span><span class="n">VR</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">vr</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTriggerSource</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLTriggerSource</span> <span class="o">*</span><span class="p">)</span><span class="n">KEYBOARD</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">keyboard</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLTriggerSource</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLTriggerSource with value of <em>KEYBOARD</em></p> - - </div> - -</section> diff --git a/docs/Classes/SDLTurn.html b/docs/Classes/SDLTurn.html index 68ffa480b..81a4f3a0d 100644 --- a/docs/Classes/SDLTurn.html +++ b/docs/Classes/SDLTurn.html @@ -3,8 +3,6 @@ <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--initWithNavigationText:turnIcon:">-initWithNavigationText:turnIcon:</a></li> <li><a href="#section-navigationText">navigationText</a></li> <li><a href="#section-turnIcon">turnIcon</a></li> @@ -16,28 +14,6 @@ <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--initWithNavigationText:turnIcon:"> -initWithNavigationText:turnIcon: </h3> diff --git a/docs/Classes/SDLUnregisterAppInterface.html b/docs/Classes/SDLUnregisterAppInterface.html deleted file mode 100644 index 53f609bf8..000000000 --- a/docs/Classes/SDLUnregisterAppInterface.html +++ /dev/null @@ -1,72 +0,0 @@ -<h1>SDLUnregisterAppInterface 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>Terminates an application’s interface registration. This causes SDL® to - dispose of all resources associated with the application’s interface - registration (e.g. Command Menu items, Choice Sets, button subscriptions, - etc.) - <p> - After the UnregisterAppInterface operation is performed, no other operations - can be performed until a new app interface registration is established by - calling <i>{@linkplain RegisterAppInterface}</i> - <p> - <b>HMILevel can be FULL, LIMITED, BACKGROUND or NONE</b> - </p></p> - -<p>See SDLRegisterAppInterface SDLOnAppInterfaceUnregistered</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLUnregisterAppInterface 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 new SDLUnregisterAppInterface object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLUnregisterAppInterfaceResponse.html b/docs/Classes/SDLUnregisterAppInterfaceResponse.html deleted file mode 100644 index 58aa335be..000000000 --- a/docs/Classes/SDLUnregisterAppInterfaceResponse.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLUnregisterAppInterfaceResponse 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>Unregister AppInterface Response is sent, when SDLUnregisterAppInterface has been called</p> - -<p>@since SmartDeviceLink 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLUnregisterAppInterfaceResponse 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 new SDLUnregisterAppInterfaceResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLUnsubscribeButton.html b/docs/Classes/SDLUnsubscribeButton.html index 85090973c..b4a0abf34 100644 --- a/docs/Classes/SDLUnsubscribeButton.html +++ b/docs/Classes/SDLUnsubscribeButton.html @@ -3,8 +3,6 @@ <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--initWithButtonName:">-initWithButtonName:</a></li> <li><a href="#section-buttonName">buttonName</a></li> </ul> @@ -25,50 +23,6 @@ See SDLSubscribeButton</p> <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLUnsubscribeButton 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 new SDLUnsubscribeButton object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--initWithButtonName:"> -initWithButtonName: </h3> @@ -78,7 +32,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> @@ -95,11 +49,11 @@ parameter <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/SDLButtonName.html">SDLButtonName</a></span> <span class="o">*</span><span class="n">buttonName</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</a></span> <span class="n">_Nonnull</span> <span class="n">buttonName</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLButtonName.html">SDLButtonName</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">buttonName</span><span class="p">:</span> <span class="kt"><a href="../Type Definitions.html#/c:SDLButtonName.h@T@SDLButtonName">SDLButtonName</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/SDLUnsubscribeButtonResponse.html b/docs/Classes/SDLUnsubscribeButtonResponse.html deleted file mode 100644 index 9242ae1d7..000000000 --- a/docs/Classes/SDLUnsubscribeButtonResponse.html +++ /dev/null @@ -1,62 +0,0 @@ -<h1>SDLUnsubscribeButtonResponse 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>Unsubscribe Button Response is sent, when SDLUnsubscribeButton has been called</p> - -<p>@since SmartDeviceLink 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLUnsubscribeButtonResponse 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 new SDLUnsubscribeButtonResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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> - -</section> diff --git a/docs/Classes/SDLUnsubscribeVehicleData.html b/docs/Classes/SDLUnsubscribeVehicleData.html index 02cabae1b..11adf368f 100644 --- a/docs/Classes/SDLUnsubscribeVehicleData.html +++ b/docs/Classes/SDLUnsubscribeVehicleData.html @@ -3,8 +3,6 @@ <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--initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:">-initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:</a></li> <li><a href="#section-gps">gps</a></li> <li><a href="#section-speed">speed</a></li> @@ -47,50 +45,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLUnsubscribeVehicleData 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 new SDLUnsubscribeVehicleData object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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--initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus:"> -initWithAccelerationPedalPosition:airbagStatus:beltStatus:bodyInformation:clusterModeStatus:deviceStatus:driverBraking:eCallInfo:emergencyEvent:engineTorque:externalTemperature:fuelLevel:fuelLevelState:gps:headLampStatus:instantFuelConsumption:myKey:odometer:prndl:rpm:speed:steeringWheelAngle:tirePressure:wiperStatus: </h3> @@ -100,7 +54,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> @@ -115,11 +69,11 @@ parameter <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">gps</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -133,11 +87,11 @@ parameter <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">speed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -151,11 +105,11 @@ parameter <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">rpm</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">rpm</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -169,11 +123,11 @@ parameter <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">fuelLevel</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">fuelLevel</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -187,11 +141,12 @@ parameter <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">fuelLevel_State</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -205,11 +160,12 @@ parameter <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">instantFuelConsumption</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">instantFuelConsumption</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -223,11 +179,12 @@ parameter <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">externalTemperature</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">externalTemperature</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -241,11 +198,11 @@ parameter <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">prndl</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">prndl</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -259,11 +216,12 @@ parameter <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">tirePressure</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -277,11 +235,11 @@ parameter <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">odometer</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">odometer</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -295,11 +253,11 @@ parameter <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">beltStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -313,11 +271,12 @@ parameter <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">bodyInformation</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -331,11 +290,12 @@ parameter <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">deviceStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -349,11 +309,12 @@ parameter <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">driverBraking</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">driverBraking</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -367,11 +328,12 @@ parameter <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">wiperStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">wiperStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -385,11 +347,12 @@ parameter <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">headLampStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -403,11 +366,12 @@ parameter <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">engineTorque</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">engineTorque</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -421,11 +385,12 @@ parameter <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">accPedalPosition</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">accPedalPosition</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> </code></pre> @@ -439,7 +404,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 +419,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 +434,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 +449,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 +464,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 +479,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..f7ba7c3dc 100644 --- a/docs/Classes/SDLUnsubscribeVehicleDataResponse.html +++ b/docs/Classes/SDLUnsubscribeVehicleDataResponse.html @@ -3,8 +3,6 @@ <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-gps">gps</a></li> <li><a href="#section-speed">speed</a></li> <li><a href="#section-rpm">rpm</a></li> @@ -39,50 +37,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a new SDLUnsubscribeVehicleDataResponse 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 new SDLUnsubscribeVehicleDataResponse object indicated by the NSMutableDictionary -parameter -- parameter: dict The dictionary to use</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-gps"> gps </h3> @@ -92,11 +46,11 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">gps</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">gps</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">gps</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -110,11 +64,11 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">speed</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">speed</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">speed</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -128,11 +82,11 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">rpm</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">rpm</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">rpm</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">rpm</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -146,11 +100,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">fuelLevel</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">fuelLevel</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">fuelLevel</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -164,11 +119,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">fuelLevel_State</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">fuelLevel_State</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">fuelLevel_State</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -182,12 +138,12 @@ parameter <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> + <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">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">instantFuelConsumption</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">instantFuelConsumption</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">instantFuelConsumption</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -201,11 +157,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">externalTemperature</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">externalTemperature</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">externalTemperature</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">externalTemperature</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -219,11 +176,11 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">prndl</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">prndl</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">prndl</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">prndl</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -237,11 +194,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">tirePressure</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">tirePressure</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">tirePressure</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -255,11 +213,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">odometer</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">odometer</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">odometer</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">odometer</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -273,11 +232,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">beltStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">beltStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">beltStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -291,11 +251,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">bodyInformation</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">bodyInformation</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">bodyInformation</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -309,11 +270,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">deviceStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">deviceStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">deviceStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -327,11 +289,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">driverBraking</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">driverBraking</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">driverBraking</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">driverBraking</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -345,11 +308,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">wiperStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">wiperStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">wiperStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">wiperStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -363,11 +327,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">headLampStatus</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">headLampStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">headLampStatus</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -381,11 +346,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">engineTorque</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">engineTorque</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">engineTorque</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">engineTorque</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -399,11 +365,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">accPedalPosition</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">accPedalPosition</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">accPedalPosition</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">accPedalPosition</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -417,11 +384,12 @@ parameter <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/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">steeringWheelAngle</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</a></span> <span class="o">*</span><span class="n">steeringWheelAngle</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">steeringWheelAngle</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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">steeringWheelAngle</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVehicleDataResult.html">SDLVehicleDataResult</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> @@ -435,7 +403,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 +418,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 +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> @@ -480,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> @@ -495,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> diff --git a/docs/Classes/SDLUpdateMode.html b/docs/Classes/SDLUpdateMode.html deleted file mode 100644 index 47d168dd2..000000000 --- a/docs/Classes/SDLUpdateMode.html +++ /dev/null @@ -1,192 +0,0 @@ -<h1>SDLUpdateMode 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-+COUNTUP">+COUNTUP</a></li> - <li><a href="#section-+COUNTDOWN">+COUNTDOWN</a></li> - <li><a href="#section-+PAUSE">+PAUSE</a></li> - <li><a href="#section-+RESUME">+RESUME</a></li> - <li><a href="#section-+CLEAR">+CLEAR</a></li> -</ul> - -<h3>Overview</h3> - -<p>Specifies what function should be performed on the media clock/counter</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLUpdateMode -- parameter: value The value of the string to get an object for -- returns: SDLUpdateMode</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLUpdateMode</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">SDLUpdateMode</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>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> - - - - <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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLUpdateMode</span> <span class="o">*</span><span class="p">)</span><span class="n">COUNTUP</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">countup</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLUpdateMode</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLUpdateMode</span> <span class="o">*</span><span class="p">)</span><span class="n">COUNTDOWN</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">countdown</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLUpdateMode</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLUpdateMode</span> <span class="o">*</span><span class="p">)</span><span class="n">PAUSE</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">pause</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLUpdateMode</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLUpdateMode</span> <span class="o">*</span><span class="p">)</span><span class="n">RESUME</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">resume</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLUpdateMode</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLUpdateMode with value of <em>RESUME</em></p> - - </div> - - <h3 id="section-+CLEAR"> - +CLEAR - </h3> - - <p>@abstract Clear the media clock timer.</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLUpdateMode</span> <span class="o">*</span><span class="p">)</span><span class="n">CLEAR</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">clear</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLUpdateMode</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLUpdateTurnList.html b/docs/Classes/SDLUpdateTurnList.html index c17859838..7a22b05c4 100644 --- a/docs/Classes/SDLUpdateTurnList.html +++ b/docs/Classes/SDLUpdateTurnList.html @@ -3,8 +3,6 @@ <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--initWithTurnList:softButtons:">-initWithTurnList:softButtons:</a></li> <li><a href="#section-turnList">turnList</a></li> <li><a href="#section-softButtons">softButtons</a></li> @@ -12,43 +10,16 @@ <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"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - +<section class="section task-group-section"> <h3 id="section--initWithTurnList:softButtons:"> -initWithTurnList:softButtons: </h3> @@ -58,7 +29,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> @@ -73,11 +44,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">turnList</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLTurn.html">SDLTurn</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">turnList</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">turnList</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">turnList</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLTurn.html">SDLTurn</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> @@ -91,11 +62,12 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSMutableArray</span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtons</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> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">softButtons</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLSoftButton.html">SDLSoftButton</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> diff --git a/docs/Classes/SDLUpdateTurnListResponse.html b/docs/Classes/SDLUpdateTurnListResponse.html deleted file mode 100644 index 145817db3..000000000 --- a/docs/Classes/SDLUpdateTurnListResponse.html +++ /dev/null @@ -1,47 +0,0 @@ -<h1>SDLUpdateTurnListResponse 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>SDLUpdateTurnListResponse is sent, when SDLUpdateTurnList has been called. - * Since<b>SmartDeviceLink 2.0</b></p> - - -<section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - - <h3 id="section--initWithDictionary:"> - -initWithDictionary: - </h3> - - <p>Undocumented</p> - - - - <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> - - - - - -</section> diff --git a/docs/Classes/SDLVRCapabilities.html b/docs/Classes/SDLVRCapabilities.html deleted file mode 100644 index 493f77a3d..000000000 --- a/docs/Classes/SDLVRCapabilities.html +++ /dev/null @@ -1,98 +0,0 @@ -<h1>SDLVRCapabilities 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-+TEXT">+TEXT</a></li> -</ul> - -<h3>Overview</h3> - -<p>The VR capabilities of the connected SDL platform.</p> - -<p>@since SDL 1.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLVRCapabilities -- parameter: value The value of the string to get an object for -- returns: SDLVRCapabilities</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVRCapabilities</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">SDLVRCapabilities</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>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> - - - - <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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVRCapabilities</span> <span class="o">*</span><span class="p">)</span><span class="n">TEXT</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">text</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVRCapabilities</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>an SDLVRCapabilities instance pointer with value of <em>TEXT</em></p> - - </div> - -</section> diff --git a/docs/Classes/SDLVRHelpItem.html b/docs/Classes/SDLVRHelpItem.html index 302744b2e..9dfb11397 100644 --- a/docs/Classes/SDLVRHelpItem.html +++ b/docs/Classes/SDLVRHelpItem.html @@ -3,8 +3,6 @@ <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--initWithText:image:">-initWithText:image:</a></li> <li><a href="#section--initWithText:image:position:">-initWithText:image:position:</a></li> <li><a href="#section-text">text</a></li> @@ -18,28 +16,6 @@ <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--initWithText:image:"> -initWithText:image: </h3> diff --git a/docs/Classes/SDLVehicleDataActiveStatus.html b/docs/Classes/SDLVehicleDataActiveStatus.html deleted file mode 100644 index 976bd48de..000000000 --- a/docs/Classes/SDLVehicleDataActiveStatus.html +++ /dev/null @@ -1,160 +0,0 @@ -<h1>SDLVehicleDataActiveStatus 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-+INACTIVE_NOT_CONFIRMED">+INACTIVE_NOT_CONFIRMED</a></li> - <li><a href="#section-+INACTIVE_CONFIRMED">+INACTIVE_CONFIRMED</a></li> - <li><a href="#section-+ACTIVE_NOT_CONFIRMED">+ACTIVE_NOT_CONFIRMED</a></li> - <li><a href="#section-+ACTIVE_CONFIRMED">+ACTIVE_CONFIRMED</a></li> - <li><a href="#section-+FAULT">+FAULT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Vehicle Data Activity Status</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLVehicleDataActiveStatus -- parameter: value NSString -- returns: SDLVehicleDataActiveStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataActiveStatus</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">SDLVehicleDataActiveStatus</span><span class="o">!</span></code></pre> - - - - <h4>Parameters</h4> - <dl> - <dt>value</dt> - <dd><p>NSString</p> -</dd> - </dl> - <div> - <h4>Return Value</h4> - <p>SDLVehicleDataActiveStatus</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract return the array that store all possible SDLVehicleDataActiveStatus 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> - - - - - <h3 id="section-+INACTIVE_NOT_CONFIRMED"> - +INACTIVE_NOT_CONFIRMED - </h3> - - <p>@abstract SDLVehicleDataActiveStatus : Inactive not confirmed</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataActiveStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">INACTIVE_NOT_CONFIRMED</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">inactive_NOT_CONFIRMED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataActiveStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+INACTIVE_CONFIRMED"> - +INACTIVE_CONFIRMED - </h3> - - <p>@abstract SDLVehicleDataActiveStatus : Inactive confirmed</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataActiveStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">INACTIVE_CONFIRMED</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">inactive_CONFIRMED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataActiveStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ACTIVE_NOT_CONFIRMED"> - +ACTIVE_NOT_CONFIRMED - </h3> - - <p>@abstract SDLVehicleDataActiveStatus : Active not confirmed</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataActiveStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ACTIVE_NOT_CONFIRMED</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">active_NOT_CONFIRMED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataActiveStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ACTIVE_CONFIRMED"> - +ACTIVE_CONFIRMED - </h3> - - <p>@abstract SDLVehicleDataActiveStatus : Active confirmed</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataActiveStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ACTIVE_CONFIRMED</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">active_CONFIRMED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataActiveStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+FAULT"> - +FAULT - </h3> - - <p>@abstract SDLVehicleDataActiveStatus : Fault</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataActiveStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">FAULT</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">fault</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataActiveStatus</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLVehicleDataEventStatus.html b/docs/Classes/SDLVehicleDataEventStatus.html deleted file mode 100644 index e0aedc3b3..000000000 --- a/docs/Classes/SDLVehicleDataEventStatus.html +++ /dev/null @@ -1,182 +0,0 @@ -<h1>SDLVehicleDataEventStatus 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-+NO_EVENT">+NO_EVENT</a></li> - <li><a href="#section-+_NO">+_NO</a></li> - <li><a href="#section-+_YES">+_YES</a></li> - <li><a href="#section-+NOT_SUPPORTED">+NOT_SUPPORTED</a></li> - <li><a href="#section-+FAULT">+FAULT</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the status of a vehicle data event; e.g. a seat belt event status.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLVehicleDataEventStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataEventStatus</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">SDLVehicleDataEventStatus</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>SDLVehicleDataEventStatus</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLVehicleDataEventStatus</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 SDLVehicleDataEventStatus</p> - - </div> - - <h3 id="section-+NO_EVENT"> - +NO_EVENT - </h3> - - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataEventStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NO_EVENT</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">no_EVENT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataEventStatus</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLVehicleDataEventStatus instance with value of <em>NO_EVENT</em></p> - - </div> - - <h3 id="section-+_NO"> - +_NO - </h3> - - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataEventStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">_NO</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">_NO</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataEventStatus</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLVehicleDataEventStatus instance with value of <em>NO</em></p> - - </div> - - <h3 id="section-+_YES"> - +_YES - </h3> - - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataEventStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">_YES</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">_YES</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataEventStatus</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>The SDLVehicleDataEventStatus instance with value of <em>YES</em></p> - - </div> - - <h3 id="section-+NOT_SUPPORTED"> - +NOT_SUPPORTED - </h3> - - <p>@abstract Vehicle data event is not supported</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataEventStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NOT_SUPPORTED</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">not_SUPPORTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataEventStatus</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>the SDLVehicleDataEventStatus instance with value of <em>NOT_SUPPORTED</em></p> - - </div> - - <h3 id="section-+FAULT"> - +FAULT - </h3> - - <p>@abstract The SDLVehicleDataEventStatus instance with value of <em>FAULT</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataEventStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">FAULT</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">fault</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataEventStatus</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLVehicleDataNotificationStatus.html b/docs/Classes/SDLVehicleDataNotificationStatus.html deleted file mode 100644 index d166f696b..000000000 --- a/docs/Classes/SDLVehicleDataNotificationStatus.html +++ /dev/null @@ -1,149 +0,0 @@ -<h1>SDLVehicleDataNotificationStatus 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-+NOT_SUPPORTED">+NOT_SUPPORTED</a></li> - <li><a href="#section-+NORMAL">+NORMAL</a></li> - <li><a href="#section-+ACTIVE">+ACTIVE</a></li> - <li><a href="#section-+NOT_USED">+NOT_USED</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the status of a vehicle data notification.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLVehicleDataNotificationStatus -- parameter: value The value of the string to get an object for -- returns: SDLVehicleDataNotificationStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataNotificationStatus</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">SDLVehicleDataNotificationStatus</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>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> - - - - <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 SDLVehicleDataNotificationStatus</p> - - </div> - - <h3 id="section-+NOT_SUPPORTED"> - +NOT_SUPPORTED - </h3> - - <p>@abstract SDLVehicleDataNotificationStatus: <em>NOT_SUPPORTED</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataNotificationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NOT_SUPPORTED</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">not_SUPPORTED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataNotificationStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+NORMAL"> - +NORMAL - </h3> - - <p>@abstract SDLVehicleDataNotificationStatus: <em>NORMAL</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataNotificationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NORMAL</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">normal</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataNotificationStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ACTIVE"> - +ACTIVE - </h3> - - <p>@abstract SDLVehicleDataNotificationStatus: <em>ACTIVE</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataNotificationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ACTIVE</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">active</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataNotificationStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+NOT_USED"> - +NOT_USED - </h3> - - <p>@abstract SDLVehicleDataNotificationStatus: <em>NOT_USED</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataNotificationStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NOT_USED</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">not_USED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataNotificationStatus</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLVehicleDataResult.html b/docs/Classes/SDLVehicleDataResult.html index 0b9dd445a..806089fc4 100644 --- a/docs/Classes/SDLVehicleDataResult.html +++ b/docs/Classes/SDLVehicleDataResult.html @@ -3,8 +3,6 @@ <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-dataType">dataType</a></li> <li><a href="#section-resultCode">resultCode</a></li> </ul> @@ -15,28 +13,6 @@ <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-dataType"> dataType </h3> diff --git a/docs/Classes/SDLVehicleDataResultCode.html b/docs/Classes/SDLVehicleDataResultCode.html deleted file mode 100644 index 3b20200c0..000000000 --- a/docs/Classes/SDLVehicleDataResultCode.html +++ /dev/null @@ -1,242 +0,0 @@ -<h1>SDLVehicleDataResultCode 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-+SUCCESS">+SUCCESS</a></li> - <li><a href="#section-+TRUNCATED_DATA">+TRUNCATED_DATA</a></li> - <li><a href="#section-+DISALLOWED">+DISALLOWED</a></li> - <li><a href="#section-+USER_DISALLOWED">+USER_DISALLOWED</a></li> - <li><a href="#section-+INVALID_ID">+INVALID_ID</a></li> - <li><a href="#section-+VEHICLE_DATA_NOT_AVAILABLE">+VEHICLE_DATA_NOT_AVAILABLE</a></li> - <li><a href="#section-+DATA_ALREADY_SUBSCRIBED">+DATA_ALREADY_SUBSCRIBED</a></li> - <li><a href="#section-+DATA_NOT_SUBSCRIBED">+DATA_NOT_SUBSCRIBED</a></li> - <li><a href="#section-+IGNORED">+IGNORED</a></li> -</ul> - -<h3>Overview</h3> - -<p>Vehicle Data Result Code</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLVehicleDataResultCode -- parameter: value String -- returns: SDLVehicleDataResultCode</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</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">SDLVehicleDataResultCode</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>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> - - - - <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 SDLVehicleDataResultCode</p> - - </div> - - <h3 id="section-+SUCCESS"> - +SUCCESS - </h3> - - <p>Individual vehicle data item / DTC / DID request or subscription successful</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</span> <span class="o">*</span><span class="p">)</span><span class="n">SUCCESS</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">success</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataResultCode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+TRUNCATED_DATA"> - +TRUNCATED_DATA - </h3> - - <p>DTC / DID request successful, however, not all active DTCs or full contents of DID location available</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</span> <span class="o">*</span><span class="p">)</span><span class="n">TRUNCATED_DATA</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">truncated_DATA</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataResultCode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+DISALLOWED"> - +DISALLOWED - </h3> - - <p>This vehicle data item is not allowed for this app by SDL</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</span> <span class="o">*</span><span class="p">)</span><span class="n">DISALLOWED</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">disallowed</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataResultCode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+USER_DISALLOWED"> - +USER_DISALLOWED - </h3> - - <p>The user has not granted access to this type of vehicle data item at this time</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</span> <span class="o">*</span><span class="p">)</span><span class="n">USER_DISALLOWED</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">user_DISALLOWED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataResultCode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+INVALID_ID"> - +INVALID_ID - </h3> - - <p>The ECU ID referenced is not a valid ID on the bus / system</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</span> <span class="o">*</span><span class="p">)</span><span class="n">INVALID_ID</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">invalid_ID</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataResultCode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLE_DATA_NOT_AVAILABLE"> - +VEHICLE_DATA_NOT_AVAILABLE - </h3> - - <p>The requested vehicle data item / DTC / DID is not currently available or responding on the bus / system</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLE_DATA_NOT_AVAILABLE</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">vehicle_DATA_NOT_AVAILABLE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataResultCode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+DATA_ALREADY_SUBSCRIBED"> - +DATA_ALREADY_SUBSCRIBED - </h3> - - <p>The vehicle data item is already subscribed</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</span> <span class="o">*</span><span class="p">)</span><span class="n">DATA_ALREADY_SUBSCRIBED</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">data_ALREADY_SUBSCRIBED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataResultCode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+DATA_NOT_SUBSCRIBED"> - +DATA_NOT_SUBSCRIBED - </h3> - - <p>The vehicle data item cannot be unsubscribed because it is not currently subscribed</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</span> <span class="o">*</span><span class="p">)</span><span class="n">DATA_NOT_SUBSCRIBED</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">data_NOT_SUBSCRIBED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataResultCode</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+IGNORED"> - +IGNORED - </h3> - - <p>The request for this item is ignored because it is already in progress</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataResultCode</span> <span class="o">*</span><span class="p">)</span><span class="n">IGNORED</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">ignored</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataResultCode</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLVehicleDataStatus.html b/docs/Classes/SDLVehicleDataStatus.html deleted file mode 100644 index b2d702e14..000000000 --- a/docs/Classes/SDLVehicleDataStatus.html +++ /dev/null @@ -1,136 +0,0 @@ -<h1>SDLVehicleDataStatus 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-+NO_DATA_EXISTS">+NO_DATA_EXISTS</a></li> - <li><a href="#section-+OFF">+OFF</a></li> - <li><a href="#section-+ON">+ON</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the status of a binary vehicle data item.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLVehicleDataStatus -- parameter: value The value of the string to get an object for -- returns: SDLVehicleDataStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataStatus</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">SDLVehicleDataStatus</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>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> - - - - <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 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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NO_DATA_EXISTS</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">no_DATA_EXISTS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataStatus</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>SDLVehicleDataStatus: <em>NO_DATA_EXISTS</em></p> - - </div> - - <h3 id="section-+OFF"> - +OFF - </h3> - - <p>@abstract return SDLVehicleDataStatus: <em>OFF</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">OFF</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">off</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+ON"> - +ON - </h3> - - <p>@abstract return SDLVehicleDataStatus: <em>ON</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ON</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">on</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataStatus</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLVehicleDataType.html b/docs/Classes/SDLVehicleDataType.html deleted file mode 100644 index bfb8f4e0c..000000000 --- a/docs/Classes/SDLVehicleDataType.html +++ /dev/null @@ -1,562 +0,0 @@ -<h1>SDLVehicleDataType 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-+VEHICLEDATA_GPS">+VEHICLEDATA_GPS</a></li> - <li><a href="#section-+VEHICLEDATA_SPEED">+VEHICLEDATA_SPEED</a></li> - <li><a href="#section-+VEHICLEDATA_RPM">+VEHICLEDATA_RPM</a></li> - <li><a href="#section-+VEHICLEDATA_FUELLEVEL">+VEHICLEDATA_FUELLEVEL</a></li> - <li><a href="#section-+VEHICLEDATA_FUELLEVEL_STATE">+VEHICLEDATA_FUELLEVEL_STATE</a></li> - <li><a href="#section-+VEHICLEDATA_FUELCONSUMPTION">+VEHICLEDATA_FUELCONSUMPTION</a></li> - <li><a href="#section-+VEHICLEDATA_EXTERNTEMP">+VEHICLEDATA_EXTERNTEMP</a></li> - <li><a href="#section-+VEHICLEDATA_VIN">+VEHICLEDATA_VIN</a></li> - <li><a href="#section-+VEHICLEDATA_PRNDL">+VEHICLEDATA_PRNDL</a></li> - <li><a href="#section-+VEHICLEDATA_TIREPRESSURE">+VEHICLEDATA_TIREPRESSURE</a></li> - <li><a href="#section-+VEHICLEDATA_ODOMETER">+VEHICLEDATA_ODOMETER</a></li> - <li><a href="#section-+VEHICLEDATA_BELTSTATUS">+VEHICLEDATA_BELTSTATUS</a></li> - <li><a href="#section-+VEHICLEDATA_BODYINFO">+VEHICLEDATA_BODYINFO</a></li> - <li><a href="#section-+VEHICLEDATA_DEVICESTATUS">+VEHICLEDATA_DEVICESTATUS</a></li> - <li><a href="#section-+VEHICLEDATA_ECALLINFO">+VEHICLEDATA_ECALLINFO</a></li> - <li><a href="#section-+VEHICLEDATA_AIRBAGSTATUS">+VEHICLEDATA_AIRBAGSTATUS</a></li> - <li><a href="#section-+VEHICLEDATA_EMERGENCYEVENT">+VEHICLEDATA_EMERGENCYEVENT</a></li> - <li><a href="#section-+VEHICLEDATA_CLUSTERMODESTATUS">+VEHICLEDATA_CLUSTERMODESTATUS</a></li> - <li><a href="#section-+VEHICLEDATA_MYKEY">+VEHICLEDATA_MYKEY</a></li> - <li><a href="#section-+VEHICLEDATA_BRAKING">+VEHICLEDATA_BRAKING</a></li> - <li><a href="#section-+VEHICLEDATA_WIPERSTATUS">+VEHICLEDATA_WIPERSTATUS</a></li> - <li><a href="#section-+VEHICLEDATA_HEADLAMPSTATUS">+VEHICLEDATA_HEADLAMPSTATUS</a></li> - <li><a href="#section-+VEHICLEDATA_BATTVOLTAGE">+VEHICLEDATA_BATTVOLTAGE</a></li> - <li><a href="#section-+VEHICLEDATA_ENGINETORQUE">+VEHICLEDATA_ENGINETORQUE</a></li> - <li><a href="#section-+VEHICLEDATA_ACCPEDAL">+VEHICLEDATA_ACCPEDAL</a></li> - <li><a href="#section-+VEHICLEDATA_STEERINGWHEEL">+VEHICLEDATA_STEERINGWHEEL</a></li> -</ul> - -<h3>Overview</h3> - -<p>Defines the vehicle data types that can be published and/or subscribed to using SDLSubscribeVehicleData</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLVehicleDataType</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</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">SDLVehicleDataType</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>SDLVehicleDataType</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLVehicleDataType</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 SDLVehicleDataType</p> - - </div> - - <h3 id="section-+VEHICLEDATA_GPS"> - +VEHICLEDATA_GPS - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_GPS</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_GPS</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">vehicledata_GPS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_SPEED"> - +VEHICLEDATA_SPEED - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_SPEED</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_SPEED</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">vehicledata_SPEED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_RPM"> - +VEHICLEDATA_RPM - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_RPM</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_RPM</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">vehicledata_RPM</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_FUELLEVEL"> - +VEHICLEDATA_FUELLEVEL - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_FUELLEVEL</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_FUELLEVEL</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">vehicledata_FUELLEVEL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_FUELLEVEL_STATE"> - +VEHICLEDATA_FUELLEVEL_STATE - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_FUELLEVEL_STATE</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_FUELLEVEL_STATE</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">vehicledata_FUELLEVEL_STATE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_FUELCONSUMPTION"> - +VEHICLEDATA_FUELCONSUMPTION - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_FUELCONSUMPTION</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_FUELCONSUMPTION</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">vehicledata_FUELCONSUMPTION</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_EXTERNTEMP"> - +VEHICLEDATA_EXTERNTEMP - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_EXTERNTEMP</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_EXTERNTEMP</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">vehicledata_EXTERNTEMP</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_VIN"> - +VEHICLEDATA_VIN - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_VIN</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_VIN</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">vehicledata_VIN</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_PRNDL"> - +VEHICLEDATA_PRNDL - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_PRNDL</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_PRNDL</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">vehicledata_PRNDL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_TIREPRESSURE"> - +VEHICLEDATA_TIREPRESSURE - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_TIREPRESSURE</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_TIREPRESSURE</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">vehicledata_TIREPRESSURE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_ODOMETER"> - +VEHICLEDATA_ODOMETER - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ODOMETER</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_ODOMETER</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">vehicledata_ODOMETER</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_BELTSTATUS"> - +VEHICLEDATA_BELTSTATUS - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BELTSTATUS</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_BELTSTATUS</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">vehicledata_BELTSTATUS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_BODYINFO"> - +VEHICLEDATA_BODYINFO - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BODYINFO</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_BODYINFO</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">vehicledata_BODYINFO</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_DEVICESTATUS"> - +VEHICLEDATA_DEVICESTATUS - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_DEVICESTATUS</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_DEVICESTATUS</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">vehicledata_DEVICESTATUS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_ECALLINFO"> - +VEHICLEDATA_ECALLINFO - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ECALLINFO</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_ECALLINFO</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">vehicledata_ECALLINFO</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_AIRBAGSTATUS"> - +VEHICLEDATA_AIRBAGSTATUS - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_AIRBAGSTATUS</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_AIRBAGSTATUS</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">vehicledata_AIRBAGSTATUS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_EMERGENCYEVENT"> - +VEHICLEDATA_EMERGENCYEVENT - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_EMERGENCYEVENT</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_EMERGENCYEVENT</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">vehicledata_EMERGENCYEVENT</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_CLUSTERMODESTATUS"> - +VEHICLEDATA_CLUSTERMODESTATUS - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_CLUSTERMODESTATUS</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_CLUSTERMODESTATUS</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">vehicledata_CLUSTERMODESTATUS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_MYKEY"> - +VEHICLEDATA_MYKEY - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_MYKEY</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_MYKEY</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">vehicledata_MYKEY</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_BRAKING"> - +VEHICLEDATA_BRAKING - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BRAKING</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_BRAKING</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">vehicledata_BRAKING</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_WIPERSTATUS"> - +VEHICLEDATA_WIPERSTATUS - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_WIPERSTATUS</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_WIPERSTATUS</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">vehicledata_WIPERSTATUS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_HEADLAMPSTATUS"> - +VEHICLEDATA_HEADLAMPSTATUS - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_HEADLAMPSTATUS</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_HEADLAMPSTATUS</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">vehicledata_HEADLAMPSTATUS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_BATTVOLTAGE"> - +VEHICLEDATA_BATTVOLTAGE - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_BATTVOLTAGE</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_BATTVOLTAGE</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">vehicledata_BATTVOLTAGE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_ENGINETORQUE"> - +VEHICLEDATA_ENGINETORQUE - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ENGINETORQUE</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_ENGINETORQUE</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">vehicledata_ENGINETORQUE</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_ACCPEDAL"> - +VEHICLEDATA_ACCPEDAL - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_ACCPEDAL</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_ACCPEDAL</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">vehicledata_ACCPEDAL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+VEHICLEDATA_STEERINGWHEEL"> - +VEHICLEDATA_STEERINGWHEEL - </h3> - - <p>@abstract SDLVehicleDataType: <em>VEHICLEDATA_STEERINGWHEEL</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLVehicleDataType</span> <span class="o">*</span><span class="p">)</span><span class="n">VEHICLEDATA_STEERINGWHEEL</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">vehicledata_STEERINGWHEEL</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLVehicleDataType</span><span class="o">!</span></code></pre> - - - - -</section> diff --git a/docs/Classes/SDLVehicleType.html b/docs/Classes/SDLVehicleType.html index f127c05d2..115c028f9 100644 --- a/docs/Classes/SDLVehicleType.html +++ b/docs/Classes/SDLVehicleType.html @@ -3,8 +3,6 @@ <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-make">make</a></li> <li><a href="#section-model">model</a></li> <li><a href="#section-modelYear">modelYear</a></li> @@ -19,49 +17,6 @@ <section class="section task-group-section"> - <h3 id="section--init"> - -init - </h3> - - <p>@abstract Constructs a newly allocated SDLVehicleType 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 SDLVehicleType object indicated by the dictionary parameter -- parameter: dict The dictionary to use</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-make"> make </h3> @@ -75,11 +30,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">make</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">make</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">make</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">make</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> @@ -97,11 +52,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">model</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">model</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">model</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">model</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> @@ -119,11 +74,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">modelYear</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">modelYear</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">modelYear</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">modelYear</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> @@ -141,11 +96,11 @@ <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">atomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">trim</span><span class="p">;</span></code></pre> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">trim</span><span class="p">;</span></code></pre> <h4>Swift</h4> - <pre class="highlight"><code><span class="k">var</span> <span class="nv">trim</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="k">set</span> <span class="p">}</span></code></pre> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">trim</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> diff --git a/docs/Classes/SDLVideoStreamingCapability.html b/docs/Classes/SDLVideoStreamingCapability.html new file mode 100644 index 000000000..76086651c --- /dev/null +++ b/docs/Classes/SDLVideoStreamingCapability.html @@ -0,0 +1,109 @@ +<h1>SDLVideoStreamingCapability Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:">-initWithPreferredResolution: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--initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:"> + -initWithPreferredResolution: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">nullable</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="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-maxBitrate"> + maxBitrate + </h3> + + <p>@abstract The maximum bitrate of video stream that is supported, in kbps, optional</p> + +<p>minvalue= 0</p> + +<p>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">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">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="p">(</span><span class="kt">NSNumber</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">nullable</span><span class="p">)</span> + <span class="n">NSArray</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="p">[</span><span class="kt"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-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">nullable</span><span class="p">)</span> + <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">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="p">(</span><span class="kt">NSNumber</span> </code></pre> + + + + +</section> diff --git a/docs/Classes/SDLVideoStreamingFormat.html b/docs/Classes/SDLVideoStreamingFormat.html new file mode 100644 index 000000000..8d63e2872 --- /dev/null +++ b/docs/Classes/SDLVideoStreamingFormat.html @@ -0,0 +1,65 @@ +<h1>SDLVideoStreamingFormat Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section-protocol">protocol</a></li> + <li><a href="#section-codec">codec</a></li> + <li><a href="#section--initWithCodec:protocol:">-initWithCodec:protocol:</a></li> +</ul> + +<h3>Overview</h3> + +<p>Undocumented</p> + + +<section class="section task-group-section"> + <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="../Type Definitions.html#/c:SDLVideoStreamingProtocol.h@T@SDLVideoStreamingProtocol">SDLVideoStreamingProtocol</a></span> <span class="n">_Nonnull</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="../Type Definitions.html#/c:SDLVideoStreamingProtocol.h@T@SDLVideoStreamingProtocol">SDLVideoStreamingProtocol</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section-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="../Type Definitions.html#/c:SDLVideoStreamingCodec.h@T@SDLVideoStreamingCodec">SDLVideoStreamingCodec</a></span> <span class="n">_Nonnull</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="../Type Definitions.html#/c:SDLVideoStreamingCodec.h@T@SDLVideoStreamingCodec">SDLVideoStreamingCodec</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + + <h3 id="section--initWithCodec:protocol:"> + -initWithCodec:protocol: + </h3> + + <p>Undocumented</p> + + + + + + +</section> diff --git a/docs/Classes/SDLWarningLightStatus.html b/docs/Classes/SDLWarningLightStatus.html deleted file mode 100644 index 07b5b657e..000000000 --- a/docs/Classes/SDLWarningLightStatus.html +++ /dev/null @@ -1,173 +0,0 @@ -<h1>SDLWarningLightStatus 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-+OFF">+OFF</a></li> - <li><a href="#section-+ON">+ON</a></li> - <li><a href="#section-+FLASH">+FLASH</a></li> - <li><a href="#section-+NOT_USED">+NOT_USED</a></li> -</ul> - -<h3>Overview</h3> - -<p>Reflects the status of a cluster instrument warning light.</p> - -<p>@since SDL 2.0</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLWarningLightStatus -- parameter: value The value of the string to get an object for -- returns: SDLWarningLightStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWarningLightStatus</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">SDLWarningLightStatus</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>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> - - - - <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 SDLWarningLightStatus</p> - - </div> - - <h3 id="section-+OFF"> - +OFF - </h3> - - <p>@abstract Warninglight Off -- returns: SDLWarningLightStatus instance with value of <em>OFF</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWarningLightStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">OFF</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">off</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWarningLightStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWarningLightStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">ON</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">on</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWarningLightStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWarningLightStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">FLASH</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">flash</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWarningLightStatus</span><span class="o">!</span></code></pre> - - - - <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> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWarningLightStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NOT_USED</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">not_USED</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWarningLightStatus</span><span class="o">!</span></code></pre> - - - - <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 deleted file mode 100644 index 8643ef569..000000000 --- a/docs/Classes/SDLWaypointType.html +++ /dev/null @@ -1,114 +0,0 @@ -<h1>SDLWaypointType 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-+ALL">+ALL</a></li> - <li><a href="#section-+DESTINATION">+DESTINATION</a></li> -</ul> - -<h3>Overview</h3> - -<p>Undocumented</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>@abstract Convert String to SDLWayPointType</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWaypointType</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">SDLWaypointType</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>SDLWayPointType</p> - - </div> - - <h3 id="section-+values"> - +values - </h3> - - <p>@abstract Store the enumeration of all possible SDLWayPointType</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 SDLWayPointType</p> - - </div> - - <h3 id="section-+ALL"> - +ALL - </h3> - - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWaypointType</span> <span class="o">*</span><span class="p">)</span><span class="n">ALL</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">all</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWaypointType</span><span class="o">!</span></code></pre> - - - - <div> - <h4>Return Value</h4> - <p>a SDLWayPointType with value of <em>PROMPT</em></p> - - </div> - - <h3 id="section-+DESTINATION"> - +DESTINATION - </h3> - - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWaypointType</span> <span class="o">*</span><span class="p">)</span><span class="n">DESTINATION</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">destination</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWaypointType</span><span class="o">!</span></code></pre> - - - - <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 deleted file mode 100644 index fdb57aa74..000000000 --- a/docs/Classes/SDLWiperStatus.html +++ /dev/null @@ -1,356 +0,0 @@ -<h1>SDLWiperStatus 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-+OFF">+OFF</a></li> - <li><a href="#section-+AUTO_OFF">+AUTO_OFF</a></li> - <li><a href="#section-+OFF_MOVING">+OFF_MOVING</a></li> - <li><a href="#section-+MAN_INT_OFF">+MAN_INT_OFF</a></li> - <li><a href="#section-+MAN_INT_ON">+MAN_INT_ON</a></li> - <li><a href="#section-+MAN_LOW">+MAN_LOW</a></li> - <li><a href="#section-+MAN_HIGH">+MAN_HIGH</a></li> - <li><a href="#section-+MAN_FLICK">+MAN_FLICK</a></li> - <li><a href="#section-+WASH">+WASH</a></li> - <li><a href="#section-+AUTO_LOW">+AUTO_LOW</a></li> - <li><a href="#section-+AUTO_HIGH">+AUTO_HIGH</a></li> - <li><a href="#section-+COURTESYWIPE">+COURTESYWIPE</a></li> - <li><a href="#section-+AUTO_ADJUST">+AUTO_ADJUST</a></li> - <li><a href="#section-+STALLED">+STALLED</a></li> - <li><a href="#section-+NO_DATA_EXISTS">+NO_DATA_EXISTS</a></li> -</ul> - -<h3>Overview</h3> - -<p>Wiper Status</p> - - -<section class="section task-group-section"> - <h3 id="section-+valueOf:"> - +valueOf: - </h3> - - <p>Convert String to SDLWiperStatus -- parameter: value The value of the string to get an object for -- returns: SDLWiperStatus</p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</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">SDLWiperStatus</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>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> - - - - <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 SDLWiperStatus</p> - - </div> - - <h3 id="section-+OFF"> - +OFF - </h3> - - <p>@abstract SDLWiperStatus: <em>OFF</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">OFF</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">off</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+AUTO_OFF"> - +AUTO_OFF - </h3> - - <p>@abstract SDLWiperStatus: <em>AUTO_OFF</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">AUTO_OFF</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">auto_OFF</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+OFF_MOVING"> - +OFF_MOVING - </h3> - - <p>@abstract SDLWiperStatus: <em>OFF_MOVING</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">OFF_MOVING</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">off_MOVING</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+MAN_INT_OFF"> - +MAN_INT_OFF - </h3> - - <p>@abstract SDLWiperStatus: <em>MAN_INT_OFF</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">MAN_INT_OFF</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">man_INT_OFF</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+MAN_INT_ON"> - +MAN_INT_ON - </h3> - - <p>@abstract SDLWiperStatus: <em>MAN_INT_ON</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">MAN_INT_ON</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">man_INT_ON</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+MAN_LOW"> - +MAN_LOW - </h3> - - <p>@abstract SDLWiperStatus: <em>MAN_LOW</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">MAN_LOW</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">man_LOW</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+MAN_HIGH"> - +MAN_HIGH - </h3> - - <p>@abstract SDLWiperStatus: <em>MAN_HIGH</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">MAN_HIGH</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">man_HIGH</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+MAN_FLICK"> - +MAN_FLICK - </h3> - - <p>@abstract SDLWiperStatus: <em>MAN_FLICK</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">MAN_FLICK</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">man_FLICK</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+WASH"> - +WASH - </h3> - - <p>@abstract SDLWiperStatus: <em>WASH</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">WASH</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">wash</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+AUTO_LOW"> - +AUTO_LOW - </h3> - - <p>@abstract SDLWiperStatus: <em>AUTO_LOW</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">AUTO_LOW</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">auto_LOW</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+AUTO_HIGH"> - +AUTO_HIGH - </h3> - - <p>@abstract SDLWiperStatus: <em>AUTO_HIGH</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">AUTO_HIGH</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">auto_HIGH</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+COURTESYWIPE"> - +COURTESYWIPE - </h3> - - <p>@abstract SDLWiperStatus: <em>COURTESYWIPE</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">COURTESYWIPE</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">courtesywipe</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+AUTO_ADJUST"> - +AUTO_ADJUST - </h3> - - <p>@abstract SDLWiperStatus: <em>AUTO_ADJUST</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">AUTO_ADJUST</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">auto_ADJUST</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+STALLED"> - +STALLED - </h3> - - <p>@abstract SDLWiperStatus: <em>STALLED</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">STALLED</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">stalled</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - - <h3 id="section-+NO_DATA_EXISTS"> - +NO_DATA_EXISTS - </h3> - - <p>@abstract SDLWiperStatus: <em>NO_DATA_EXISTS</em></p> - - - - <h4>Objective-C</h4> - <pre class="highlight"><code><span class="k">+</span> <span class="p">(</span><span class="n">SDLWiperStatus</span> <span class="o">*</span><span class="p">)</span><span class="n">NO_DATA_EXISTS</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">no_DATA_EXISTS</span><span class="p">()</span> <span class="o">-></span> <span class="kt">SDLWiperStatus</span><span class="o">!</span></code></pre> - - - - -</section> |