diff options
Diffstat (limited to 'docs/Classes.html')
| -rw-r--r-- | docs/Classes.html | 2835 |
1 files changed, 2835 insertions, 0 deletions
diff --git a/docs/Classes.html b/docs/Classes.html index 3de966192..a6f3895d0 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -238,6 +238,35 @@ <a href="Classes/SDLAbstractProtocol.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAbstractProtocol</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n"><a href="Protocols/SDLTransportDelegate.html">SDLTransportDelegate</a></span><span class="o">></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="n">transport</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSHashTable</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="o">>></span> <span class="o">*</span><span class="n">protocolDelegateTable</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLSecurityType.html">SDLSecurityType</a></span><span class="o">></span> <span class="n">securityManager</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">copy</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appId</span><span class="p">;</span> + +<span class="c1">// Sending +</span><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startSecureServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">BOOL</span> <span class="n">success</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">error</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">endServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span> <span class="nf">encrypted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">encryption</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">withServiceType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendEncryptedRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">onService</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> + +<span class="c1">// Recieving +</span><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleBytesFromTransport</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLAbstractProtocol</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/SDLTransportDelegate.html">SDLTransportDelegate</a></span></code></pre> + @@ -250,6 +279,23 @@ <a href="Classes/SDLAbstractTransport.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAbstractTransport</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLTransportDelegate.html">SDLTransportDelegate</a></span><span class="o">></span> <span class="n">delegate</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">connect</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">disconnect</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">dataToSend</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">double</span><span class="p">)</span><span class="n">retryDelay</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLAbstractTransport</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -373,6 +419,24 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLAirbagStatus.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAirbagStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverAirbagDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverSideAirbagDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverCurtainAirbagDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerAirbagDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerCurtainAirbagDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverKneeAirbagDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerSideAirbagDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerKneeAirbagDeployed</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLAirbagStatus</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -490,6 +554,21 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLAppInfo.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLAppInfo</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">currentAppInfo</span><span class="p">;</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appDisplayName</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appBundleID</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">appVersion</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLAppInfo</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -502,6 +581,61 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLArtwork.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLArtwork</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLFile.html">SDLFile</a></span> + +<span class="cm">/** + * Convenience Helper to create an ephemeral artwork from an image. + * + * This is an ephemeral file, it will not be persisted through sessions / ignition cycles. Any files that you do not *know* you will use in future sessions should be created through this method. For example, album / artist artwork should be ephemeral. + * + * Persistent files should be created using `persistentArtworkWithImage:name:asImageFormat:` + * + * @warning 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. *Only pass a UIImage if the image is not stored on disk*. + * + * @param image The UIImage to be sent to the remote head unit + * @param name 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. + * @param imageFormat 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. + * + * @return An instance of this class to be passed to the file manager. + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">artworkWithImage</span><span class="p">:(</span><span class="n">UIImage</span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span> <span class="nf">name</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">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="n">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use the standard initializer and set persistant to false"</span><span class="p">);</span> + +<span class="cm">/** + * Convenience Helper to create a persistent artwork from an image. + * + * 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. + * + * Ephemeral files should be created using `ephemeralArtworkWithImage:name:asImageFormat:` + * + * @warning 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. *Only pass a UIImage if the image is not stored on disk*. + * + * @param image The UIImage to be sent to the remote head unit + * @param name 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. + * @param imageFormat 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. + * + * @return An instance of this class to be passed to the file manager. + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">persistentArtworkWithImage</span><span class="p">:(</span><span class="n">UIImage</span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span> <span class="nf">name</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">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="n">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use the standard initializer and set persistant to true"</span><span class="p">);</span> + +<span class="cm">/** + * Create a file for transmission to the remote system from a UIImage. + * + * @param image The UIImage to be sent to the remote head unit + * @param name 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. + * @param persistent Whether or not the artwork should be persistent. + * @param imageFormat 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. + * + * @return An instance of this class to be passed to the file manager. + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithImage</span><span class="p">:(</span><span class="n">UIImage</span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span> <span class="nf">name</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">persistent</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">persistent</span> <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> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLArtwork</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLFile.html">SDLFile</a></span></code></pre> + @@ -566,6 +700,31 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLBeltStatus.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLBeltStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBeltDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerBeltDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerBuckleBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">driverBuckleBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRow2BuckleBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">passengerChildDetected</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRow2BuckleBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow2BuckleBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow3BuckleBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRow3BuckleBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRow3BuckleBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">leftRearInflatableBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rightRearInflatableBelted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow1BeltDeployed</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">middleRow1BuckleBelted</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLBeltStatus</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -636,6 +795,15 @@ Since <b>SmartDeviceLink 1.0</b></p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLButtonPressResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLButtonPressResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> + @@ -770,6 +938,89 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLClimateControlData.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLClimateControlData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFanSpeed</span><span class="p">:(</span><span class="n">nullable</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="p">)</span><span class="nv">fanSpeed</span> <span class="nf">desiredTemperature</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLTemperature.html">SDLTemperature</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">desiredTemperature</span> <span class="nf">acEnable</span><span class="p">:(</span><span class="n">nullable</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="p">)</span><span class="nv">acEnable</span> <span class="nf">circulateAirEnable</span><span class="p">:(</span><span class="n">nullable</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="p">)</span><span class="nv">circulateAirEnable</span> <span class="nf">autoModeEnable</span><span class="p">:(</span><span class="n">nullable</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="p">)</span><span class="nv">autoModeEnable</span> <span class="nf">defrostZone</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone">SDLDefrostZone</a></span><span class="p">)</span><span class="nv">defrostZone</span> <span class="nf">dualModeEnable</span><span class="p">:(</span><span class="n">nullable</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="p">)</span><span class="nv">dualModeEnable</span> <span class="nf">acMaxEnable</span><span class="p">:(</span><span class="n">nullable</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="p">)</span><span class="nv">acMaxEnable</span> <span class="nf">ventilationMode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode">SDLVentilationMode</a></span><span class="p">)</span><span class="nv">ventilationMode</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Speed of Fan in integer + * + * Optional, MinValue- 0 MaxValue= 100 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">fanSpeed</span><span class="p">;</span> + +<span class="cm">/** + * @abstract The Current Temperature in SDLTemperature + * + * @warning This property is readonly and cannot be set on the module. + * + * Optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLTemperature.html">SDLTemperature</a></span> <span class="o">*</span><span class="n">currentTemperature</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Desired Temperature in SDLTemperature + * + * Optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLTemperature.html">SDLTemperature</a></span> <span class="o">*</span><span class="n">desiredTemperature</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Represents if AC is enabled. + * + * Optional, Boolean + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">acEnable</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Represents if circulation of air is enabled. + * + * Optional, Boolean + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">circulateAirEnable</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Represents if auto mode is enabled. + * + * Optional, Boolean + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">autoModeEnable</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Represents the kind of defrost zone + * + * Optional, SDLDefrostZone + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLDefrostZone.h@T@SDLDefrostZone">SDLDefrostZone</a></span> <span class="n">defrostZone</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Represents if dual mode is enabled. + * + * Optional, Boolean + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">dualModeEnable</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Represents if ac max is enabled. + * + * Optional, Boolean + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">acMaxEnable</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Represents the kind of Ventilation zone + * + * Optional, SDLVentilationMode + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVentilationMode.h@T@SDLVentilationMode">SDLVentilationMode</a></span> <span class="n">ventilationMode</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLClimateControlData</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -782,6 +1033,20 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLClusterModeStatus.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLClusterModeStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">powerModeActive</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeQualificationStatus.h@T@SDLPowerModeQualificationStatus">SDLPowerModeQualificationStatus</a></span> <span class="n">powerModeQualificationStatus</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLCarModeStatus.h@T@SDLCarModeStatus">SDLCarModeStatus</a></span> <span class="n">carModeStatus</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLPowerModeStatus.h@T@SDLPowerModeStatus">SDLPowerModeStatus</a></span> <span class="n">powerModeStatus</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLClusterModeStatus</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -794,6 +1059,77 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLConfiguration.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLConfiguration</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> + +<span class="cm">/** + * The lifecycle configuration. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLLifecycleConfiguration.html">SDLLifecycleConfiguration</a></span> <span class="o">*</span><span class="n">lifecycleConfig</span><span class="p">;</span> + +<span class="cm">/** + * The lock screen configuration. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLLockScreenConfiguration.html">SDLLockScreenConfiguration</a></span> <span class="o">*</span><span class="n">lockScreenConfig</span><span class="p">;</span> + +<span class="cm">/** + The log configuration. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLLogConfiguration.html">SDLLogConfiguration</a></span> <span class="o">*</span><span class="n">loggingConfig</span><span class="p">;</span> + +<span class="cm">/** + The configuration + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLStreamingMediaConfiguration.html">SDLStreamingMediaConfiguration</a></span> <span class="o">*</span><span class="n">streamingMediaConfig</span><span class="p">;</span> + +<span class="cm">/** + Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration. + + @param lifecycleConfig The lifecycle configuration to be used. + @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil. + @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil. + @return The configuration + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLifecycle</span><span class="p">:(</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="p">;</span> + +<span class="cm">/** + Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, and logging configuration. + + @param lifecycleConfig The lifecycle configuration to be used. + @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil. + @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil. + @return The configuration + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">configurationWithLifecycle</span><span class="p">:(</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="n">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use an initializer instead"</span><span class="p">);</span> + +<span class="cm">/** + Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration. + + @param lifecycleConfig The lifecycle configuration to be used. + @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil. + @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil. + @param streamingMediaConfig The streaming media configuration to be used, or nil because it is not needed. + @return The configuration + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLifecycle</span><span class="p">:(</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="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> + +<span class="cm">/** + Create a new configuration to be passed into SDLManager with a custom lifecycle, lock screen, logging, and streaming media configuration. + + @param lifecycleConfig The lifecycle configuration to be used. + @param lockScreenConfig The lockscreen configuration to be used, or `enabledConfiguration` if nil. + @param logConfig The logging configuration to be used, or `defaultConfiguration` if nil. + @param streamingMediaConfig The streaming media configuration to be used, or nil because it is not needed. + @return The configuration + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">configurationWithLifecycle</span><span class="p">:(</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="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="n">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use an initializer instead"</span><span class="p">);</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCopying</span></code></pre> + @@ -859,6 +1195,19 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLDIDResult.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDIDResult</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">resultCode</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">didLocation</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLDIDResult</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -871,6 +1220,86 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLDateTime.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDateTime</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHour</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">hour</span> <span class="nf">minute</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minute</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHour</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">hour</span> <span class="nf">minute</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minute</span> <span class="nf">second</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">second</span> <span class="nf">millisecond</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">millisecond</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHour</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">hour</span> <span class="nf">minute</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minute</span> <span class="nf">second</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">second</span> <span class="nf">millisecond</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">millisecond</span> <span class="nf">day</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">day</span> <span class="nf">month</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">month</span> <span class="nf">year</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">year</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHour</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">hour</span> <span class="nf">minute</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">minute</span> <span class="nf">second</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">second</span> <span class="nf">millisecond</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">millisecond</span> <span class="nf">day</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">day</span> <span class="nf">month</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">month</span> <span class="nf">year</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">year</span> <span class="nf">timezoneMinuteOffset</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">timezoneMinuteOffset</span> <span class="nf">timezoneHourOffset</span><span class="p">:(</span><span class="kt">int</span><span class="p">)</span><span class="nv">timezoneHourOffset</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Milliseconds part of time + * + * Optional, Integer 0 - 999 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * @abstract Seconds part of time + * + * Optional, Integer 0 - 59 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * @abstract Minutes part of time + * + * Optional, Integer 0 - 59 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * @abstract Hour part of time + * + * Optional, Integer 0 - 23 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * @abstract Day of the month + * + * Optional, Integer 1 - 31 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * @abstract Month of the year + * + * Optional, Integer 1 - 12 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * @abstract The year in YYYY format + * + * Optional, Max Value 4095 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * @abstract Time zone offset in Min with regard to UTC + * + * Optional, Integer 0 - 59 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * @abstract Time zone offset in Hours with regard to UTC + * + * Optional, Integer -12 - 14 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLDateTime</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1074,6 +1503,24 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLDeviceInfo.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLDeviceInfo</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">currentDevice</span><span class="p">;</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hardware</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">firmwareRev</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">os</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">osVersion</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">carrier</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maxNumberRFCOMMPorts</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLDeviceInfo</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1299,6 +1746,19 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLECallInfo.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLECallInfo</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">eCallNotificationStatus</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataNotificationStatus.h@T@SDLVehicleDataNotificationStatus">SDLVehicleDataNotificationStatus</a></span> <span class="n">auxECallNotificationStatus</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLECallConfirmationStatus.h@T@SDLECallConfirmationStatus">SDLECallConfirmationStatus</a></span> <span class="n">eCallConfirmationStatus</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLECallInfo</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1311,6 +1771,21 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLEmergencyEvent.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEmergencyEvent</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLEmergencyEventType.h@T@SDLEmergencyEventType">SDLEmergencyEventType</a></span> <span class="n">emergencyEventType</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLFuelCutoffStatus.h@T@SDLFuelCutoffStatus">SDLFuelCutoffStatus</a></span> <span class="n">fuelCutoffStatus</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">rolloverEvent</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maximumChangeVelocity</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataEventStatus.h@T@SDLVehicleDataEventStatus">SDLVehicleDataEventStatus</a></span> <span class="n">multipleEvents</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLEmergencyEvent</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1323,6 +1798,17 @@ Since <b>SmartDeviceLink 1.0</b></p> <a href="Classes/SDLEncodedSyncPData.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEncodedSyncPData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLEncodedSyncPData</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + @@ -1334,6 +1820,15 @@ Since <b>SmartDeviceLink 1.0</b></p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLEncodedSyncPDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLEncodedSyncPDataResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> + @@ -1393,6 +1888,138 @@ see SDLPerformAudioPassThru</p> <a href="Classes/SDLFile.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLFile</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> + +<span class="cm">/** + * Whether or not the file should persist on disk between car ignition cycles. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isPersistent</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">persistent</span><span class="p">;</span> + +<span class="cm">/** + * Whether or not the file should overwrite an existing file on the remote disk with the same name. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">overwrite</span><span class="p">;</span> + +<span class="cm">/** + * The name the file should be stored under on the remote disk. This is how the file will be referenced in all later calls. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">name</span><span class="p">;</span> + +<span class="cm">/** + * The url the local file is stored at while waiting to push it to the remote system. If the data has not been passed to the file URL, this will be nil. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSURL</span> <span class="o">*</span><span class="n">fileURL</span><span class="p">;</span> + +<span class="cm">/** + * The binary data of the SDLFile. If initialized with data, this will be a relatively quick call, but if initialized with a file URL, this is a rather expensive call the first time. The data will be cached in RAM after the first call. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> + +<span class="cm">/** + * The size of the binary data of the SDLFile. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="kt">unsigned</span> <span class="kt">long</span> <span class="kt">long</span> <span class="n">fileSize</span><span class="p">;</span> + +<span class="cm">/** + * The system will attempt to determine the type of file that you have passed in. It will default to BINARY if it does not recognize the file type or the file type is not supported by SDL. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">fileType</span><span class="p">;</span> + +<span class="cm">/** + * 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. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSInputStream</span> <span class="o">*</span><span class="n">inputStream</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span> + +<span class="cm">/** + * The designated initializer for an SDL File. The only major property that is not set using this is "overwrite", which defaults to NO. + * + * @param url The file URL pointing to the local data that will be pushed to the remote system. + * @param name 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. + * @param persistent Whether or not the file will persist between ignition cycles. + * + * @return An SDLFile object. + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFileURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">url</span> <span class="nf">name</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">persistent</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">persistent</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> + +<span class="cm">/** + * Create an SDL file using a local file URL. + * + * 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. + * + * Ephemeral files should be created using ephemeralFileAtURL:name: + * + * @warning If this is not a readable file, this will return nil + * + * @param url The url to the file that should be uploaded. + * @param name 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. + * + * @return An instance of this class, or nil if a readable file at the path could not be found. + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">persistentFileAtFileURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">url</span> <span class="nf">name</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="n">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use the standard initializer and set persistant to true"</span><span class="p">);</span> + +<span class="cm">/** + * Create an SDL file using a local file URL. + * + * This is an ephemeral file, it will not be persisted through sessions / ignition cycles. Any files that you do not *know* you will use in future sessions should be created through this method. For example, album / artist artwork should be ephemeral. + * + * Persistent files should be created using persistentFileAtURL:name: + * + * @warning If this is not a readable file, this will return nil + * + * @param url The url to the file on disk that will be uploaded + * @param name 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. + * + * @return An instance of this class, or nil if a readable file at the url could not be found. + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">fileAtFileURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">url</span> <span class="nf">name</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span> + +<span class="cm">/** + * Create an SDL file using raw data. It is strongly preferred to pass a file URL instead of data, as it is currently held in memory until the file is sent. + * + * @param data The raw data to be used for the file + * @param name 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. + * @param extension The file extension. For example "png". Currently supported file extensions are: "bmp", "jpg", "jpeg", "png", "wav", "mp3", "aac", "json". All others will be sent as binary files. + * @param persistent Whether or not the remote file with this data should be persistent + * + * @return An instance of this class + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">name</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">fileExtension</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">extension</span> <span class="nf">persistent</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">persistent</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> + +<span class="cm">/** + * Create an SDL file using raw data. It is strongly preferred to pass a file URL instead of data, as it is currently held in memory until the file is sent. + * + * 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. + * + * @param data The raw data to be used for the file + * @param name 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. + * @param extension The file extension. For example "png". Currently supported file extensions are: "bmp", "jpg", "jpeg", "png", "wav", "mp3", "aac", "json". All others will be sent as binary files. + * + * @return An instance of this class + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">persistentFileWithData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">name</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">fileExtension</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">extension</span> <span class="n">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use the standard initializer and set persistant to true"</span><span class="p">);</span> + +<span class="cm">/** + * Create an SDL file using raw data. It is strongly preferred to pass a file URL instead of data, as it is currently held in memory until the file is sent. + * + * This is an ephemeral file, it will not be persisted through sessions / ignition cycles. Any files that you do not *know* you will use in future sessions should be created through this method. For example, album / artist artwork should be ephemeral. + * + * @param data The raw data to be used for the file + * @param name 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. + * @param extension The file extension. For example "png". Currently supported file extensions are: "bmp", "jpg", "jpeg", "png", "wav", "mp3", "aac", "json". All others will be sent as binary files. + * + * @return An instance of this class + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">fileWithData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">name</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">fileExtension</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">extension</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLFile</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCopying</span></code></pre> + @@ -1534,6 +2161,26 @@ whenever new data is available for the module.</p> <a href="Classes/SDLGetInteriorVehicleDataResponse.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetInteriorVehicleDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">moduleData</span><span class="p">;</span> + +<span class="cm">/** + * @abstract It is a conditional-mandatory parameter: must be returned in case "subscribe" parameter was present in the related request. + * if "true" - the "moduleType" from request is successfully subscribed and the head unit will send onInteriorVehicleData notifications for the moduleType. + * if "false" - the "moduleType" from request is either unsubscribed or failed to subscribe. + * + * Optional, Boolean + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">isSubscribed</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLGetInteriorVehicleDataResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> + @@ -1546,6 +2193,24 @@ whenever new data is available for the module.</p> <a href="Classes/SDLGetSystemCapability.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetSystemCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithType</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span><span class="p">)</span><span class="nv">type</span><span class="p">;</span> + +<span class="cm">/** + They type of capability you'd like to receive in the response. + + Mandatory + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span> <span class="n">systemCapabilityType</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLGetSystemCapability</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + @@ -1558,6 +2223,17 @@ whenever new data is available for the module.</p> <a href="Classes/SDLGetSystemCapabilityResponse.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetSystemCapabilityResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSystemCapability.html">SDLSystemCapability</a></span> <span class="o">*</span><span class="n">systemCapability</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLGetSystemCapabilityResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> + @@ -1618,6 +2294,25 @@ whenever new data is available for the module.</p> <a href="Classes/SDLGetWayPoints.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetWayPoints</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithType</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span><span class="p">)</span><span class="nv">type</span><span class="p">;</span> + +<span class="cm">/** + * To request for either the destination + * only or for all waypoints including destination + * + * Required + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLWayPointType.h@T@SDLWayPointType">SDLWayPointType</a></span> <span class="n">waypointType</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLGetWayPoints</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + @@ -1630,6 +2325,24 @@ whenever new data is available for the module.</p> <a href="Classes/SDLGetWayPointsResponse.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLGetWayPointsResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> + +<span class="cm">/** + * @abstract Array of waypoints + * + * @see SDLLocationDetails + * + * Optional, Array size 1 - 10 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">waypoints</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLGetWayPointsResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> + @@ -1642,6 +2355,36 @@ whenever new data is available for the module.</p> <a href="Classes/SDLHMICapabilities.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLHMICapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="cm">/** + Availability of built in Nav. True: Available, False: Not Available + + Boolean value. Optional. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">navigation</span><span class="p">;</span> + +<span class="cm">/** + Availability of built in phone. True: Available, False: Not Available + + Boolean value. Optional. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">phoneCall</span><span class="p">;</span> + +<span class="cm">/** + Availability of built in video streaming. True: Available, False: Not Available + + Boolean value. Optional. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">videoStreaming</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLHMICapabilities</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1713,6 +2456,18 @@ whenever new data is available for the module.</p> <a href="Classes/SDLIAPTransport.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLIAPTransport</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o"><</span><span class="n"><a href="Protocols/SDLIAPSessionDelegate.html">SDLIAPSessionDelegate</a></span><span class="o">></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">SDLIAPSession</span> <span class="o">*</span><span class="n">controlSession</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">SDLIAPSession</span> <span class="o">*</span><span class="n">session</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLIAPTransport</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/SDLIAPSessionDelegate.html">SDLIAPSessionDelegate</a></span></code></pre> + @@ -1746,6 +2501,19 @@ whenever new data is available for the module.</p> <a href="Classes/SDLImageField.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLImageField</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLImageFieldName.h@T@SDLImageFieldName">SDLImageFieldName</a></span> <span class="n">name</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="o">></span> <span class="o">*</span><span class="n">imageTypeSupported</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">imageResolution</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLImageField</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1758,6 +2526,20 @@ whenever new data is available for the module.</p> <a href="Classes/SDLImageResolution.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLImageResolution</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">resolutionWidth</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">resolutionHeight</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithWidth</span><span class="p">:(</span><span class="kt">uint16_t</span><span class="p">)</span><span class="nv">width</span> <span class="nf">height</span><span class="p">:(</span><span class="kt">uint16_t</span><span class="p">)</span><span class="nv">height</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLImageResolution</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1770,6 +2552,23 @@ whenever new data is available for the module.</p> <a href="Classes/SDLKeyboardProperties.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLKeyboardProperties</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLanguage</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span><span class="p">)</span><span class="nv">language</span> <span class="nf">layout</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeyboardLayout.h@T@SDLKeyboardLayout">SDLKeyboardLayout</a></span><span class="p">)</span><span class="nv">layout</span> <span class="nf">keypressMode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeypressMode.h@T@SDLKeypressMode">SDLKeypressMode</a></span><span class="p">)</span><span class="nv">keypressMode</span> <span class="nf">limitedCharacterList</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">limitedCharacterList</span> <span class="nf">autoCompleteText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">autoCompleteText</span><span class="p">;</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLLanguage.h@T@SDLLanguage">SDLLanguage</a></span> <span class="n">language</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeyboardLayout.h@T@SDLKeyboardLayout">SDLKeyboardLayout</a></span> <span class="n">keyboardLayout</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeypressMode.h@T@SDLKeypressMode">SDLKeypressMode</a></span> <span class="n">keypressMode</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">limitedCharacterList</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">autoCompleteText</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLKeyboardProperties</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1844,6 +2643,29 @@ whenever new data is available for the module.</p> <a href="Classes/SDLLocationCoordinate.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLocationCoordinate</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="cm">/** + * @abstract Latitude of the location + * + * Required, Double -90 - 90 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * @abstract Longitude of the location + * + * Required, Double -180 - 180 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">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> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLLocationCoordinate</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1856,6 +2678,71 @@ whenever new data is available for the module.</p> <a href="Classes/SDLLocationDetails.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLocationDetails</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="cm">/** + * @abstract Latitude/Longitude of the location + * + * @see SDLLocationCoordinate + * + * Optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLLocationCoordinate.html">SDLLocationCoordinate</a></span> <span class="o">*</span><span class="n">coordinate</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Name of location. + * + * Optional, Max length 500 chars + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Location address for display purposes only. + * + * Optional, Array of Strings, Array length 0 - 4, Max String length 500 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Description intended location / establishment. + * + * Optional, Max length 500 chars + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Phone number of location / establishment. + * + * Optional, Max length 500 chars + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Image / icon of intended location. + * + * @see SDLImage + * + * Optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">locationImage</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Address to be used by navigation engines for search. + * + * @see SDLOASISAddress + * + * Optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="n">searchAddress</span><span class="p">;</span> + + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLLocationDetails</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -1868,6 +2755,75 @@ whenever new data is available for the module.</p> <a href="Classes/SDLLockScreenConfiguration.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLockScreenConfiguration</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> + +<span class="cm">/** + * Whether or not the lock screen should be shown in the "lock screen optional" state. Defaults to 'NO'. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">showInOptionalState</span><span class="p">;</span> + +<span class="cm">/** + * If YES, the lock screen should be managed by SDL and automatically engage when necessary. If NO, then the lock screen will never be engaged. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">enableAutomaticLockScreen</span><span class="p">;</span> + +<span class="cm">/** + * The background color of the lock screen. This could be a branding color, or leave at the default for a dark blue-gray. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">UIColor</span> <span class="o">*</span><span class="n">backgroundColor</span><span class="p">;</span> + +<span class="cm">/** + * Your app icon as it will appear on the lock screen. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIImage</span> <span class="o">*</span><span class="n">appIcon</span><span class="p">;</span> + +<span class="cm">/** + * A custom view controller that the lock screen will manage the presentation of. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIViewController</span> <span class="o">*</span><span class="n">customViewController</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span> + +<span class="cm">/** + * Use this configuration if you wish to manage a lock screen yourself. This may be useful if the automatic presentation feature of SDLLockScreenManager is failing for some reason. + * + * @return The configuration + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">disabledConfiguration</span><span class="p">;</span> + +<span class="cm">/** + * Use this configuration for the basic default lock screen. A custom app icon will not be used. + * + * @return The configuration + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">enabledConfiguration</span><span class="p">;</span> + +<span class="cm">/** + * Use this configuration to provide a custom lock screen icon and a custom background color, or nil if you wish to use the default background color. This will use the default lock screen layout. + * + * @param lockScreenAppIcon The app icon to be shown on the lock screen + * @param lockScreenBackgroundColor The color of the lock screen background + * + * @return The configuration + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">enabledConfigurationWithAppIcon</span><span class="p">:(</span><span class="n">UIImage</span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenAppIcon</span> <span class="nf">backgroundColor</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">lockScreenBackgroundColor</span><span class="p">;</span> + +<span class="cm">/** + * Use this configuration if you wish to provide your own view controller for the lock screen. This view controller's presentation and dismissal will still be managed by the lock screen manager. Note that you may subclass SDLLockScreenViewController and pass it here to continue to have the vehicle icon set to your view controller by the manager. + * + * @param viewController The view controller to be managed + * + * @return The configuration + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">enabledConfigurationWithViewController</span><span class="p">:(</span><span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">viewController</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLLockScreenConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCopying</span></code></pre> + @@ -1880,6 +2836,30 @@ whenever new data is available for the module.</p> <a href="Classes/SDLLockScreenViewController.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLockScreenViewController</span> <span class="p">:</span> <span class="nc">UIViewController</span> + +<span class="cm">/** + * The app's icon. This will be set by the lock screen configuration. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIImage</span> <span class="o">*</span><span class="n">appIcon</span><span class="p">;</span> + +<span class="cm">/** + * The vehicle's designated icon. This will be set by the lock screen manager when it is notified that a lock screen icon has been downloaded. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIImage</span> <span class="o">*</span><span class="n">vehicleIcon</span><span class="p">;</span> + +<span class="cm">/** + * The designated background color set in the lock screen configuration, or the default SDL gray-blue. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIColor</span> <span class="o">*</span><span class="n">backgroundColor</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLLockScreenViewController</span> <span class="p">:</span> <span class="kt">UIViewController</span></code></pre> + @@ -1892,6 +2872,66 @@ whenever new data is available for the module.</p> <a href="Classes/SDLLogConfiguration.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogConfiguration</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> + +<span class="cm">/** + Any custom logging modules used by the developer's code. Defaults to none. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="Classes/SDLLogFileModule.html">SDLLogFileModule</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">modules</span><span class="p">;</span> + +<span class="cm">/** + Where the logs will attempt to output. Defaults to Console. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLLogTarget.html">SDLLogTarget</a></span><span class="o">>></span> <span class="o">*</span><span class="n">targets</span><span class="p">;</span> + +<span class="cm">/** + What log filters will run over this session. Defaults to none. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n"><a href="Classes/SDLLogFilter.html">SDLLogFilter</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">filters</span><span class="p">;</span> + +<span class="cm">/** + How detailed of logs will be output. Defaults to Default. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLLogFormatType.html">SDLLogFormatType</a></span> <span class="n">formatType</span><span class="p">;</span> + +<span class="cm">/** + 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. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isAsynchronous</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">asynchronous</span><span class="p">;</span> + +<span class="cm">/** + Whether or not error logs will be dispatched to loggers asynchronously. Defaults to NO. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">areErrorsAsynchronous</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">errorsAsynchronous</span><span class="p">;</span> + +<span class="cm">/** + 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. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="n">globalLogLevel</span><span class="p">;</span> + + +<span class="cm">/** + A default logger for production. This sets the format type to Default, the log level to Error, and only enables the ASL logger. + + @return A default configuration that may be customized. + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">defaultConfiguration</span><span class="p">;</span> + +<span class="cm">/** + 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. + + @return A debug configuration that may be customized. + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">debugConfiguration</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLLogConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCopying</span></code></pre> + @@ -1904,6 +2944,75 @@ whenever new data is available for the module.</p> <a href="Classes/SDLLogFileModule.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogFileModule</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="cm">/** + The name of the this module, e.g. "Transport" + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">name</span><span class="p">;</span> + +<span class="cm">/** + All of the files contained within this module. When a log is logged, the `__FILE__` (in Obj-C) or `#file` (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. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">files</span><span class="p">;</span> + +<span class="cm">/** + The custom level of the log. This is `SDLLogLevelDefault` (whatever the current global log level is) by default. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLLogLevel.html">SDLLogLevel</a></span> <span class="n">logLevel</span><span class="p">;</span> + + +<span class="cm">/** + This method is unavailable and may not be used. + + @return Always returns nil + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span> + +<span class="cm">/** + Returns an initialized `SDLLogFileModule` that contains a custom name, set of files, and associated log level. + + @param name The name of this module. This will be used when printing a formatted log for a file within this module e.g. "Transport". + @param files The files this module covers. This should correspond to a `__FILE__` or `#file` 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. + @param level The custom logging level logs originating in files contained in this log module will use. For example, if the global level is `SDLLogLevelError` and this module is configured to `SDLLogLevelVerbose`, all logs originating from files within this module will be logged, not merely error logs. + @return An initialized `SDLLogFileModule` + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">files</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="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="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> + +<span class="cm">/** + Returns an initialized `SDLLogFileModule` that contains a custom name and set of files. The logging level is the same as the current global logging file by using `SDLLogLevelDefault`. + + @param name The name of this module. This will be used when printing a formatted log for a file within this module e.g. "Transport". + @param files The files this module covers. This should correspond to a `__FILE__` or `#file` 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. + @return An initialized `SDLLogFileModule` + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">files</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="p">)</span><span class="nv">files</span><span class="p">;</span> + +<span class="cm">/** + Returns an initialized `SDLLogFileModule` that contains a custom name and set of files. The logging level is the same as the current global logging file by using `SDLLogLevelDefault`. + + @param name The name of this module. This will be used when printing a formatted log for a file within this module e.g. "Transport". + @param files The files this module covers. This should correspond to a `__FILE__` or `#file` 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. + @return An initialized `SDLLogFileModule` + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">moduleWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">files</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="p">)</span><span class="nv">files</span><span class="p">;</span> + + +<span class="cm">/** + Returns whether or not this module contains a given file. + + @param fileName The file name to check + @return A BOOL, YES if this module contains the given file. + */</span> +<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">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileName</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLLogFileModule</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -1916,6 +3025,93 @@ whenever new data is available for the module.</p> <a href="Classes/SDLLogFilter.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLLogFilter</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLLogConstants.h@T@SDLLogFilterBlock">SDLLogFilterBlock</a></span> <span class="n">filter</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span> + +<span class="cm">/** + Create a new filter with a custom filter block. The filter block will take a log model and return a BOOL of pass / fail. + + @param filter The custom filter to be used + @return An instance of SDLLogFilter + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithCustomFilter</span><span class="p">:(</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="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> + +<span class="cm">/** + Returns a filter that only allows logs not containing the passed string within their message. + + @param string The string, which, if present in the message of the log, will prevent the log from being logged. + @param caseSensitive Whether or not `string` should be checked as case sensitive against the log's message. + @return A filter that may be passed into the `logConfiguration`. + */</span> +<span class="k">+</span> <span class="p">(</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">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> + +<span class="cm">/** + Returns a filter that only allows logs containing the passed string within their message. + + @param string The string, which, if present in the message of the log, will allow the log to be logged. + @param caseSensitive Whether or not `string` should be checked as case sensitive against the log's message. + @return A filter that may be passed into the `logConfiguration`. + */</span> +<span class="k">+</span> <span class="p">(</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">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> + +<span class="cm">/** + Returns a filter that only allows logs not passing the passed regex against their message. + + @param regex The regex, which, if it matches the message of the log, will prevent the log from being logged. + @return A filter that may be passed into the `logConfiguration`. + */</span> +<span class="k">+</span> <span class="p">(</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="n">NSRegularExpression</span> <span class="o">*</span><span class="p">)</span><span class="nv">regex</span><span class="p">;</span> + +<span class="cm">/** + Returns a filter that only allows logs passing the passed regex against their message. + + @param regex The regex, which, if it matches the message of the log, will allow the log to be logged. + @return A filter that may be passed into the `logConfiguration`. + */</span> +<span class="k">+</span> <span class="p">(</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="n">NSRegularExpression</span> <span class="o">*</span><span class="p">)</span><span class="nv">regex</span><span class="p">;</span> + +<span class="cm">/** + Returns a filter that only allows logs not within the specified file modules to be logged. + + @param modules A set of module names. If any match, they will not be logged. + @return A filter that may be passed into the `logConfiguration`. + */</span> +<span class="k">+</span> <span class="p">(</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="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> + +<span class="cm">/** + Returns a filter that only allows logs of the specified file modules to be logged. + + @param modules A set of module names. If any match, they will not be logged. + @return A filter that may be passed into the `logConfiguration`. + */</span> +<span class="k">+</span> <span class="p">(</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="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> + +<span class="cm">/** + Returns a filter that only allows logs not within the specified files to be logged. + + @param fileNames If a log matches any of the passed files, the log will not be logged. + @return A filter that may be passed into the `logConfiguration`. + */</span> +<span class="k">+</span> <span class="p">(</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="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> + +<span class="cm">/** + Returns a filter that only allows logs within the specified files to be logged. + + @param fileNames If a log matches any of the passed files, the log will be logged. + @return A filter that may be passed into the `logConfiguration`. + */</span> +<span class="k">+</span> <span class="p">(</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="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> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLLogFilter</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -2003,6 +3199,114 @@ whenever new data is available for the module.</p> <a href="Classes/SDLManager.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLManager</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="cm">/** + * The configuration the manager was set up with. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLConfiguration.html">SDLConfiguration</a></span> <span class="o">*</span><span class="n">configuration</span><span class="p">;</span> + +<span class="cm">/** + * The current HMI level of the running app. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLHMILevel.h@T@SDLHMILevel">SDLHMILevel</a></span> <span class="n">hmiLevel</span><span class="p">;</span> + +<span class="cm">/** + * The current audio streaming state of the running app. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLAudioStreamingState.h@T@SDLAudioStreamingState">SDLAudioStreamingState</a></span> <span class="n">audioStreamingState</span><span class="p">;</span> + +<span class="cm">/** + * The current system context of the running app. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLSystemContext.h@T@SDLSystemContext">SDLSystemContext</a></span> <span class="n">systemContext</span><span class="p">;</span> + +<span class="cm">/** + * The file manager to be used by the running app. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLFileManager.html">SDLFileManager</a></span> <span class="o">*</span><span class="n">fileManager</span><span class="p">;</span> + +<span class="cm">/** + * The permission manager monitoring RPC permissions. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLPermissionManager.html">SDLPermissionManager</a></span> <span class="o">*</span><span class="n">permissionManager</span><span class="p">;</span> + +<span class="cm">/** + * The streaming media manager to be used for starting video sessions. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLStreamingMediaManager.html">SDLStreamingMediaManager</a></span> <span class="o">*</span><span class="n">streamManager</span><span class="p">;</span> + +<span class="cm">/** + * The response of a register call after it has been received. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLRegisterAppInterfaceResponse.html">SDLRegisterAppInterfaceResponse</a></span> <span class="o">*</span><span class="n">registerResponse</span><span class="p">;</span> + +<span class="cm">/** + * The manager's delegate. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLManagerDelegate.html">SDLManagerDelegate</a></span><span class="o">></span> <span class="n">delegate</span><span class="p">;</span> + +<span class="cm">/** + * Deprecated internal proxy object. This should only be accessed when the Manager is READY. This property may go to nil at any time. + * The only reason to use this is to access the `putFileStream:withRequest:` method. All other functionality exists on managers in 4.3. This will be removed in 5.0 and the functionality replicated on `SDLFileManager`. + */</span> +<span class="cp">#pragma clang diagnostic push +#pragma clang diagnostic ignored "-Wdeprecated-declarations" +</span><span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="n">proxy</span><span class="p">;</span> +<span class="cp">#pragma clang diagnostic pop +</span> + +<span class="cp">#pragma mark Lifecycle +</span> +<span class="cm">/** + * Initialize the manager with a configuration. Call `startWithHandler` to begin waiting for a connection. + * + * @param configuration Your app's unique configuration for setup. + * @param delegate An optional delegate to be notified of hmi level changes and startup and shutdown. It is recommended that you implement this. + * + * @return An instance of SDLManager + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithConfiguration</span><span class="p">:(</span><span class="n"><a href="Classes/SDLConfiguration.html">SDLConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">configuration</span> <span class="nf">delegate</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLManagerDelegate.html">SDLManagerDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> + +<span class="cm">/** + * Start the manager, which will tell it to start looking for a connection. Once one does, it will automatically run the setup process and call the readyBlock when done. + * + * @param readyHandler The block called when the manager is ready to be used or an error occurs while attempting to become ready. + */</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startWithReadyHandler</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLManager.h@T@SDLManagerReadyBlock">SDLManagerReadyBlock</a></span><span class="p">)</span><span class="nv">readyHandler</span> <span class="n">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">start</span><span class="p">(</span><span class="n">readyHandler</span><span class="o">:</span><span class="p">));</span> + +<span class="cm">/** + * Stop the manager, it will disconnect if needed and no longer look for a connection. You probably don't need to call this method ever. + * + * If you do call this method, you must wait for SDLManagerDelegate's managerDidDisconnect callback to call startWithReadyHandler:. + */</span> +<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> + + +<span class="cp">#pragma mark Manually Send RPC Requests +</span> +<span class="cm">/** + * Send an RPC request and don't bother with the response or error. If you need the response or error, call sendRequest:withCompletionHandler: instead. + * + * @param request The RPC request to send + */</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRequest</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">request</span><span class="p">;</span> + +<span class="cm">/** + * Send an RPC request and set a completion handler that will be called with the response when the response returns. + * + * @param request The RPC request to send + * @param handler The handler that will be called when the response returns + */</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRequest</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">request</span> <span class="nf">withResponseHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLResponseHandler">SDLResponseHandler</a></span><span class="p">)</span><span class="nv">handler</span> <span class="n">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">send</span><span class="p">(</span><span class="n">request</span><span class="o">:</span><span class="n">responseHandler</span><span class="o">:</span><span class="p">));</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLManager</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -2036,6 +3340,58 @@ whenever new data is available for the module.</p> <a href="Classes/SDLMetadataTags.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLMetadataTags</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="cm">/** + * @abstract Constructs a newly allocated SDLMetadataType object with NSArrays + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTextFieldTypes</span><span class="p">:(</span><span class="n">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> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTextFieldTypes</span><span class="p">:(</span><span class="n">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="nf">mainField3</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">mainField3</span> <span class="nf">mainField4</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">mainField4</span><span class="p">;</span> + +<span class="cm">/** + * @abstract The type of data contained in the "mainField1" text field, Optional. + * + * minsize= 0 + * + * maxsize= 5 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="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> + +<span class="cm">/** + * @abstract The type of data contained in the "mainField2" text field, Optional. + * + * minsize= 0 + * + * maxsize= 5 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="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> + +<span class="cm">/** + * @abstract The type of data contained in the "mainField3" text field, Optional. + * + * minsize= 0 + * + * maxsize= 5 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="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> + +<span class="cm">/** + * @abstract The type of data contained in the "mainField4" text field, Optional. + * + * minsize= 0 + * + * maxsize= 5 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="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> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLMetadataTags</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -2048,6 +3404,29 @@ whenever new data is available for the module.</p> <a href="Classes/SDLModuleData.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLModuleData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithRadioControlData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRadioControlData.html">SDLRadioControlData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">radioControlData</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithClimateControlData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLClimateControlData.html">SDLClimateControlData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">climateControlData</span><span class="p">;</span> + +<span class="cm">/** + * 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 "climateControlData" should exist + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="n">moduleType</span><span class="p">;</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLRadioControlData.html">SDLRadioControlData</a></span> <span class="o">*</span><span class="n">radioControlData</span><span class="p">;</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLClimateControlData.html">SDLClimateControlData</a></span> <span class="o">*</span><span class="n">climateControlData</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLModuleData</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -2060,6 +3439,17 @@ whenever new data is available for the module.</p> <a href="Classes/SDLMyKey.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLMyKey</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataStatus.h@T@SDLVehicleDataStatus">SDLVehicleDataStatus</a></span> <span class="n">e911Override</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLMyKey</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -2072,6 +3462,29 @@ whenever new data is available for the module.</p> <a href="Classes/SDLNavigationCapability.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLNavigationCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSendLocation</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">sendLocationEnabled</span> <span class="nf">waypoints</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">waypointsEnabled</span><span class="p">;</span> + +<span class="cm">/** + Whether or not the SendLocation RPC is enabled. + Boolean, optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">sendLocationEnabled</span><span class="p">;</span> + +<span class="cm">/** + Whether or not Waypoint related RPCs are enabled. + Boolean, optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">getWayPointsEnabled</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLNavigationCapability</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -2084,6 +3497,18 @@ whenever new data is available for the module.</p> <a href="Classes/SDLNotificationConstants.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLNotificationConstants</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allResponseNames</span><span class="p">;</span> +<span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">allButtonEventNotifications</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLNotificationConstants</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -2096,6 +3521,82 @@ whenever new data is available for the module.</p> <a href="Classes/SDLOasisAddress.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOasisAddress</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSubThoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subThoroughfare</span> <span class="nf">thoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">thoroughfare</span> <span class="nf">locality</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locality</span> <span class="nf">administrativeArea</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">administrativeArea</span> <span class="nf">postalCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">postalCode</span> <span class="nf">countryCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">countryCode</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSubThoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subThoroughfare</span> <span class="nf">thoroughfare</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">thoroughfare</span> <span class="nf">locality</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locality</span> <span class="nf">administrativeArea</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">administrativeArea</span> <span class="nf">postalCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">postalCode</span> <span class="nf">countryCode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">countryCode</span> <span class="nf">countryName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">countryName</span> <span class="nf">subAdministrativeArea</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subAdministrativeArea</span> <span class="nf">subLocality</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">subLocality</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Name of the country (localized) + * + * Optional, max length = 200 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract countryCode of the country(ISO 3166-2) + * + * Optional, max length = 200 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract postalCode of location (PLZ, ZIP, PIN, CAP etc.) + * + * Optional, max length = 200 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Portion of country (e.g. state) + * + * Optional, max length = 200 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Portion of administrativeArea (e.g. county) + * + * Optional, max length = 200 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Hypernym for city/village + * + * Optional, max length = 200 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Hypernym for district + * + * Optional, max length = 200 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Hypernym for street, road etc. + * + * Optional, max length = 200 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * @abstract Portion of thoroughfare (e.g. house number) + * + * Optional, max length = 200 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOasisAddress</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -2353,6 +3854,19 @@ whenever new data is available for the module.</p> <a href="Classes/SDLOnEncodedSyncPData.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnEncodedSyncPData</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">URL</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">Timeout</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOnEncodedSyncPData</span> <span class="p">:</span> <span class="kt"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> + @@ -2396,6 +3910,17 @@ whenever new data is available for the module.</p> <a href="Classes/SDLOnHashChange.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnHashChange</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hashID</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOnHashChange</span> <span class="p">:</span> <span class="kt"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> + @@ -2408,6 +3933,17 @@ whenever new data is available for the module.</p> <a href="Classes/SDLOnInteriorVehicleData.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnInteriorVehicleData</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLModuleData.html">SDLModuleData</a></span> <span class="o">*</span><span class="n">moduleData</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOnInteriorVehicleData</span> <span class="p">:</span> <span class="kt"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> + @@ -2420,6 +3956,18 @@ whenever new data is available for the module.</p> <a href="Classes/SDLOnKeyboardInput.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnKeyboardInput</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLKeyboardEvent.h@T@SDLKeyboardEvent">SDLKeyboardEvent</a></span> <span class="n">event</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOnKeyboardInput</span> <span class="p">:</span> <span class="kt"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> + @@ -2499,6 +4047,18 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLOnSyncPData.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnSyncPData</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">URL</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">Timeout</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOnSyncPData</span> <span class="p">:</span> <span class="kt"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> + @@ -2511,6 +4071,22 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLOnSystemRequest.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnSystemRequest</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">requestType</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">url</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">timeout</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">fileType</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">offset</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLUInt">SDLUInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">length</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOnSystemRequest</span> <span class="p">:</span> <span class="kt"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> + @@ -2523,6 +4099,17 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLOnTBTClientState.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnTBTClientState</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLTBTState.h@T@SDLTBTState">SDLTBTState</a></span> <span class="n">state</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOnTBTClientState</span> <span class="p">:</span> <span class="kt"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> + @@ -2535,6 +4122,18 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLOnTouchEvent.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnTouchEvent</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchType.h@T@SDLTouchType">SDLTouchType</a></span> <span class="n">type</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLTouchEvent.html">SDLTouchEvent</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">event</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOnTouchEvent</span> <span class="p">:</span> <span class="kt"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> + @@ -2568,6 +4167,22 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLOnWayPointChange.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLOnWayPointChange</span> <span class="p">:</span> <span class="nc"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> + +<span class="cm">/** + * @abstract Location address for display purposes only. + * + * Required, Array of Strings, Array size 1 - 10 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">waypoints</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLOnWayPointChange</span> <span class="p">:</span> <span class="kt"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span></code></pre> + @@ -2701,6 +4316,19 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLPermissionItem.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPermissionItem</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">rpcName</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLHMIPermissions.html">SDLHMIPermissions</a></span> <span class="o">*</span><span class="n">hmiPermissions</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLParameterPermissions.html">SDLParameterPermissions</a></span> <span class="o">*</span><span class="n">parameterPermissions</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLPermissionItem</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -2713,6 +4341,81 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLPermissionManager.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPermissionManager</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="cm">/** + * Start the manager with a completion block that will be called when startup completes. This is used internally. To use an SDLPermissionManager, you should use the manager found on `SDLManager`. + * + * @param completionHandler The block to be called when the manager's setup is complete. + */</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startWithCompletionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">BOOL</span> <span class="n">success</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">__nullable</span> <span class="n">error</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span> + +<span class="cm">/** + * Stop the manager. This method is used internally. + */</span> +<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> + +<span class="cm">/** + * Determine if an individual RPC is allowed for the current HMI level + * + * @param rpcName The name of the RPC to be tested, for example, SDLShow + * + * @return YES if the RPC is allowed at the current HMI level, NO if not + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isRPCAllowed</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName">SDLPermissionRPCName</a></span><span class="p">)</span><span class="nv">rpcName</span><span class="p">;</span> + +<span class="cm">/** + * Determine if all RPCs are allowed for the current HMI level + * + * @param rpcNames The RPCs to check + * + * @return AllAllowed if all of the permissions are allowed, AllDisallowed if all the permissions are disallowed, Any if some are allowed, and some are disallowed + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n"><a href="Enums/SDLPermissionGroupStatus.html">SDLPermissionGroupStatus</a></span><span class="p">)</span><span class="nf">groupStatusOfRPCs</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName">SDLPermissionRPCName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">rpcNames</span><span class="p">;</span> + +<span class="cm">/** + * Retrieve a dictionary with keys that are the passed in RPC names, and objects of an NSNumber<BOOL> specifying if that RPC is currently allowed + * + * @param rpcNames An array of RPC names to check + * + * @return A dictionary specifying if the passed in RPC names are currently allowed or not + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName">SDLPermissionRPCName</a></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="o">*</span><span class="p">)</span><span class="nf">statusOfRPCs</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName">SDLPermissionRPCName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">rpcNames</span><span class="p">;</span> + +<span class="cm">/** + * 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. + * + * @warning This block will be captured by the SDLPermissionsManager, be sure to use [weakself/strongself](http://www.logicsector.com/ios/avoiding-objc-retain-cycles-with-weakself-and-strongself-the-easy-way/) if you are referencing self within your observer block. + * + * @warning The observer may be called before this method returns, do not attempt to remove the observer from within the observer. That could send `nil` to removeObserverForIdentifier:. If you want functionality like that, call groupStatusOfRPCs: instead. + * + * @param rpcNames The RPCs to be observed + * @param groupType 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. + * @param handler The block that will be called whenever permissions change. + * + * @return An identifier that can be passed to removeObserverForIdentifer: to remove the observer + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n"><a href="Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionObserverIdentifier">SDLPermissionObserverIdentifier</a></span><span class="p">)</span><span class="nf">addObserverForRPCs</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName">SDLPermissionRPCName</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">rpcNames</span> <span class="nf">groupType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLPermissionGroupType.html">SDLPermissionGroupType</a></span><span class="p">)</span><span class="nv">groupType</span> <span class="nf">withHandler</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionsChangedHandler">SDLPermissionsChangedHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> + +<span class="cm">/** + * Remove every current observer + */</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">removeAllObservers</span><span class="p">;</span> + +<span class="cm">/** + * Remove block observers for the specified RPC + * + * @param identifier The identifier specifying which observer to remove + */</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">removeObserverForIdentifier</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionObserverIdentifier">SDLPermissionObserverIdentifier</a></span><span class="p">)</span><span class="nv">identifier</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLPermissionManager</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -2725,6 +4428,23 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLPhoneCapability.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPhoneCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDialNumber</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">dialNumberEnabled</span><span class="p">;</span> + +<span class="cm">/** + Whether or not the DialNumber RPC is enabled. + Boolean, optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span> <span class="o">*</span><span class="n">dialNumberEnabled</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLPhoneCapability</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -2737,6 +4457,58 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLPinchGesture.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLPinchGesture</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="cm">/** + * @abstract + * Initializes a pinch gesture. + * @param firstTouch + * First touch of the gesture + * @param secondTouch + * Second touch of the gesture + * @return SDLPinchGesture + * Instance of SDLPinchGesture. + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFirstTouch</span><span class="p">:(</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"><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> + +<span class="cm">/** + * @abstract + * First touch of a pinch gesture. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n"><a href="Classes/SDLTouch.html">SDLTouch</a></span> <span class="o">*</span><span class="n">firstTouch</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Second touch of a pinch gesture. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n"><a href="Classes/SDLTouch.html">SDLTouch</a></span> <span class="o">*</span><span class="n">secondTouch</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Distance between first and second touches. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">CGFloat</span> <span class="n">distance</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Center point between first and second touches. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">CGPoint</span> <span class="n">center</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Returns whether or not the pinch gesture is valid. This is true if both touches + * are non null. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">isValid</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLPinchGesture</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -2770,6 +4542,27 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLProtocol.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLProtocol</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o"><</span><span class="n"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="o">></span> + +<span class="c1">// Sending +</span><span class="o">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">startServiceWithType</span><span class="o">:</span><span class="p">(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="n">serviceType</span> <span class="n">payload</span><span class="o">:</span><span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="n">payload</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">startSecureServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">payload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="kt">void</span> <span class="p">(</span><span class="o">^</span><span class="p">)(</span><span class="n">BOOL</span> <span class="n">success</span><span class="p">,</span> <span class="n">NSError</span> <span class="o">*</span><span class="n">error</span><span class="p">))</span><span class="nv">completionHandler</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">endServiceWithType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span> <span class="nf">encrypted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">encryption</span> <span class="nf">error</span><span class="p">:(</span><span class="n">NSError</span> <span class="o">**</span><span class="p">)</span><span class="nv">error</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">withServiceType</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendEncryptedRawData</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span> <span class="nf">onService</span><span class="p">:(</span><span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span><span class="p">;</span> + +<span class="c1">// Recieving +</span><span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleBytesFromTransport</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">receivedData</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLProtocol</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span><span class="p">,</span> <span class="kt"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span></code></pre> + @@ -2782,6 +4575,34 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLProtocolHeader.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLProtocolHeader</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> <span class="p">{</span> + <span class="n">UInt8</span> <span class="n">_version</span><span class="p">;</span> + <span class="n">NSUInteger</span> <span class="n">_size</span><span class="p">;</span> +<span class="p">}</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">version</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">size</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">encrypted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLFrameType.html">SDLFrameType</a></span> <span class="n">frameType</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLServiceType.html">SDLServiceType</a></span> <span class="n">serviceType</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLFrameInfo.html">SDLFrameInfo</a></span> <span class="n">frameData</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt8</span> <span class="n">sessionID</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">UInt32</span> <span class="n">bytesInPayload</span><span class="p">;</span> + +<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> +<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="n">data</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">parse</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">description</span><span class="p">;</span> +<span class="k">+</span> <span class="p">(</span><span class="n">__kindof</span> <span class="n">SDLProtocolHeader</span> <span class="o">*</span><span class="p">)</span><span class="nf">headerForVersion</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">version</span><span class="p">;</span> +<span class="k">+</span> <span class="p">(</span><span class="n">UInt8</span><span class="p">)</span><span class="nf">determineVersion</span><span class="p">:(</span><span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">data</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLProtocolHeader</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCopying</span></code></pre> + @@ -2794,6 +4615,25 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLProtocolMessage.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLProtocolMessage</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLProtocolHeader.html">SDLProtocolHeader</a></span> <span class="o">*</span><span class="n">header</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">payload</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">data</span><span class="p">;</span> + +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">messageWithHeader</span><span class="p">:(</span><span class="n"><a href="Classes/SDLProtocolHeader.html">SDLProtocolHeader</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">header</span> <span class="nf">andPayload</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">payload</span><span class="p">;</span> <span class="c1">// Returns a V1 or V2 object +</span> +<span class="k">-</span> <span class="p">(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="n">size</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">description</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">rpcDictionary</span><span class="p">;</span> <span class="c1">// Use for RPC type messages to obtain the data in a dictionary +</span> +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLProtocolMessage</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -2806,6 +4646,52 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLProxy.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLProxy</span> <span class="p">:</span> <span class="nc">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="p">,</span> <span class="n">NSStreamDelegate</span><span class="o">></span> <span class="p">{</span> + <span class="n">Byte</span> <span class="n">_version</span><span class="p">;</span> + <span class="n">Byte</span> <span class="n">_bulkSessionID</span><span class="p">;</span> + <span class="n">BOOL</span> <span class="n">_isConnected</span><span class="p">;</span> +<span class="p">}</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="n">protocol</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="n">transport</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSSet</span><span class="o"><</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">proxyListeners</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">SDLTimer</span> <span class="o">*</span><span class="n">startSessionTimer</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">debugConsoleGroupName</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">readonly</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">proxyVersion</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">initWithTransport</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">transport</span> + <span class="nf">protocol</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAbstractProtocol.html">SDLAbstractProtocol</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span> + <span class="nf">delegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addDelegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">removeDelegate</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRPC</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">message</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleRPCDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dictionary</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">handleProtocolMessage</span><span class="p">:(</span><span class="n"><a href="Classes/SDLProtocolMessage.html">SDLProtocolMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">msgData</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addSecurityManagers</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">Class</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">securityManagerClasses</span> <span class="nf">forAppId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appId</span><span class="p">;</span> + +<span class="cm">/** + * 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. + * @param inputStream A stream containing the data to put to the module. + * @param 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. + */</span> +<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> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLProxy</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt"><a href="Protocols/SDLProtocolListener.html">SDLProtocolListener</a></span><span class="p">,</span> <span class="kt">StreamDelegate</span></code></pre> + @@ -2818,6 +4704,21 @@ The call back also includes details regarding the current HMI_Status level, driv <a href="Classes/SDLProxyFactory.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLProxyFactory</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="p">{</span> +<span class="p">}</span> + +<span class="o">+</span> <span class="p">(</span><span class="n"><a href="Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="p">)</span><span class="n">buildSDLProxyWithListener</span><span class="o">:</span><span class="p">(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">listener</span><span class="p">;</span> + +<span class="k">+</span> <span class="p">(</span><span class="n"><a href="Classes/SDLProxy.html">SDLProxy</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">buildSDLProxyWithListener</span><span class="p">:(</span><span class="n">NSObject</span><span class="o"><</span><span class="n"><a href="Protocols/SDLProxyListener.html">SDLProxyListener</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">listener</span> + <span class="nf">tcpIPAddress</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">ipaddress</span> + <span class="nf">tcpPort</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">port</span><span class="p">;</span> +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLProxyFactory</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -2904,6 +4805,30 @@ in conventional FM radio broadcasts.</p> <a href="Classes/SDLRPCMessage.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRPCMessage</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> <span class="p">{</span> + <span class="n">NSMutableDictionary</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">function</span><span class="p">;</span> + <span class="n">NSMutableDictionary</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">parameters</span><span class="p">;</span> + <span class="n">NSString</span> <span class="o">*</span><span class="n">messageType</span><span class="p">;</span> +<span class="p">}</span> + +<span class="o">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">initWithName</span><span class="o">:</span><span class="p">(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">name</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithDictionary</span><span class="p">:(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">dict</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="n">getFunctionName</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setFunctionName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nf">getParameters</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span><span class="p">;</span> +<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">setParameters</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">functionName</span> <span class="nf">value</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSObject</span> <span class="o">*</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSData</span> <span class="o">*</span><span class="n">bulkData</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">name</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">messageType</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLRPCMessage</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -2915,6 +4840,15 @@ in conventional FM radio broadcasts.</p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRPCNotification</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLRPCNotification</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span></code></pre> + @@ -2927,6 +4861,34 @@ in conventional FM radio broadcasts.</p> <a href="Classes/SDLRPCNotificationNotification.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRPCNotificationNotification</span> <span class="p">:</span> <span class="nc">NSNotification</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">__kindof</span> <span class="n"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="n">notification</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> <span class="nf">rpcNotification</span><span class="p">:(</span><span class="n">__kindof</span> <span class="n"><a href="Classes.html#/c:objc(cs)SDLRPCNotification">SDLRPCNotification</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">notification</span><span class="p">;</span> + +<span class="cm">/** + * Returns whether or not the containing notification is equal to a class, not including subclasses. + * + * @param aClass the class you are questioning + */</span> +<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">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span> + +<span class="cm">/** + * Returns whether or not the containing notification is a kind of class, including subclasses. + * + * @param aClass the class you are questioning + */</span> +<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">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span> + + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLRPCNotificationNotification</span> <span class="p">:</span> <span class="kt">NSNotification</span></code></pre> + @@ -2939,6 +4901,17 @@ in conventional FM radio broadcasts.</p> <a href="Classes/SDLRPCRequest.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRPCRequest</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">correlationID</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLRPCRequest</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span></code></pre> + @@ -2951,6 +4924,20 @@ in conventional FM radio broadcasts.</p> <a href="Classes/SDLRPCResponse.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRPCResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">correlationID</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">success</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLResult.h@T@SDLResult">SDLResult</a></span> <span class="n">resultCode</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">info</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLRPCResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span></code></pre> + @@ -2963,6 +4950,33 @@ in conventional FM radio broadcasts.</p> <a href="Classes/SDLRPCResponseNotification.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRPCResponseNotification</span> <span class="p">:</span> <span class="nc">NSNotification</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="n">response</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span> <span class="nf">object</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="p">)</span><span class="nv">object</span> <span class="nf">rpcResponse</span><span class="p">:(</span><span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">response</span><span class="p">;</span> + +<span class="cm">/** + * Returns whether or not the containing response is equal to a class, not including subclasses. + * + * @param aClass the class you are questioning + */</span> +<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">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span> + +<span class="cm">/** + * Returns whether or not the containing response is a kind of class, including subclasses. + * + * @param aClass the class you are questioning + */</span> +<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">Class</span><span class="p">)</span><span class="nv">aClass</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLRPCResponseNotification</span> <span class="p">:</span> <span class="kt">NSNotification</span></code></pre> + @@ -2975,6 +4989,22 @@ in conventional FM radio broadcasts.</p> <a href="Classes/SDLRPCStruct.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRPCStruct</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> <span class="p">{</span> + <span class="n">NSMutableDictionary</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">store</span><span class="p">;</span> +<span class="p">}</span> + +<span class="o">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">initWithDictionary</span><span class="o">:</span><span class="p">(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="n">dict</span><span class="p">;</span> +<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> + +<span class="k">-</span> <span class="p">(</span><span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nf">serializeAsDictionary</span><span class="p">:(</span><span class="n">Byte</span><span class="p">)</span><span class="nv">version</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLRPCStruct</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCopying</span></code></pre> + @@ -3074,6 +5104,58 @@ in conventional FM radio broadcasts.</p> <a href="Classes/SDLRectangle.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRectangle</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="cm">/** + Create a Rectangle + + @param x The top-left x value + @param y The top-left y value + @param width The width + @param height The height + @return An new SDLRectangle object + */</span> +<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> + +<span class="cm">/** + Create a Rectangle from a CGRect + + @param rect The rectangle to use + @return An new SDLRectangle object + */</span> +<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> + +<span class="cm">/** + * The X-coordinate of the user control + * Required, Float + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">x</span><span class="p">;</span> + +<span class="cm">/** + * The Y-coordinate of the user control + * Required, Float + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">y</span><span class="p">;</span> + +<span class="cm">/** + * The width of the user control's bounding rectangle + * Required, Float + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">width</span><span class="p">;</span> + +<span class="cm">/** + * The height of the user control's bounding rectangle + * Required, Float + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">height</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLRectangle</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -3197,6 +5279,40 @@ in conventional FM radio broadcasts.</p> <a href="Classes/SDLRemoteControlCapabilities.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLRemoteControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithClimateControlCapabilities</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">climateControlCapabilities</span> <span class="nf">radioControlCapabilities</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">radioControlCapabilities</span> <span class="nf">buttonCapabilities</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">buttonCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @abstract If included, the platform supports RC climate controls. + * For this baseline version, maxsize=1. i.e. only one climate control module is supported. + * + * Optional, Array of SDLClimateControlCapabilities, Array length 1 - 100 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLClimateControlCapabilities.html">SDLClimateControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">climateControlCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @abstract If included, the platform supports RC radio controls. + * For this baseline version, maxsize=1. i.e. only one radio control module is supported. + * + * Optional, Array of SDLRadioControlCapabilities, Array length 1 - 100 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLRadioControlCapabilities.html">SDLRadioControlCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">radioControlCapabilities</span><span class="p">;</span> + +<span class="cm">/** + * @abstract If included, the platform supports RC button controls with the included button names. + * + * Optional, Array of SDLButtonCapabilities, Array length 1 - 100 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLButtonCapabilities.html">SDLButtonCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">buttonCapabilities</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLRemoteControlCapabilities</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -3261,6 +5377,18 @@ in conventional FM radio broadcasts.</p> <a href="Classes/SDLScreenParams.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLScreenParams</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">resolution</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLTouchEventCapabilities.html">SDLTouchEventCapabilities</a></span> <span class="o">*</span><span class="n">touchEventAvailable</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLScreenParams</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -3355,6 +5483,89 @@ Function Group: ScrollableMessage <a href="Classes/SDLSendLocation.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSendLocation</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLongitude</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">longitude</span> <span class="nf">latitude</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">latitude</span> <span class="nf">locationName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locationName</span> <span class="nf">locationDescription</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locationDescription</span> <span class="nf">address</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">address</span> <span class="nf">phoneNumber</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">phoneNumber</span> <span class="nf">image</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLongitude</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">longitude</span> <span class="nf">latitude</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">latitude</span> <span class="nf">locationName</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locationName</span> <span class="nf">locationDescription</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">locationDescription</span> <span class="nf">displayAddressLines</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">displayAddressLines</span> <span class="nf">phoneNumber</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">phoneNumber</span> <span class="nf">image</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span> <span class="nf">deliveryMode</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</a></span><span class="p">)</span><span class="nv">deliveryMode</span> <span class="nf">timeStamp</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">timeStamp</span> <span class="nf">address</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">address</span><span class="p">;</span> + +<span class="cm">/** + * The longitudinal coordinate of the location. + * + * Float, Required, -180.0 - 180.0 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * The latitudinal coordinate of the location. + * + * Float, Required, -90.0 - 90.0 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * Name / title of intended location + * + * Optional, Maxlength = 500 char + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * Description of the intended location / establishment + * + * Optional, MaxLength = 500 char + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * Location address for display purposes only + * + * Contains String, Optional, Max Array Length = 4, Max String Length = 500 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * Phone number of intended location / establishment + * + * Optional, Max Length = 500 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</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> + +<span class="cm">/** + * Image / icon of intended location + * + * Optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">locationImage</span><span class="p">;</span> + +<span class="cm">/** + * Mode in which the sendLocation request is sent + * + * Optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLDeliveryMode.h@T@SDLDeliveryMode">SDLDeliveryMode</a></span> <span class="n">deliveryMode</span><span class="p">;</span> + +<span class="cm">/** + * Arrival time of Location. If multiple SendLocations are sent, this will be used for sorting as well. + * + * Optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="n">timeStamp</span><span class="p">;</span> + +<span class="cm">/** + * Address to be used for setting destination + * + * Optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLOasisAddress.html">SDLOasisAddress</a></span> <span class="o">*</span><span class="n">address</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLSendLocation</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + @@ -3366,6 +5577,15 @@ Function Group: ScrollableMessage + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSendLocationResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLSendLocationResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> + @@ -3768,6 +5988,28 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLSoftButton.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSoftButton</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<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">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> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithType</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span><span class="p">)</span><span class="nv">type</span> <span class="nf">text</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">image</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span> <span class="nf">highlighted</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">highlighted</span> <span class="nf">buttonId</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">buttonId</span> <span class="nf">systemAction</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span><span class="p">)</span><span class="nv">systemAction</span> <span class="nf">handler</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> + +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLNotificationConstants.h@T@SDLRPCButtonNotificationHandler">SDLRPCButtonNotificationHandler</a></span> <span class="n">handler</span><span class="p">;</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLSoftButtonType.h@T@SDLSoftButtonType">SDLSoftButtonType</a></span> <span class="n">type</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">isHighlighted</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">softButtonID</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span> <span class="n">systemAction</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLSoftButton</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -3895,6 +6137,87 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLStreamingMediaConfiguration.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLStreamingMediaConfiguration</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> + +<span class="cm">/** + * Set security managers which could be used. This is primarily used with video streaming applications to authenticate and perhaps encrypt traffic data. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * What encryption level video/audio streaming should be. The default is SDLStreamingEncryptionFlagAuthenticateAndEncrypt. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span> <span class="n">maximumDesiredEncryption</span><span class="p">;</span> + +<span class="cm">/** + * 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. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + Usable to change run time video stream setup behavior. Only use this and modify the results if you *really* know what you're doing. The head unit defaults are generally good. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">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> + +<span class="cm">/** + Set the window your video streaming content is within. + + Activates the haptic view parser when set. If the window contains `UIView` 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 `SDLTouchManagerDelegate`. + + @warning Apps using views outside of the `UIView` 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 `SDLSendHapticData` RPC request. + + @warning This is a weak property and it's therefore your job to hold a strong reference to this window. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">weak</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">UIWindow</span> <span class="o">*</span><span class="n">window</span><span class="p">;</span> + +<span class="cm">/** + 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. + + @return The configuration + */</span> +<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> + +<span class="cm">/** + Manually set all the properties to the streaming media configuration + + @param securityManagers The security managers to use or nil for none. + @param encryptionFlag 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. + @param videoSettings Custom video encoder settings to be used in video streaming. + @param window The UIWindow you are running the content that is being streamed on, to use for haptics if needed and possible (only works for UIViews) + @return The configuration + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSecurityManagers</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="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> + +<span class="cm">/** + Create a secure configuration for each of the security managers provided. + + @param securityManagers The security managers to be used. The encryption flag will be set to AuthenticateAndEncrypt if any security managers are set. + @return The configuration + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSecurityManagers</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="p">)</span><span class="nv">securityManagers</span><span class="p">;</span> + +<span class="cm">/** + Create a secure configuration for each of the security managers provided. + + @param securityManagers The security managers to be used. The encryption flag will be set to AuthenticateAndEncrypt if any security managers are set. + @return The configuration + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">secureConfigurationWithSecurityManagers</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="p">)</span><span class="nv">securityManagers</span> <span class="n">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use an initializer instead"</span><span class="p">);</span> + +<span class="cm">/** + 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 `init`. + + @return The configuration + */</span> +<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">insecureConfiguration</span> <span class="n">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use the standard initializer instead"</span><span class="p">);</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLStreamingMediaConfiguration</span> <span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">NSCopying</span></code></pre> + @@ -3907,6 +6230,137 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLStreamingMediaManager.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLStreamingMediaManager</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="cm">/** + * Touch Manager responsible for providing touch event notifications. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n"><a href="Classes/SDLTouchManager.html">SDLTouchManager</a></span> <span class="o">*</span><span class="n">touchManager</span><span class="p">;</span> + +<span class="cm">/** + A haptic interface that can be updated to reparse views within the window you've provided. Send a `SDLDidUpdateProjectionView` notification or call the `updateInterfaceLayout` method to reparse. The "output" of this haptic interface occurs in the `touchManager` property where it will call the delegate. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">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> + +<span class="cm">/** + * Whether or not video streaming is supported + * + * @see SDLRegisterAppInterface SDLDisplayCapabilities + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isStreamingSupported</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">streamingSupported</span><span class="p">;</span> + +<span class="cm">/** + * Whether or not the video session is connected. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isVideoConnected</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">videoConnected</span><span class="p">;</span> + +<span class="cm">/** + * Whether or not the video session is encrypted. This may be different than the requestedEncryptionType. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isVideoEncrypted</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">videoEncrypted</span><span class="p">;</span> + +<span class="cm">/** + * Whether or not the audio session is connected. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isAudioConnected</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">audioConnected</span><span class="p">;</span> + +<span class="cm">/** + * Whether or not the audio session is encrypted. This may be different than the requestedEncryptionType. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isAudioEncrypted</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">audioEncrypted</span><span class="p">;</span> + +<span class="cm">/** + * 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. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isVideoStreamingPaused</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">videoStreamingPaused</span><span class="p">;</span> + +<span class="cm">/** + * This is the current screen size of a connected display. This will be the size the video encoder uses to encode the raw image data. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">CGSize</span> <span class="n">screenSize</span><span class="p">;</span> + +<span class="cm">/** + This is the agreed upon format of video encoder that is in use, or nil if not currently connected. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*</span><span class="n">videoFormat</span><span class="p">;</span> + +<span class="cm">/** + A list of all supported video formats by this manager + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">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> + +<span class="cm">/** + * The pixel buffer pool reference returned back from an active VTCompressionSessionRef encoder. + * + * @warning This will only return a valid pixel buffer pool after the encoder has been initialized (when the video session has started). + * @discussion Clients may call this once and retain the resulting pool, this call is cheap enough that it's OK to call it once per frame. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">CVPixelBufferPoolRef</span> <span class="n">pixelBufferPool</span><span class="p">;</span> + +<span class="cm">/** + * The requested encryption type when a session attempts to connect. This setting applies to both video and audio sessions. + * + * DEFAULT: SDLStreamingEncryptionFlagAuthenticateAndEncrypt + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span> <span class="n">requestedEncryptionType</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span> + +<span class="cm">/** + Create a new streaming media manager for navigation and VPM apps with a specified configuration + + @param connectionManager The pass-through for RPCs + @param configuration The configuration of this streaming media session + @return A new streaming manager + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithConnectionManager</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n">SDLConnectionManagerType</span><span class="o">></span><span class="p">)</span><span class="nv">connectionManager</span> <span class="nf">configuration</span><span class="p">:(</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="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> + +<span class="cm">/** + * 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 `SDLManager`. + */</span> +<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"><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> + +<span class="cm">/** + * Stop the manager. This method is used internally. + */</span> +<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> + +<span class="cm">/** + * 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. + * + * @param imageBuffer A CVImageBufferRef to be encoded by Video Toolbox + * + * @return Whether or not the data was successfully encoded and sent. + */</span> +<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">CVImageBufferRef</span><span class="p">)</span><span class="nv">imageBuffer</span><span class="p">;</span> + +<span class="cm">/** + * 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. + * + * @param imageBuffer A CVImageBufferRef to be encoded by Video Toolbox + * @param presentationTimestamp A presentation timestamp for the frame, or kCMTimeInvalid if timestamp is unknown. If it's valid, it must be greater than the previous one. + * + * @return Whether or not the data was successfully encoded and sent. + */</span> +<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">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> + +<span class="cm">/** + * This method receives PCM audio data and will attempt to send that data across to the head unit for immediate playback + * + * @param audioData The data in PCM audio format, to be played + * + * @return Whether or not the data was successfully sent. + */</span> +<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">NSData</span> <span class="o">*</span><span class="p">)</span><span class="nv">audioData</span><span class="p">;</span> + + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLStreamingMediaManager</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -4080,6 +6534,15 @@ change the settings of a specific remote control module.</p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSubscribeWayPointsResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLSubscribeWayPointsResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> + @@ -4112,6 +6575,15 @@ change the settings of a specific remote control module.</p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSyncPData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLSyncPData</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + @@ -4123,6 +6595,15 @@ change the settings of a specific remote control module.</p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLSyncPDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLSyncPDataResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> + @@ -4158,6 +6639,20 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLTCPTransport.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTCPTransport</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span> <span class="p">{</span> + <span class="n">_Nullable</span> <span class="n">CFSocketRef</span> <span class="n">socket</span><span class="p">;</span> +<span class="p">}</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">hostName</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">portNumber</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLTCPTransport</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLAbstractTransport.html">SDLAbstractTransport</a></span></code></pre> + @@ -4217,6 +6712,30 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLTemperature.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTemperature</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithUnit</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</a></span><span class="p">)</span><span class="nv">unit</span> <span class="nf">value</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Temperature Unit + * + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</a></span> <span class="n">unit</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Temperature Value in TemperatureUnit specified unit. Range depends on OEM and is not checked by SDL + * + * FLoat value + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">value</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLTemperature</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -4294,6 +6813,23 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLTireStatus.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTireStatus</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLWarningLightStatus.h@T@SDLWarningLightStatus">SDLWarningLightStatus</a></span> <span class="n">pressureTelltale</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">leftFront</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">rightFront</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">leftRear</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">rightRear</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">innerLeftRear</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLSingleTireStatus.html">SDLSingleTireStatus</a></span> <span class="o">*</span><span class="n">innerRightRear</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLTireStatus</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -4306,6 +6842,56 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLTouch.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTouch</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="cm">/** + * @abstract + * Initializes a touch. + * @param touchEvent + * Incoming touch event from onOnTouchEvent notification. + * @return SDLTouch + * Instance of SDLTouch. + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTouchEvent</span><span class="p">:(</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> + +<span class="cm">/** + * @abstract + * Identifier of the touch's finger. Refer to SDLTouchIdentifier for valid + * identifiers. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSInteger</span> <span class="n">identifier</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Location of touch point, in the head unit's coordinate system. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">CGPoint</span> <span class="n">location</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Timestamp in which the touch occured. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">timeStamp</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Returns whether or not this touch is a first finger. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">isFirstFinger</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Returns whether or not this touch is a second finger. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">isSecondFinger</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLTouch</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -4318,6 +6904,18 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLTouchCoord.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTouchCoord</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">x</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">y</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLTouchCoord</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -4330,6 +6928,42 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLTouchEvent.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTouchEvent</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="cm">/** + A touch's unique identifier. The application can track the current touch events by id. + If a touch event has type begin, the id should be added to the set of touches. + If a touch event has type end, the id should be removed from the set of touches. + + Mandatory, 0-9 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">touchEventId</span><span class="p">;</span> + +<span class="cm">/** + The time that the touch was recorded. This number can the time since the beginning of the session or something else as long as the units are in milliseconds. + + The timestamp is used to determined the rate of change of position of a touch. + + The application also uses the time to verify whether two touches, with different ids, are part of a single action by the user. + + If there is only a single timestamp in this array, it is the same for every coordinate in the coordinates array. + + Mandatory, array size 1-1000, contains <NSNumber> size 0-5000000000 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">timeStamp</span><span class="p">;</span> + +<span class="cm">/** + * Mandatory, array size 1-1000, contains SDLTouchCoord + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLTouchCoord.html">SDLTouchCoord</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">coord</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLTouchEvent</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -4342,6 +6976,19 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLTouchEventCapabilities.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTouchEventCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">pressAvailable</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">multiTouchAvailable</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">doublePressAvailable</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLTouchEventCapabilities</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -4354,6 +7001,77 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLTouchManager.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTouchManager</span> <span class="p">:</span> <span class="nc">NSObject</span> + +<span class="cm">/** + Notified of processed touches such as pinches, pans, and taps + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">weak</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> + +<span class="cm">/** + * @abstract + * Returns all OnTouchEvent notifications as SDLTouch and SDLTouchType objects. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLTouchManager.h@T@SDLTouchEventHandler">SDLTouchEventHandler</a></span> <span class="n">touchEventHandler</span><span class="p">;</span> + +<span class="cm">/** + Distance between two taps on the screen, in the head unit's coordinate system, used for registering double-tap callbacks. + + @note Defaults to 50 px. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">)</span> <span class="n">CGFloat</span> <span class="n">tapDistanceThreshold</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Time (in seconds) between tap events to register a double-tap callback. + * @remark + * Default is 0.4 seconds. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">)</span> <span class="n">CGFloat</span> <span class="n">tapTimeThreshold</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Time (in seconds) between movement events to register panning or pinching + * callbacks. + * @remark + * Default is 0.05 seconds. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">)</span> <span class="n">CGFloat</span> <span class="n">movementTimeThreshold</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Boolean denoting whether or not the touch manager should deliver touch event + * callbacks. + * @remark + * Default is true. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">getter</span><span class="o">=</span><span class="n">isTouchEnabled</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">touchEnabled</span><span class="p">;</span> + +<span class="cm">/** + * @abstract + * Cancels pending touch event timers that may be in progress. + * @remark + * Currently only impacts the timer used to register single taps. + */</span> +<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> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span> + +<span class="cm">/** + Initialize a touch manager with a hit tester if available + + @param hitTester The hit tester to be used to correlate a point with a view + @return The initialized touch manager + */</span> +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHitTester</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> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLTouchManager</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre> + @@ -4366,6 +7084,20 @@ change the settings of a specific remote control module.</p> <a href="Classes/SDLTurn.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLTurn</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithNavigationText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">navigationText</span> <span class="nf">turnIcon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span><span class="p">;</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">navigationText</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">turnIcon</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLTurn</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -4525,6 +7257,15 @@ See SDLSubscribeButton</p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeWayPoints</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLUnsubscribeWayPoints</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> + @@ -4536,6 +7277,15 @@ See SDLSubscribeButton</p> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLUnsubscribeWayPointsResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLUnsubscribeWayPointsResponse</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> + @@ -4595,6 +7345,18 @@ See SDLSubscribeButton</p> <a href="Classes/SDLVehicleDataResult.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLVehicleDataResult</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataType.h@T@SDLVehicleDataType">SDLVehicleDataType</a></span> <span class="n">dataType</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVehicleDataResultCode.h@T@SDLVehicleDataResultCode">SDLVehicleDataResultCode</a></span> <span class="n">resultCode</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLVehicleDataResult</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -4628,6 +7390,41 @@ See SDLSubscribeButton</p> <a href="Classes/SDLVideoStreamingCapability.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLVideoStreamingCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPreferredResolution</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">preferredResolution</span> <span class="nf">maxBitrate</span><span class="p">:(</span><span class="kt">int32_t</span><span class="p">)</span><span class="nv">maxBitrate</span> <span class="nf">supportedFormats</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">supportedFormats</span> <span class="nf">hapticDataSupported</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">hapticDataSupported</span><span class="p">;</span> + +<span class="cm">/** + * @abstract The preferred resolution of a video stream for decoding and rendering on HMI, optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">preferredResolution</span><span class="p">;</span> + +<span class="cm">/** + * @abstract The maximum bitrate of video stream that is supported, in kbps, optional + * + * minvalue= 0 + * + * maxvalue= 2147483647 + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">maxBitrate</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Detailed information on each format supported by this system, in its preferred order, optional + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">supportedFormats</span><span class="p">;</span> + +<span class="cm">/** + True if the system can utilize the haptic spatial data from the source being streamed. + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">hapticSpatialDataSupported</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLVideoStreamingCapability</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -4640,6 +7437,27 @@ See SDLSubscribeButton</p> <a href="Classes/SDLVideoStreamingFormat.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLVideoStreamingFormat</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="cm">/** + * @abstract Protocol type, see VideoStreamingProtocol, mandatory + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVideoStreamingProtocol.h@T@SDLVideoStreamingProtocol">SDLVideoStreamingProtocol</a></span> <span class="n">protocol</span><span class="p">;</span> + +<span class="cm">/** + * @abstract Codec type, see VideoStreamingCodec, mandatory + */</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Type Definitions.html#/c:SDLVideoStreamingCodec.h@T@SDLVideoStreamingCodec">SDLVideoStreamingCodec</a></span> <span class="n">codec</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithCodec</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLVideoStreamingCodec.h@T@SDLVideoStreamingCodec">SDLVideoStreamingCodec</a></span><span class="p">)</span><span class="nv">codec</span> <span class="nf">protocol</span><span class="p">:(</span><span class="n"><a href="Type Definitions.html#/c:SDLVideoStreamingProtocol.h@T@SDLVideoStreamingProtocol">SDLVideoStreamingProtocol</a></span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLVideoStreamingFormat</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + @@ -4652,6 +7470,23 @@ See SDLSubscribeButton</p> <a href="Classes/SDLVRHelpItem.html" class="slightly-smaller">See more</a> + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@interface</span> <span class="nc">SDLVRHelpItem</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithText</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">image</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span><span class="p">;</span> + +<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithText</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">image</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span> <span class="nf">position</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">position</span><span class="p">;</span> + +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">image</span><span class="p">;</span> +<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">position</span><span class="p">;</span> + +<span class="k">@end</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="kd">class</span> <span class="kt">SDLVRHelpItem</span> <span class="p">:</span> <span class="kt"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> + |