diff options
Diffstat (limited to 'docs/Classes.html')
| -rw-r--r-- | docs/Classes.html | 4378 |
1 files changed, 219 insertions, 4159 deletions
diff --git a/docs/Classes.html b/docs/Classes.html index e8b760e60..8b7670743 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -552,46 +552,15 @@ SDLAppServiceCapability </h3> - <p>Undocumented</p> + <p>A currently available service.</p> + +<p>@since RPC 5.1</p> <a href="Classes/SDLAppServiceCapability.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAppServiceCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init for required parameters. - * - * @param updatedAppServiceRecord Service record for a specific app service provider - * @return A SDLAppServiceCapability object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithUpdatedAppServiceRecord</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAppServiceRecord.html">SDLAppServiceRecord</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updatedAppServiceRecord</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> - -<span class="cm">/** - * Convenience init for all parameters. - * - * @param updateReason Update reason for this service record - * @param updatedAppServiceRecord Service record for a specific app service provider - * @return A SDLAppServiceCapability object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithUpdateReason</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLServiceUpdateReason.h@T@SDLServiceUpdateReason">SDLServiceUpdateReason</a></span><span class="p">)</span><span class="nv">updateReason</span> <span class="nf">updatedAppServiceRecord</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAppServiceRecord.html">SDLAppServiceRecord</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">updatedAppServiceRecord</span><span class="p">;</span> - -<span class="cm">/** - * Only included in `OnSystemCapbilityUpdated`. Update reason for this service record. - * - * SDLServiceUpdateReason, 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%20Definitions.html#/c:SDLServiceUpdateReason.h@T@SDLServiceUpdateReason">SDLServiceUpdateReason</a></span> <span class="n">updateReason</span><span class="p">;</span> - -<span class="cm">/** - * Service record for a specific app service provider. - * - * SDLAppServiceRecord, Required - */</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/SDLAppServiceRecord.html">SDLAppServiceRecord</a></span> <span class="o">*</span><span class="n">updatedAppServiceRecord</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAppServiceCapability</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -604,98 +573,15 @@ SDLAppServiceData </h3> - <p>Undocumented</p> + <p>Contains all the current data of the app service. The serviceType will link to which of the service data objects are included in this object (e.g. if the service type is MEDIA, the mediaServiceData param should be included).</p> + +<p>@since RPC 5.1</p> <a href="Classes/SDLAppServiceData.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAppServiceData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init for service type and service id. - * - * @param serviceType The type of service that is to be offered by this app. - * @param serviceId A unique ID tied to this specific service record. - * @return A SDLAppServiceData object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppServiceType</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLAppServiceType.h@T@SDLAppServiceType">SDLAppServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">serviceId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceId</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> - -<span class="cm">/** - * Convenience init for media service data. - * - * @param mediaServiceData The media service data - * @param serviceId A unique ID tied to this specific service record. - * @return A SDLAppServiceData object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMediaServiceData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLMediaServiceData.html">SDLMediaServiceData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">mediaServiceData</span> <span class="nf">serviceId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceId</span><span class="p">;</span> - -<span class="cm">/** - * Convenience init for weather service data. - * - * @param weatherServiceData The weather service data - * @param serviceId A unique ID tied to this specific service record. - * @return A SDLAppServiceData object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithWeatherServiceData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLWeatherServiceData.html">SDLWeatherServiceData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">weatherServiceData</span> <span class="nf">serviceId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceId</span><span class="p">;</span> - -<span class="cm">/** - * Convenience init for navigation service data. - * - * @param navigationServiceData The navigation service data - * @param serviceId A unique ID tied to this specific service record. - * @return A SDLAppServiceData object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithNavigationServiceData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLNavigationServiceData.html">SDLNavigationServiceData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">navigationServiceData</span> <span class="nf">serviceId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceId</span><span class="p">;</span> - -<span class="cm">/** - * Convenience init for all parameters. - * - * @param serviceType The type of service that is to be offered by this app. - * @param serviceId A unique ID tied to this specific service record. - * @param mediaServiceData The media service data - * @param weatherServiceData The weather service data - * @param navigationServiceData The navigation service data - * @return A SDLAppServiceData object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppServiceType</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLAppServiceType.h@T@SDLAppServiceType">SDLAppServiceType</a></span><span class="p">)</span><span class="nv">serviceType</span> <span class="nf">serviceId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceId</span> <span class="nf">mediaServiceData</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLMediaServiceData.html">SDLMediaServiceData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">mediaServiceData</span> <span class="nf">weatherServiceData</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLWeatherServiceData.html">SDLWeatherServiceData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">weatherServiceData</span> <span class="nf">navigationServiceData</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLNavigationServiceData.html">SDLNavigationServiceData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">navigationServiceData</span><span class="p">;</span> - -<span class="cm">/** - * The type of service that is to be offered by this app. See `AppServiceType` for known enum equivalent types. Parameter is a string to allow for new service types to be used by apps on older versions of SDL Core. - * - * String, See `SDLAppServiceType`, Required - */</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">serviceType</span><span class="p">;</span> - -<span class="cm">/** - * A unique ID tied to this specific service record. The ID is supplied by the module that services publish themselves. - * - * String, Required - */</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">serviceId</span><span class="p">;</span> - -<span class="cm">/** - * The media service data. - * - * SDLMediaServiceData, 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/SDLMediaServiceData.html">SDLMediaServiceData</a></span> <span class="o">*</span><span class="n">mediaServiceData</span><span class="p">;</span> - -<span class="cm">/** - * The weather service data. - * - * SDLWeatherServiceData, 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/SDLWeatherServiceData.html">SDLWeatherServiceData</a></span> <span class="o">*</span><span class="n">weatherServiceData</span><span class="p">;</span> - -<span class="cm">/** - * The navigation service data. - * - * SDLNavigationServiceData, 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/SDLNavigationServiceData.html">SDLNavigationServiceData</a></span> <span class="o">*</span><span class="n">navigationServiceData</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAppServiceData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -727,54 +613,15 @@ SDLAppServiceRecord </h3> - <p>Undocumented</p> + <p>This is the record of an app service publisher that the module has. It should contain the most up to date information including the service’s active state.</p> + +<p>@since RPC 5.1</p> <a href="Classes/SDLAppServiceRecord.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAppServiceRecord</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init for all parameters. - * - * @param serviceID A unique ID tied to this specific service record - * @param serviceManifest Manifest for the service that this record is for - * @param servicePublished If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable - * @param serviceActive If true, the service is the active primary service of the supplied service type. - * @return A SDLAppServiceRecord object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithServiceID</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceID</span> <span class="nf">serviceManifest</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAppServiceManifest.html">SDLAppServiceManifest</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceManifest</span> <span class="nf">servicePublished</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">servicePublished</span> <span class="nf">serviceActive</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">serviceActive</span><span class="p">;</span> - -<span class="cm">/** - * A unique ID tied to this specific service record. The ID is supplied by the module that services publish themselves. - * - * String, Required - */</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">serviceID</span><span class="p">;</span> - -<span class="cm">/** - * Manifest for the service that this record is for. - * - * SDLAppServiceManifest, Required - */</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/SDLAppServiceManifest.html">SDLAppServiceManifest</a></span> <span class="o">*</span><span class="n">serviceManifest</span><span class="p">;</span> - -<span class="cm">/** - * If true, the service is published and available. If false, the service has likely just been unpublished, and should be considered unavailable. - * - * Boolean, Required - */</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">servicePublished</span><span class="p">;</span> - -<span class="cm">/** - * If true, the service is the active primary service of the supplied service type. It will receive all potential RPCs that are passed through to that service type. If false, it is not the primary service of the supplied type. See servicePublished for its availability. - * - * Boolean, Required - */</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">serviceActive</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAppServiceRecord</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -787,30 +634,15 @@ SDLAppServicesCapabilities </h3> - <p>Undocumented</p> + <p>Capabilities of app services including what service types are supported and the current state of services.</p> + +<p>@since RPC 5.1</p> <a href="Classes/SDLAppServicesCapabilities.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAppServicesCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init. - * - * @param appServices An array of currently available services. - * @return A SDLAppServicesCapabilities object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppServices</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/SDLAppServiceCapability.html">SDLAppServiceCapability</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">appServices</span><span class="p">;</span> - -<span class="cm">/** - * An array of currently available services. If this is an update to the capability the affected services will include an update reason in that item. - * - * Array of SDLAppServiceCapability, 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/SDLAppServiceCapability.html">SDLAppServiceCapability</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">appServices</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAppServicesCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -823,134 +655,13 @@ SDLArtwork </h3> - <p>Undocumented</p> + <p>An SDLFile subclass specifically designed for images</p> <a href="Classes/SDLArtwork.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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">/** - * Describes whether or not the image is a template that can be (re)colored by the SDL HMI. To make the artwork a template, set the `UIImage`s rendering mode to `UIImageRenderingModeAlwaysTemplate`. In order for templates to work successfully, the icon must be one solid color with a clear background. The artwork should be created using the PNG image format. - * - * @discussion An image should be templated if it is intended to be used as an icon in a button or menu. - */</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">isTemplate</span><span class="p">;</span> - -<span class="cm">/** - The Image RPC representing this artwork. Generally for use internally, you should instead pass an artwork to a Screen Manager method. - */</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/SDLImage.html">SDLImage</a></span> <span class="o">*</span><span class="n">imageRPC</span><span class="p">;</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 an ephemeral artwork from an image. A unique name will be assigned to the image. This name is a string representation of the image's data which is created by hashing the data using the MD5 algorithm. - * - * 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 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">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">/** - Create an SDLArtwork that represents a static icon. This can only be passed to the screen manager; passing this directly to the file manager will fail. - - @param staticIcon The static icon to be shown on the remote system. - - @return An instance of this class to be passed to a screen manager. - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">artworkWithStaticIcon</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLStaticIconName.h@T@SDLStaticIconName">SDLStaticIconName</a></span><span class="p">)</span><span class="nv">staticIcon</span> <span class="n">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use the standard initializer"</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">/** - * Convenience helper to create a persistent artwork from an image. A unique name will be assigned to the image. This name is a string representation of the image's data which is created by hashing the data using the MD5 algorithm. - * - * 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 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">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="cm">/** - * Create a file for transmission to the remote system from a UIImage. A unique name will be assigned to the image. This name is a string representation of the image's data which is created by hashing the data using the MD5 algorithm. - - * @param image The UIImage to be sent to the remote head unit - * @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">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="cm">/** - Create an SDLArtwork that represents a static icon. This can only be passed to the screen manager; passing this directly to the file manager will fail. - - @param staticIcon The static icon to be shown on the remote system. - - @return An instance of this class to be passed to a screen manager. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithStaticIcon</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLStaticIconName.h@T@SDLStaticIconName">SDLStaticIconName</a></span><span class="p">)</span><span class="nv">staticIcon</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -963,108 +674,15 @@ SDLAudioControlCapabilities </h3> - <p>Undocumented</p> + <p>Describes a head unit’s audio control capabilities.</p> + +<p>@since RPC 5.0</p> <a href="Classes/SDLAudioControlCapabilities.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - Constructs a newly allocated SDLAudioControlCapabilities object with audio control module name (max 100 chars) - - @param name The short friendly name of the audio control module. - @return An instance of the SDLAudioControlCapabilities class. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</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">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithModuleName:moduleInfo: instead"</span><span class="p">);</span> - -<span class="cm">/** - Constructs a newly allocated SDLAudioControlCapabilities object with audio control module name (max 100 chars) - - @param name The short friendly name of the audio control module. - @param moduleInfo Information about a RC module, including its id. - @return An instance of the SDLAudioControlCapabilities class. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</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">moduleInfo</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleInfo</span><span class="p">;</span> - -<span class="cm">/** - Constructs a newly allocated SDLAudioControlCapabilities object with given parameters - - @param name The short friendly name of the audio control module. - @param sourceAvailable Availability of the control of audio source. - @param volumeAvailable Availability of the volume of audio source. - @param equalizerAvailable Availability of the equalizer of audio source. - @param equalizerMaxChannelID Equalizer channel ID (between 1-100). - @return An instance of the SDLAudioControlCapabilities class. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</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">sourceAvailable</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">sourceAvailable</span> <span class="nf">keepContextAvailable</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">keepContextAvailable</span> <span class="nf">volumeAvailable</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">volumeAvailable</span> <span class="nf">equalizerAvailable</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">equalizerAvailable</span> <span class="nf">equalizerMaxChannelID</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">equalizerMaxChannelID</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithModuleName:moduleInfo:sourceAvailable:keepContextAvailable:volumeAvailable:equalizerAvailable:equalizerMaxChannelID: instead"</span><span class="p">);</span> - -<span class="cm">/** - Constructs a newly allocated SDLAudioControlCapabilities object with given parameters - - @param name The short friendly name of the audio control module. - @param moduleInfo Information about a RC module, including its id. - @param sourceAvailable Availability of the control of audio source. - @param volumeAvailable Availability of the volume of audio source. - @param equalizerAvailable Availability of the equalizer of audio source. - @param equalizerMaxChannelID Equalizer channel ID (between 1-100). - @return An instance of the SDLAudioControlCapabilities class. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</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">moduleInfo</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleInfo</span> <span class="nf">sourceAvailable</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">sourceAvailable</span> <span class="nf">keepContextAvailable</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">keepContextAvailable</span> <span class="nf">volumeAvailable</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">volumeAvailable</span> <span class="nf">equalizerAvailable</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">equalizerAvailable</span> <span class="nf">equalizerMaxChannelID</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">equalizerMaxChannelID</span><span class="p">;</span> - -<span class="cm">/** - * @abstract The short friendly name of the audio control module. - * It should not be used to identify a module by mobile application. - * - * Required, Max String length 100 chars - */</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">moduleName</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Availability of the control of audio source. - * - * 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">sourceAvailable</span><span class="p">;</span> - -<span class="cm">/** - Availability of the keepContext parameter. - - 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">keepContextAvailable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Availability of the control of audio volume. - * - * 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">volumeAvailable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Availability of the control of Equalizer Settings. - * - * 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">equalizerAvailable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Must be included if equalizerAvailable=true, - * and assume all IDs starting from 1 to this value are valid - * - * Optional, Integer 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">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">equalizerMaxChannelId</span><span class="p">;</span> - -<span class="cm">/** - * Information about a RC module, including its id. - * - * 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/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="n">moduleInfo</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -1077,62 +695,15 @@ SDLAudioControlData </h3> - <p>Undocumented</p> + <p>The audio control data information.</p> + +<p>@since RPC 5.0</p> <a href="Classes/SDLAudioControlData.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioControlData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - - -<span class="cm">/** - Constructs a newly allocated SDLAudioControlData object with given parameters - - @param source current primary audio source of the system. - @param keepContext Whether or not application's context is changed. - @param volume Reflects the volume of audio. - @param equalizerSettings list of supported Equalizer channels. - @return An instance of the SDLAudioControlData class. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSource</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource">SDLPrimaryAudioSource</a></span><span class="p">)</span><span class="nv">source</span> <span class="nf">keepContext</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">keepContext</span> <span class="nf">volume</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">volume</span> <span class="nf">equalizerSettings</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/SDLEqualizerSettings.html">SDLEqualizerSettings</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">equalizerSettings</span><span class="p">;</span> - -<span class="cm">/** - * @abstract In a getter response or a notification, - * it is the current primary audio source of the system. - * In a setter request, it is the target audio source that the system shall switch to. - * If the value is MOBILE_APP, the system shall switch to the mobile media app that issues the setter RPC. - * - * Optional, SDLPrimaryAudioSource - */</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%20Definitions.html#/c:SDLPrimaryAudioSource.h@T@SDLPrimaryAudioSource">SDLPrimaryAudioSource</a></span> <span class="n">source</span><span class="p">;</span> - -<span class="cm">/** - * @abstract This parameter shall not be present in any getter responses or notifications. - * This parameter is optional in a setter request. The default value is false. - * If it is true, the system not only changes the audio source but also brings the default - * infotainment system UI associated with the audio source to foreground and set the application to background. - * If it is false, the system changes the audio source, but keeps the current application's context. - * - * 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">keepContext</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Reflects the volume of audio, from 0%-100%. - * - * Required, Integer 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">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">volume</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Defines the list of supported channels (band) and their current/desired settings on HMI - * - * Required, Array of SDLEqualizerSettings with minSize:1 maxSize: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/SDLEqualizerSettings.html">SDLEqualizerSettings</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">equalizerSettings</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioControlData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -1145,58 +716,13 @@ SDLAudioFile </h3> - <p>Undocumented</p> + <p>Includes inforamtion about a given audio file</p> <a href="Classes/SDLAudioFile.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioFile</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - If initialized with a file URL, the file URL it came from - */</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">readonly</span><span class="p">)</span> <span class="n">NSURL</span> <span class="o">*</span><span class="n">inputFileURL</span><span class="p">;</span> - -<span class="cm">/** - If initialized with a file URL, where the transcoder should produce the transcoded PCM audio file - */</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">readonly</span><span class="p">)</span> <span class="n">NSURL</span> <span class="o">*</span><span class="n">outputFileURL</span><span class="p">;</span> - -<span class="cm">/** - In seconds. UINT32_MAX if unknown. - */</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">estimatedDuration</span><span class="p">;</span> - -<span class="cm">/** - The PCM audio data to be transferred and played - */</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 PCM audio data in bytes - */</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="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">/** - Initialize an audio file to be queued and played - - @param inputURL The file that exists on the device to be transcoded and queued - @param outputURL The target URL that the transcoded file will be output to - @param duration The duration of the file - @return The audio file object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithInputFileURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">inputURL</span> <span class="nf">outputFileURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">outputURL</span> <span class="nf">estimatedDuration</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">duration</span><span class="p">;</span> - -<span class="cm">/** - Initialize a buffer of PCM audio data to be queued and played - - @param data The PCM audio data buffer - @return The audio file object - */</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="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioFile</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -1230,84 +756,13 @@ SDLAudioStreamManager </h3> - <p>Undocumented</p> + <p>The manager to control the audio stream</p> <a href="Classes/SDLAudioStreamManager.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioStreamManager</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - The delegate describing when files are done playing or any errors that occur - */</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">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLAudioStreamManagerDelegate.html">SDLAudioStreamManagerDelegate</a></span><span class="o">></span> <span class="n">delegate</span><span class="p">;</span> - -<span class="cm">/** - Whether or not we are currently playing audio - */</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">isPlaying</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">playing</span><span class="p">;</span> - -<span class="cm">/** - The queue of audio files that will be played in sequence - */</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">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLAudioFile.html">SDLAudioFile</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">queue</span><span class="p">;</span> - -<span class="cm">/** - Init should only occur with dependencies. use `initWithManager:` - - @return A failure - */</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 an audio stream manager with a reference to the parent stream manager. - - @warning For internal use - - @param streamManager The parent stream manager - @return The audio stream manager - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithManager</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLStreamingAudioManagerType.html">SDLStreamingAudioManagerType</a></span><span class="o">></span><span class="p">)</span><span class="nv">streamManager</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> - -<span class="cm">/** - Push a new file URL onto the queue after converting it into the correct PCM format for streaming binary data. Call `playNextWhenReady` to start playing the next completed pushed file. - - @note This happens on a serial background thread and will provide an error callback using the delegate if the conversion fails. - - @param fileURL File URL to convert - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">pushWithFileURL</span><span class="p">:(</span><span class="n">NSURL</span> <span class="o">*</span><span class="p">)</span><span class="nv">fileURL</span><span class="p">;</span> - -<span class="cm">/** - Push a new audio buffer onto the queue. Call `playNextWhenReady` to start playing the pushed audio buffer. - - This data must be of the required PCM format. See SDLSystemCapabilityManager.pcmStreamCapability and SDLAudioPassThruCapability.h. - - This is *an example* of a PCM format used by some head units: - - audioType: PCM - - samplingRate: 16kHZ - - bitsPerSample: 16 bits - - There is generally only one channel to the data. - - @param data The audio buffer to be pushed onto the queue - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">pushWithData</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="cm">/** - Play the next item in the queue. If an item is currently playing, it will continue playing and this item will begin playing after it is completed. - - When complete, this will callback on the delegate. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">playNextWhenReady</span><span class="p">;</span> - -<span class="cm">/** - Stop playing the queue after the current item completes and clear the queue. If nothing is playing, the queue will be cleared. - */</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="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioStreamManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -1381,6 +836,8 @@ <p>This RPC allows a remote control type mobile application to simulate a hardware button press event.</p> +<p>@since RPC 4.5</p> + <a href="Classes/SDLButtonPress.html" class="slightly-smaller">See more</a> @@ -1416,108 +873,18 @@ SDLCancelInteraction </h3> - <p>Undocumented</p> + <p>Used to dismiss a modal view programmatically without needing to wait for the timeout to complete. Can be used to dismiss alerts, scrollable messages, sliders, and perform interactions (i.e. pop-up menus).</p> +<div class="aside aside-see"> + <p class="aside-title">See</p> + SDLAlert, SDLScrollableMessage, SDLSlider, SDLPerformInteraction + +</div> <a href="Classes/SDLCancelInteraction.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLCancelInteraction</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> - -<span class="cm">/** - Convenience init for dismissing the currently presented modal view (either an alert, slider, scrollable message, or perform interation). - - @param functionID The ID of the type of modal view to dismiss - @return A SDLCancelInteraction object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFunctionID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">functionID</span><span class="p">;</span> - -<span class="cm">/** - Convenience init for dismissing a specific view. - - @param functionID The ID of the type of interaction to dismiss - @param cancelID The ID of the specific interaction to dismiss - @return A SDLCancelInteraction object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithFunctionID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">functionID</span> <span class="nf">cancelID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">cancelID</span><span class="p">;</span> - -<span class="cm">/** - Convenience init for dismissing an alert. - - @param cancelID The ID of the specific interaction to dismiss - @return A SDLCancelInteraction object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAlertCancelID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">cancelID</span><span class="p">;</span> - -<span class="cm">/** - Convenience init for dismissing a slider. - - @param cancelID The ID of the specific interaction to dismiss - @return A SDLCancelInteraction object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSliderCancelID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">cancelID</span><span class="p">;</span> - -<span class="cm">/** - Convenience init for dismissing a scrollable message. - - @param cancelID The ID of the specific interaction to dismiss - @return A SDLCancelInteraction object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithScrollableMessageCancelID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">cancelID</span><span class="p">;</span> - -<span class="cm">/** - Convenience init for dismissing a perform interaction. - - @param cancelID The ID of the specific interaction to dismiss - @return A SDLCancelInteraction object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPerformInteractionCancelID</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">cancelID</span><span class="p">;</span> - -<span class="cm">/** - Convenience init for dismissing the currently presented alert. - - @return A SDLCancelInteraction object - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">alert</span><span class="p">;</span> - -<span class="cm">/** - Convenience init for dismissing the currently presented slider. - - @return A SDLCancelInteraction object - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">slider</span><span class="p">;</span> - -<span class="cm">/** - Convenience init for dismissing the currently presented scrollable message. - - @return A SDLCancelInteraction object - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">scrollableMessage</span><span class="p">;</span> - -<span class="cm">/** - Convenience init for dismissing the currently presented perform interaction. - - @return A SDLCancelInteraction object - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">performInteraction</span> <span class="nf">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">performInteraction</span><span class="p">());</span> - -<span class="cm">/** - The ID of the specific interaction to dismiss. If not set, the most recent of the RPC type set in functionID will be dismissed. - - Integer, 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"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">cancelID</span><span class="p">;</span> - -<span class="cm">/** - The ID of the type of interaction to dismiss. - - Only values 10 (PerformInteractionID), 12 (AlertID), 25 (ScrollableMessageID), and 26 (SliderID) are permitted. - - Integer, Required - */</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">functionID</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLCancelInteraction</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> <h4>Swift</h4> @@ -1612,7 +979,7 @@ <p>A choice is an option which a user can select either via the menu or via voice recognition (VR) during an application initiated interaction.</p> -<p>Since SmartDeviceLink 1.0</p> +<p>Since RPC 1.0</p> <a href="Classes/SDLChoice.html" class="slightly-smaller">See more</a> @@ -1631,83 +998,13 @@ SDLChoiceCell </h3> - <p>Undocumented</p> + <p>A selectable item within an SDLChoiceSet</p> <a href="Classes/SDLChoiceCell.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLChoiceCell</span><span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - Maps to Choice.menuName. The primary text of the cell. Duplicates within an `SDLChoiceSet` are not permitted and will result in the `SDLChoiceSet` failing to initialize. - */</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">text</span><span class="p">;</span> - -<span class="cm">/** - Maps to Choice.secondaryText. Optional secondary text of the cell, if available. Duplicates within an `SDLChoiceSet` are permitted. - */</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">NSString</span> <span class="o">*</span><span class="n">secondaryText</span><span class="p">;</span> - -<span class="cm">/** - Maps to Choice.tertiaryText. Optional tertitary text of the cell, if available. Duplicates within an `SDLChoiceSet` are permitted. - */</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">NSString</span> <span class="o">*</span><span class="n">tertiaryText</span><span class="p">;</span> - -<span class="cm">/** - Maps to Choice.vrCommands. Optional voice commands the user can speak to activate the cell. If not set and the head unit requires it, this will be set to the number in the list that this item appears. However, this would be a very poor experience for a user if the choice set is presented as a voice only interaction or both interaction mode. Therefore, consider not setting this only when you know the choice set will be presented as a touch only interaction. - */</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">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">voiceCommands</span><span class="p">;</span> - -<span class="cm">/** - Maps to Choice.image. Optional image for the cell. This will be uploaded before the cell is used when the cell is preloaded or presented for the first time. - */</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/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">artwork</span><span class="p">;</span> - -<span class="cm">/** - Maps to Choice.secondaryImage. Optional secondary image for the cell. This will be uploaded before the cell is used when the cell is preloaded or presented for the first time. - */</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/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">secondaryArtwork</span><span class="p">;</span> - -<span class="cm">/** - Initialize the cell with nothing. This is unavailable - - @return A crash, probably - */</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 the cell with text and nothing else. - - @param text The primary text of the cell. - @return The cell - */</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="p">;</span> - -<span class="cm">/** - Initialize the cell with text, optional artwork, and optional voice commands - - @param text The primary text of the cell - @param artwork The primary artwork of the cell - @param voiceCommands Strings that can be spoken by the user to activate this cell in a voice or both interaction mode - @return The cell - */</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">artwork</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">artwork</span> <span class="nf">voiceCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span><span class="p">;</span> - -<span class="cm">/** - Initialize the cell with all optional items - - @param text The primary text - @param secondaryText The secondary text - @param tertiaryText The tertiary text - @param voiceCommands Strings that can be spoken by the user to activate this cell in a voice or both interaction mode - @param artwork The primary artwork - @param secondaryArtwork The secondary artwork - @return The cell - */</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">secondaryText</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">secondaryText</span> <span class="nf">tertiaryText</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">tertiaryText</span> <span class="nf">voiceCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">artwork</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">artwork</span> <span class="nf">secondaryArtwork</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryArtwork</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLChoiceCell</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -1720,122 +1017,13 @@ SDLChoiceSet </h3> - <p>Undocumented</p> + <p>The choice set to be displayed to the user. Contains a list of selectable options.</p> <a href="Classes/SDLChoiceSet.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLChoiceSet</span><span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - Set this to change the default timeout for all choice sets. If a timeout is not set on an individual choice set object (or if it is set to 0.0), then it will use this timeout instead. See `timeout` for more details. If this is not set by you, it will default to 10 seconds. - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">class</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSTimeInterval</span> <span class="n">defaultTimeout</span><span class="p">;</span> - -<span class="cm">/** - Set this to change the default layout for all choice sets. If a layout is not set on an individual choice set object, then it will use this layout instead. See `layout` for more details. If this is not set by you, it will default to `SDLChoiceSetLayoutList`. - */</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">class</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Enums/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span> <span class="n">defaultLayout</span><span class="p">;</span> - -<span class="cm">/** - Maps to PerformInteraction.initialText. The title of the choice set, and/or the initial text on a keyboard prompt. - */</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">title</span><span class="p">;</span> - -<span class="cm">/** - Maps to PerformInteraction.initialPrompt. The initial prompt spoken to the user at the start of an interaction. - */</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"><a href="Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">initialPrompt</span><span class="p">;</span> - -<span class="cm">/** - Maps to PerformInteraction.interactionLayout. Whether the presented choices are arranged as a set of tiles or a list. - */</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/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span> <span class="n">layout</span><span class="p">;</span> - -<span class="cm">/** - Maps to PerformInteraction.timeout. This applies only to a manual selection (not a voice selection, which has its timeout handled by the system). Defaults to `defaultTimeout`. - */</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">NSTimeInterval</span> <span class="n">timeout</span><span class="p">;</span> - -<span class="cm">/** - Maps to PerformInteraction.timeoutPrompt. This text is spoken when a VR interaction times out. If this set is presented in a manual (non-voice) only interaction, this will be ignored. - */</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"><a href="Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">timeoutPrompt</span><span class="p">;</span> - -<span class="cm">/** - Maps to PerformInteraction.helpPrompt. This is the spoken string when a user speaks "help" when the interaction is occurring. - */</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"><a href="Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">helpPrompt</span><span class="p">;</span> - -<span class="cm">/** - Maps to PerformInteraction.vrHelp. This is a list of help text presented to the user when they are in a voice recognition interaction from your choice set of options. If this set is presented in a touch only interaction, this will be ignored. - - @note that while SDLVRHelpItem's position will be automatically set based on position in the array, the image will need to uploaded by you before use using SDLFileManager. - */</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"><a href="Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">helpList</span><span class="p">;</span> - -<span class="cm">/** - The delegate of this choice set, called when the user interacts with it. - */</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">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLChoiceSetDelegate.html">SDLChoiceSetDelegate</a></span><span class="o">></span> <span class="n">delegate</span><span class="p">;</span> - -<span class="cm">/** - The choices to be displayed to the user within this choice set. These choices could match those already preloaded via `SDLScreenManager preloadChoices:withCompletionHandler:`. - - This is limited to 100 items. If you attempt to set more than 100 items, the set will not have any items (this array will be empty). - */</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/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">choices</span><span class="p">;</span> - -<span class="cm">/** - Initialize with a title, delegate, and choices. It will use the default timeout and layout, all other properties (such as prompts) will be `nil`. - - @param title The choice set's title - @param delegate The choice set delegate called after the user has interacted with your choice set - @param choices The choices to be displayed to the user for interaction - @return The choice set - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">delegate</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLChoiceSetDelegate.html">SDLChoiceSetDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span> <span class="nf">choices</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">choices</span><span class="p">;</span> - -<span class="cm">/** - Initializer with all possible properties. - - @param title The choice set's title - @param delegate The choice set delegate called after the user has interacted with your choice set - @param layout The layout of choice options (Manual/touch only) - @param timeout The timeout of a touch interaction (Manual/touch only) - @param initialPrompt A voice prompt spoken to the user when this set is displayed - @param timeoutPrompt A voice prompt spoken to the user when the set times out (Voice only) - @param helpPrompt A voice prompt spoken to the user when the user asks for "help" - @param helpList A table list of text and images shown to the user during a voice recognition session for this choice set (Voice only) - @param choices The list of choices presented to the user either as a manual/touch interaction or via the user's voice - @return The choice set - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">delegate</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLChoiceSetDelegate.html">SDLChoiceSetDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span> <span class="nf">layout</span><span class="p">:(</span><span class="n"><a href="Enums/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span><span class="p">)</span><span class="nv">layout</span> <span class="nf">timeout</span><span class="p">:(</span><span class="n">NSTimeInterval</span><span class="p">)</span><span class="nv">timeout</span> <span class="nf">initialPromptString</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">initialPrompt</span> <span class="nf">timeoutPromptString</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">timeoutPrompt</span> <span class="nf">helpPromptString</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">helpPrompt</span> <span class="nf">vrHelpList</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">helpList</span> <span class="nf">choices</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">choices</span><span class="p">;</span> - -<span class="cm">/** - Initializer with all possible properties. - - @param title The choice set's title - @param delegate The choice set delegate called after the user has interacted with your choice set - @param layout The layout of choice options (Manual/touch only) - @param timeout The timeout of a touch interaction (Manual/touch only) - @param initialPrompt A voice prompt spoken to the user when this set is displayed - @param timeoutPrompt A voice prompt spoken to the user when the set times out (Voice only) - @param helpPrompt A voice prompt spoken to the user when the user asks for "help" - @param helpList A table list of text and images shown to the user during a voice recognition session for this choice set (Voice only) - @param choices The list of choices presented to the user either as a manual/touch interaction or via the user's voice - @return The choice set - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">delegate</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLChoiceSetDelegate.html">SDLChoiceSetDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span> <span class="nf">layout</span><span class="p">:(</span><span class="n"><a href="Enums/SDLChoiceSetLayout.html">SDLChoiceSetLayout</a></span><span class="p">)</span><span class="nv">layout</span> <span class="nf">timeout</span><span class="p">:(</span><span class="n">NSTimeInterval</span><span class="p">)</span><span class="nv">timeout</span> <span class="nf">initialPrompt</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">initialPrompt</span> <span class="nf">timeoutPrompt</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">timeoutPrompt</span> <span class="nf">helpPrompt</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">helpPrompt</span> <span class="nf">vrHelpList</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLVRHelpItem.html">SDLVRHelpItem</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">helpList</span> <span class="nf">choices</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">choices</span><span class="p">;</span> - - -<span class="cm">/** - Cancels the choice set. If the choice set has not yet been sent to Core, it will not be sent. If the choice set is already presented on Core, the choice set will be immediately dismissed. Canceling an already presented choice set will only work if connected to Core versions 6.0+. On older versions of Core, the choice set will not be dismissed. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">cancel</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLChoiceSet</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -1922,86 +1110,13 @@ SDLCloudAppProperties </h3> - <p>Undocumented</p> + <p>The cloud application properties.</p> <a href="Classes/SDLCloudAppProperties.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLCloudAppProperties</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init for required parameters. - * - * @param appID The id of the cloud app - * @return A SDLCloudAppProperties object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppID</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="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> - -<span class="cm">/** - * Convenience init for all parameters. - * - * @param appID The id of the cloud app - * @param nicknames An array of app names a cloud app is allowed to register with - * @param enabled If true, the cloud app will appear in the HMI's app list; if false, the cloud app will not appear in the HMI's app list - * @param authToken Used to authenticate websocket connection on app activation - * @param cloudTransportType Specifies the connection type Core should use - * @param hybridAppPreference Specifies the user preference to use the cloud app version or mobile app version when both are available - * @param endpoint The websocket endpoint - * @return A SDLCloudAppProperties object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppID</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">appID</span> <span class="nf">nicknames</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">nicknames</span> <span class="nf">enabled</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">enabled</span> <span class="nf">authToken</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">authToken</span> <span class="nf">cloudTransportType</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">cloudTransportType</span> <span class="nf">hybridAppPreference</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLHybridAppPreference.h@T@SDLHybridAppPreference">SDLHybridAppPreference</a></span><span class="p">)</span><span class="nv">hybridAppPreference</span> <span class="nf">endpoint</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">endpoint</span><span class="p">;</span> - -<span class="cm">/** - * An array of app names a cloud app is allowed to register with. If included in a `SetCloudAppProperties` request, this value will overwrite the existing "nicknames" field in the app policies section of the policy table. - * - * Array of Strings, Optional, String length: minlength="0" maxlength="100", Array size: minsize="0" maxsize="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">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">nicknames</span><span class="p">;</span> - -<span class="cm">/** - * The id of the cloud app. - * - * String, Required, maxlength="100" - */</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">appID</span><span class="p">;</span> - -<span class="cm">/** - * If true, the cloud app will appear in the HMI's app list; if false, the cloud app will not appear in the HMI's app list. - * - * 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"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">enabled</span><span class="p">;</span> - -<span class="cm">/** - * Used to authenticate websocket connection on app activation. - * - * String, Optional, maxlength="65535" - */</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">authToken</span><span class="p">;</span> - -<span class="cm">/** - * Specifies the connection type Core should use. Currently the ones that work in SDL Core are `WS` or `WSS`, but an OEM can implement their own transport adapter to handle different values. - * - * String, Optional, maxlength="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">NSString</span> <span class="o">*</span><span class="n">cloudTransportType</span><span class="p">;</span> - -<span class="cm">/** - * Specifies the user preference to use the cloud app version or mobile app version when both are available. - * - * SDLHybridAppPreference, 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%20Definitions.html#/c:SDLHybridAppPreference.h@T@SDLHybridAppPreference">SDLHybridAppPreference</a></span> <span class="n">hybridAppPreference</span><span class="p">;</span> - -<span class="cm">/** - * The websocket endpoint. - * - * String, Optional, maxlength="65535" - */</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">endpoint</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLCloudAppProperties</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -2033,158 +1148,13 @@ SDLConfiguration </h3> - <p>Undocumented</p> + <p>Contains information about the app’s configurtion, such as lifecycle, lockscreen, encryption, etc.</p> <a href="Classes/SDLConfiguration.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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 streaming media 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">/** - * The file manager 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/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="n">fileManagerConfig</span><span class="p">;</span> - -<span class="cm">/** - * The encryption 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/SDLEncryptionConfiguration.html">SDLEncryptionConfiguration</a></span> <span class="o">*</span><span class="n">encryptionConfig</span><span class="p">;</span> - -<span class="cm">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen and logging configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will 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="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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithLifecycle:lockScreen:logging:fileManager: instead"</span><span class="p">);</span> - -<span class="cm">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging and file manager configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will be used. - * @param fileManagerConfig The file manager 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="nf">fileManager</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithLifecycle:lockScreen:logging:fileManager:encryption: instead"</span><span class="p">);</span> - -<span class="cm">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging, file manager and encryption configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will be used. - * @param fileManagerConfig The file manager configuration to be used or `defaultConfiguration` if nil. - * @param encryptionConfig The encryption configuration to be used. If nil, the `defaultConfiguration` will 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="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">fileManager</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</span> <span class="nf">encryption</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLEncryptionConfiguration.html">SDLEncryptionConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">encryptionConfig</span><span class="p">;</span> - -<span class="cm">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen and logging configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will 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="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">__deprecated_msg</span><span class="p">(</span><span class="s">"Use configurationWithLifecycle:lockScreen:logging:fileManager: instead"</span><span class="p">)</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">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging and file manager configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will be used. - * @param fileManagerConfig The file manager 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="nf">fileManager</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</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">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging and streaming media configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will be used. - * @param streamingMediaConfig The streaming media configuration to be used or nil if not used. - * @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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithLifecycle:lockScreen:logging:streamingMedia:fileManager: instead"</span><span class="p">);</span> - -<span class="cm">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging, streaming media and file manager configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will be used. - * @param streamingMediaConfig The streaming media configuration to be used or nil if not used. - * @param fileManagerConfig The file manager 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="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="nf">fileManager</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithLifecycle:lockScreen:logging:streamingMedia:fileManager:encryption: instead"</span><span class="p">);</span> - -<span class="cm">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging, streaming media, file manager and encryption configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will be used. - * @param streamingMediaConfig The streaming media configuration to be used or nil if not used. - * @param fileManagerConfig The file manager configuration to be used or `defaultConfiguration` if nil. - * @param encryptionConfig The encryption configuration to be used. If nil, the `defaultConfiguration` will 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="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="nf">fileManager</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</span> <span class="nf">encryption</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLEncryptionConfiguration.html">SDLEncryptionConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">encryptionConfig</span><span class="p">;</span> - -<span class="cm">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging and streaming media configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will be used. - * @param streamingMediaConfig The streaming media configuration to be used or nil if not used. - * @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">__deprecated_msg</span><span class="p">(</span><span class="s">"Use configurationWithLifecycle:lockScreen:logging:streamingMedia:fileManager: instead"</span><span class="p">)</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">/** - * Creates a new configuration to be passed to the SDLManager with custom lifecycle, lock screen, logging, streaming media and file manager configurations. - * - * @param lifecycleConfig The lifecycle configuration to be used. - * @param lockScreenConfig The lockscreen configuration to be used. If nil, the `enabledConfiguration` will be used. - * @param logConfig The logging configuration to be used. If nil, the `defaultConfiguration` will be used. - * @param streamingMediaConfig The streaming media configuration to be used or nil if not used. - * @param fileManagerConfig The file manager 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="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="nf">fileManager</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLFileManagerConfiguration.html">SDLFileManagerConfiguration</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManagerConfig</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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -2271,14 +1241,14 @@ SDLCreateWindowResponse </h3> - <p>Undocumented</p> + <p>Response to SDLCreateWindow</p> + +<p>@since RPC 6.0</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLCreateWindowResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLCreateWindowResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -2541,14 +1511,14 @@ SDLDeleteWindowResponse </h3> - <p>Undocumented</p> + <p>Response to DeleteWindow</p> + +<p>@since RPC 6.0</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLDeleteWindowResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLDeleteWindowResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -2764,24 +1734,15 @@ SDLEncodedSyncPData </h3> - <p>Undocumented</p> + <p>Allows encoded data in the form of SyncP packets to be sent to the SYNC module. Legacy / v1 Protocol implementation; use SyncPData instead.</p> + +<p>*** DEPRECATED ***</p> <a href="Classes/SDLEncodedSyncPData.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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="cm">/** - * Contains base64 encoded string of SyncP packets. - * - * Required, Array length 1 - 100, String length 1 - 1,000,000 - * - * @see SDLTTSChunk - */</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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -2814,41 +1775,13 @@ SDLEncryptionConfiguration </h3> - <p>Undocumented</p> + <p>The encryption configuration data</p> <a href="Classes/SDLEncryptionConfiguration.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLEncryptionConfiguration</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">/** - * A set of security managers used to encrypt traffic data. Each OEM has their own proprietary security manager. - */</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">/** - * A delegate callback that will tell you when an acknowledgement has occurred for starting as secure service. - */</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">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLServiceEncryptionDelegate.html">SDLServiceEncryptionDelegate</a></span><span class="o">></span> <span class="n">delegate</span><span class="p">;</span> - -<span class="cm">/** - * Creates a default encryption configuration. - * - * @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">/** - Creates a secure configuration for each of the security managers provided. - - @param securityManagers The security managers to be used. - @param delegate The delegate callback. - @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">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/SDLServiceEncryptionDelegate.html">SDLServiceEncryptionDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLEncryptionConfiguration</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span></code></pre> <h4>Swift</h4> @@ -2927,147 +1860,13 @@ see SDLPerformAudioPassThru</p> SDLFile </h3> - <p>Undocumented</p> + <p>Crates an SDLFile from a file</p> <a href="Classes/SDLFile.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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%20Definitions.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="cm">/** - Describes whether or not this file is represented by static icon data. The head unit will present its representation of the static icon concept when sent this data. - - A file that represents a static icon may not be uploaded via the File Manager. It must be set using the Screen Manager. - - Support for this feature may vary by system, but it will generally be more supported in soft buttons and menus. - */</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">isStaticIcon</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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -3099,48 +1898,13 @@ see SDLPerformAudioPassThru</p> SDLFileManagerConfiguration </h3> - <p>Undocumented</p> + <p>File manager configuration information</p> <a href="Classes/SDLFileManagerConfiguration.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLFileManagerConfiguration</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">/** - * Defines the number of times the file manager will attempt to reupload `SDLArtwork` files in the event of a failed upload to Core. - * - * Defaults to 1. To disable reuploads, set to 0. - */</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">artworkRetryCount</span><span class="p">;</span> - -<span class="cm">/** - * Defines the number of times the file manager will attempt to reupload general `SDLFile`s in the event of a failed upload to Core. - * - * Defaults to 1. To disable reuploads, set to 0. - */</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">fileRetryCount</span><span class="p">;</span> - -<span class="cm">/** - * Creates a default file manager configuration. - * - * @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">/** - Use `defaultConfiguration` instead - */</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">/** - * Creates a file manager configuration with customized upload retry counts. - * - * @return The configuration - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithArtworkRetryCount</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">artworkRetryCount</span> <span class="nf">fileRetryCount</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">fileRetryCount</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLFileManagerConfiguration</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span></code></pre> <h4>Swift</h4> @@ -3172,20 +1936,13 @@ see SDLPerformAudioPassThru</p> SDLFunctionID </h3> - <p>Undocumented</p> + <p>A function ID for an SDL RPC</p> <a href="Classes/SDLFunctionID.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLFunctionID</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">sharedInstance</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLRPCFunctionNames.h@T@SDLRPCFunctionName">SDLRPCFunctionName</a></span><span class="p">)</span><span class="nf">functionNameForId</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">functionID</span><span class="p">;</span> -<span class="k">-</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="nf">functionIdForName</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLRPCFunctionNames.h@T@SDLRPCFunctionName">SDLRPCFunctionName</a></span><span class="p">)</span><span class="nv">functionName</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLFunctionID</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -3256,30 +2013,13 @@ see SDLPerformAudioPassThru</p> SDLGetAppServiceDataResponse </h3> - <p>Undocumented</p> + <p>This response includes the data that was requested from the specific service.</p> <a href="Classes/SDLGetAppServiceDataResponse.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetAppServiceDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="cm">/** - * Convenience init. - * - * @param serviceData Contains all the current data of the app service - * @return A SDLGetAppServiceDataResponse object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppServiceData</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAppServiceData.html">SDLAppServiceData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceData</span><span class="p">;</span> - -<span class="cm">/** - * Contains all the current data of the app service. - * - * SDLAppServiceData, 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/SDLAppServiceData.html">SDLAppServiceData</a></span> <span class="o">*</span><span class="n">serviceData</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetAppServiceDataResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -3395,54 +2135,15 @@ Function Group: ProprietaryData SDLGetFileResponse </h3> - <p>Undocumented</p> + <p>Response to GetFiles</p> + +<p>@since RPC 5.1</p> <a href="Classes/SDLGetFileResponse.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetFileResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="cm">/** - * Convenience init for all parameters. - * - * @param offset Optional offset in bytes for resuming partial data chunks - * @param length Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded - * @param fileType File type that is being sent in response - * @param crc Additional CRC32 checksum to protect data integrity up to 512 Mbits - * @return A SDLGetFileResponse object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithOffset</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">offset</span> <span class="nf">length</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">length</span> <span class="nf">fileType</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span><span class="p">)</span><span class="nv">fileType</span> <span class="nf">crc</span><span class="p">:(</span><span class="n">UInt32</span><span class="p">)</span><span class="nv">crc</span><span class="p">;</span> - -<span class="cm">/** - * Optional offset in bytes for resuming partial data chunks. - * - * Integer, Optional, minvalue="0" maxvalue="2000000000" - */</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="cm">/** - * Optional length in bytes for resuming partial data chunks. If offset is set to 0, then length is the total length of the file to be downloaded. - * - * Integer, Optional, minvalue="0" maxvalue="2000000000" - */</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="cm">/** - * File type that is being sent in response. - * - * SDLFileType, 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%20Definitions.html#/c:SDLFileType.h@T@SDLFileType">SDLFileType</a></span> <span class="n">fileType</span><span class="p">;</span> - -<span class="cm">/** - * Additional CRC32 checksum to protect data integrity up to 512 Mbits. - * - * Integer, Optional, minvalue="0" maxvalue="4294967295" - */</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">crc</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetFileResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -3478,31 +2179,15 @@ whenever new data is available for the module.</p> SDLGetInteriorVehicleDataConsent </h3> - <p>Undocumented</p> + <p>This RPC allows you to get consent to control a certian module</p> + +<p>@since RPC 6.0</p> <a href="Classes/SDLGetInteriorVehicleDataConsent.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetInteriorVehicleDataConsent</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">initWithModuleType</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span><span class="p">)</span><span class="nv">moduleType</span> <span class="nf">moduleIds</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleIds</span><span class="p">;</span> - -<span class="cm">/** - * The module type that the app requests to control. - * - * Required - */</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%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="n">moduleType</span><span class="p">;</span> - -<span class="cm">/** - * Ids of a module of same type, published by System Capability. - * - * Required - */</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">moduleIds</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetInteriorVehicleDataConsent</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> <h4>Swift</h4> @@ -3515,24 +2200,15 @@ whenever new data is available for the module.</p> SDLGetInteriorVehicleDataConsentResponse </h3> - <p>Undocumented</p> + <p>Response to GetInteriorVehicleDataConsent</p> + +<p>@since RPC 6.0</p> <a href="Classes/SDLGetInteriorVehicleDataConsentResponse.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetInteriorVehicleDataConsentResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="cm">/** - This array has the same size as "moduleIds" in the request; each element corresponding to one moduleId - "true" - if SDL grants the permission for the requested module - "false" - SDL denies the permission for the requested module. - - Optional - */</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">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)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*></span> <span class="o">*</span><span class="n">allowed</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLGetInteriorVehicleDataConsentResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -3564,46 +2240,15 @@ whenever new data is available for the module.</p> SDLGetSystemCapability </h3> - <p>Undocumented</p> + <p>SDL RPC Request for expanded information about a supported system/HMI capability</p> + +<p>@since SDL 4.5</p> <a href="Classes/SDLGetSystemCapability.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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="cm">/** - * Convenience init - * - * @param type The type of system capability - * @return A SDLSystemCapabilityType object - */</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%20Definitions.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">/** - * Convenience init - * - * @param type The type of system capability - * @param subscribe Whether or not to subscribe to updates of the supplied service capability type - * @return A SDLSystemCapabilityType object - */</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%20Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span><span class="p">)</span><span class="nv">type</span> <span class="nf">subscribe</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">subscribe</span><span class="p">;</span> - -<span class="cm">/** - * The type of system capability to get more information on - * - * SDLSystemCapabilityType, Required - */</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%20Definitions.html#/c:SDLSystemCapabilityType.h@T@SDLSystemCapabilityType">SDLSystemCapabilityType</a></span> <span class="n">systemCapabilityType</span><span class="p">;</span> - -<span class="cm">/** - * Flag to subscribe to updates of the supplied service capability type. If true, the requester will be subscribed. If false, the requester will not be subscribed and be removed as a subscriber if it was previously subscribed. - * - * 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"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">subscribe</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -3680,25 +2325,15 @@ whenever new data is available for the module.</p> SDLGetWayPoints </h3> - <p>Undocumented</p> + <p>This RPC allows you to get navigation waypoint data</p> + +<p>@since RPC 4.1</p> <a href="Classes/SDLGetWayPoints.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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%20Definitions.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%20Definitions.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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -3791,95 +2426,15 @@ whenever new data is available for the module.</p> SDLHMISettingsControlCapabilities </h3> - <p>Undocumented</p> + <p>HMI data struct for HMI control settings</p> + +<p>@since 5.0</p> <a href="Classes/SDLHMISettingsControlCapabilities.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLHMISettingsControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - Constructs a newly allocated SDLHMISettingsControlCapabilities object with moduleName - - @param moduleName The short friendly name of the hmi setting module - - @return An instance of the SDLHMISettingsControlCapabilities class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleName</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithModuleName:moduleInfo:"</span><span class="p">);</span> - -<span class="cm">/** - Constructs a newly allocated SDLHMISettingsControlCapabilities object with moduleName - - @param moduleName The short friendly name of the hmi setting module - @param moduleInfo Information about a RC module, including its id. - - @return An instance of the SDLHMISettingsControlCapabilities class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleName</span> <span class="nf">moduleInfo</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleInfo</span><span class="p">;</span> - -<span class="cm">/** - Constructs a newly allocated SDLHMISettingsControlCapabilities object with given parameters - - @param moduleName The short friendly name of the hmi setting module - @param distanceUnitAvailable Availability of the control of distance unit. - @param temperatureUnitAvailable Availability of the control of temperature unit. - @param displayModeUnitAvailable Availability of the control of displayMode unit. - - @return An instance of the SDLHMISettingsControlCapabilities class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleName</span> <span class="nf">distanceUnitAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">distanceUnitAvailable</span> <span class="nf">temperatureUnitAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">temperatureUnitAvailable</span> <span class="nf">displayModeUnitAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">displayModeUnitAvailable</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithModuleName:moduleInfo:distanceUnitAvailable:distanceUnitAvailable:temperatureUnitAvailable:displayModeUnitAvailable:"</span><span class="p">);</span> - -<span class="cm">/** - Constructs a newly allocated SDLHMISettingsControlCapabilities object with given parameters - - @param moduleName The short friendly name of the hmi setting module. - @param moduleInfo Information about a RC module, including its id. - @param distanceUnitAvailable Availability of the control of distance unit. - @param temperatureUnitAvailable Availability of the control of temperature unit. - @param displayModeUnitAvailable Availability of the control of displayMode unit. - - @return An instance of the SDLHMISettingsControlCapabilities class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleName</span> <span class="nf">moduleInfo</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleInfo</span> <span class="nf">distanceUnitAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">distanceUnitAvailable</span> <span class="nf">temperatureUnitAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">temperatureUnitAvailable</span> <span class="nf">displayModeUnitAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">displayModeUnitAvailable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract The short friendly name of the hmi setting module. - * It should not be used to identify a module by mobile application. - * - * Required, Max String length 100 chars - */</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">moduleName</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Availability of the control of distance unit. - * - * 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">distanceUnitAvailable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Availability of the control of temperature unit. - * - * 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">temperatureUnitAvailable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Availability of the control of HMI display mode. - * - * 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">displayModeUnitAvailable</span><span class="p">;</span> - -<span class="cm">/** - * Information about a RC module, including its id. - * - * 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/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="n">moduleInfo</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLHMISettingsControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -3892,7 +2447,7 @@ whenever new data is available for the module.</p> SDLHMISettingsControlData </h3> - <p>Corresponds to <q>HMI_SETTINGS</q> ModuleType</p> + <p>Corresponds to “HMI_SETTINGS” ModuleType</p> <a href="Classes/SDLHMISettingsControlData.html" class="slightly-smaller">See more</a> @@ -4066,64 +2621,15 @@ cases the language of the head unit changes or does not match the app language.< SDLLightCapabilities </h3> - <p>Undocumented</p> + <p>Current Light capabilities.</p> + +<p>@since RPC 5.0</p> <a href="Classes/SDLLightCapabilities.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLightCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - Constructs a newly allocated SDLLightCapabilities object with the name of the light or group of lights - - @param name The name of a light or a group of lights - @return An instance of the SDLLightCapabilities class - */</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"><a href="Type%20Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span><span class="p">)</span><span class="nv">name</span><span class="p">;</span> - -<span class="cm">/** - Constructs a newly allocated SDLLightCapabilities object with given parameters - - @param name The name of a light or a group of lights - @param densityAvailable light's density can be set remotely - @param colorAvailable Light's color can be set remotely by using the RGB color space - @param statusAvailable whether status is available - - @return An instance of the SDLLightCapabilities class - */</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"><a href="Type%20Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span><span class="p">)</span><span class="nv">name</span> <span class="nf">densityAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">densityAvailable</span> <span class="nf">colorAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">colorAvailable</span> <span class="nf">statusAvailable</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">statusAvailable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract The name of a light or a group of lights - * - * Required, SDLLightName - */</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%20Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span> <span class="n">name</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Indicates if the light's density can be set remotely (similar to a dimmer). - * - * 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">densityAvailable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Indicates if the light's color can be set remotely by using the RGB color space. - * - * 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">colorAvailable</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Indicates if the status (ON/OFF) can be set remotely. - * App shall not use read-only values (RAMP_UP/RAMP_DOWN/UNKNOWN/INVALID) in a setInteriorVehicleData request. - * - * 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">statusAvailable</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLightCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -4136,58 +2642,15 @@ cases the language of the head unit changes or does not match the app language.< SDLLightControlCapabilities </h3> - <p>Undocumented</p> + <p>Current light control capabilities.</p> + +<p>@since RPC 5.0</p> <a href="Classes/SDLLightControlCapabilities.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLightControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - Constructs a newly allocated SDLLightControlCapabilities object with given parameters - - - @param moduleName friendly name of the light control module - @param supportedLights array of available LightCapabilities - @return An instance of the SDLLightControlCapabilities class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleName</span> <span class="nf">supportedLights</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLLightCapabilities.html">SDLLightCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">supportedLights</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithModuleName:moduleInfo:supportedLights:"</span><span class="p">);</span> - -<span class="cm">/** - Constructs a newly allocated SDLLightControlCapabilities object with given parameters - - - @param moduleName friendly name of the light control module - @param moduleInfo information about a RC module, including its id - @param supportedLights array of available LightCapabilities - @return An instance of the SDLLightControlCapabilities class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithModuleName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleName</span> <span class="nf">moduleInfo</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleInfo</span> <span class="nf">supportedLights</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLLightCapabilities.html">SDLLightCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">supportedLights</span><span class="p">;</span> - -<span class="cm">/** - * @abstract The short friendly name of the light control module. - * It should not be used to identify a module by mobile application. - * - * Required, Max String length 100 chars - */</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">moduleName</span><span class="p">;</span> - -<span class="cm">/** - * @abstract An array of available LightCapabilities that are controllable. - * - * Required, NSArray of type SDLLightCapabilities minsize="1" maxsize="100" - */</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/SDLLightCapabilities.html">SDLLightCapabilities</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">supportedLights</span><span class="p">;</span> - -<span class="cm">/** - * Information about a RC module, including its id. - * - * 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/SDLModuleInfo.html">SDLModuleInfo</a></span> <span class="o">*</span><span class="n">moduleInfo</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLightControlCapabilities</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -4200,31 +2663,15 @@ cases the language of the head unit changes or does not match the app language.< SDLLightControlData </h3> - <p>Undocumented</p> + <p>Data about the current light controls</p> + +<p>@since SDL 5.0</p> <a href="Classes/SDLLightControlData.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLightControlData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - Constructs a newly allocated SDLLightControlData object with lightState - - @param lightState An array of LightNames and their current or desired status - @return An instance of the SDLLightControlData class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLightStates</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLLightState.html">SDLLightState</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">lightState</span><span class="p">;</span> - -<span class="cm">/** - * @abstract An array of LightNames and their current or desired status. - * Status of the LightNames that are not listed in the array shall remain unchanged. - * - * Required, NSArray of type SDLLightState minsize="1" maxsize="100" - */</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/SDLLightState.html">SDLLightState</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">lightState</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLightControlData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -4237,74 +2684,15 @@ cases the language of the head unit changes or does not match the app language.< SDLLightState </h3> - <p>Undocumented</p> + <p>Current light control state</p> + +<p>@since RPC 5.0</p> <a href="Classes/SDLLightState.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLightState</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - Constructs a newly allocated SDLLightState object with given parameters - - @param id The name of a light or a group of lights - @param status Reflects the status of Light. - @return An instance of the SDLLightState class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span><span class="p">)</span><span class="nv">id</span> <span class="nf">status</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLLightStatus.h@T@SDLLightStatus">SDLLightStatus</a></span><span class="p">)</span><span class="nv">status</span><span class="p">;</span> - -<span class="cm">/** - Constructs a newly allocated SDLLightState object with given parameters - - @param id The name of a light or a group of lights - @param status Reflects the status of Light. - @param density Reflects the density of Light. - @param color Reflects the color of Light. - @return An instance of the SDLLightState class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span><span class="p">)</span><span class="nv">id</span> <span class="nf">status</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLLightStatus.h@T@SDLLightStatus">SDLLightStatus</a></span><span class="p">)</span><span class="nv">status</span> <span class="nf">density</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">density</span> <span class="nf">color</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">color</span><span class="p">;</span> - -<span class="cm">/** - Constructs a newly allocated SDLLightState object with given parameters - - @param id The name of a light or a group of lights - @param lightStatus Reflects the status of Light. - @param lightDensity Reflects the density of Light. - @param lightColor Reflects the color of Light. - @return An instance of the SDLLightState class - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithId</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span><span class="p">)</span><span class="nv">id</span> <span class="nf">lightStatus</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLLightStatus.h@T@SDLLightStatus">SDLLightStatus</a></span><span class="p">)</span><span class="nv">lightStatus</span> <span class="nf">lightDensity</span><span class="p">:(</span><span class="kt">double</span><span class="p">)</span><span class="nv">lightDensity</span> <span class="nf">lightColor</span><span class="p">:(</span><span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">lightColor</span><span class="p">;</span> - -<span class="cm">/** - * @abstract The name of a light or a group of lights - * - * Required, SDLLightName - */</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%20Definitions.html#/c:SDLLightName.h@T@SDLLightName">SDLLightName</a></span> <span class="n">id</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Reflects the status of Light. - * - * Required, SDLLightStatus - */</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%20Definitions.html#/c:SDLLightStatus.h@T@SDLLightStatus">SDLLightStatus</a></span> <span class="n">status</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Reflects the density of Light. - * - * Optional, Float type with minValue: 0 maxValue:1 - */</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">density</span><span class="p">;</span> - -<span class="cm">/** - * @abstract Reflects the color of Light. - * - * Optional, SDLLightStatus - */</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/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="n">color</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLightState</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -4417,47 +2805,13 @@ cases the language of the head unit changes or does not match the app language.< SDLLockScreenViewController </h3> - <p>Undocumented</p> + <p>The view controller for the lockscreen.</p> <a href="Classes/SDLLockScreenViewController.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLockScreenViewController</span> <span class="p">:</span> <span class="nc">UIViewController</span> - -<span class="k">typedef</span> <span class="nf">void</span> <span class="p">(</span><span class="o">^</span><span class="n"><a href="Type%20Definitions.html#/c:SDLLockScreenViewController.h@T@SwipeGestureCallbackBlock">SwipeGestureCallbackBlock</a></span><span class="p">)(</span><span class="kt">void</span><span class="p">);</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="cm">/** - * The locked label string. This will be set by the lock screen manager to inform the user about the dismissable state. - */</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">NSString</span> <span class="o">*</span><span class="n">lockedLabelText</span><span class="p">;</span> - -<span class="cm">/** - * Adds a swipe gesture to the lock screen view controller. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addDismissGestureWithCallback</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLLockScreenViewController.h@T@SwipeGestureCallbackBlock">SwipeGestureCallbackBlock</a></span><span class="p">)</span><span class="nv">swipeGestureCallback</span><span class="p">;</span> - -<span class="cm">/** - * Remove swipe gesture to the lock screen view controller. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">removeDismissGesture</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLockScreenViewController</span> <span class="p">:</span> <span class="nc">UIViewController</span></code></pre> <h4>Swift</h4> @@ -4470,71 +2824,13 @@ cases the language of the head unit changes or does not match the app language.< SDLLogConfiguration </h3> - <p>Undocumented</p> + <p>Information about the current logging configuration</p> <a href="Classes/SDLLogConfiguration.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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">/** - Whether or not assert logs will fire assertions in DEBUG mode. Assertions are always disabled in RELEASE builds. If assertions are disabled, only an error log will fire instead. 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">areAssertionsDisabled</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">disableAssertions</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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -4547,73 +2843,13 @@ cases the language of the head unit changes or does not match the app language.< SDLLogFileModule </h3> - <p>Undocumented</p> + <p>A log file module is a collection of source code files that form a cohesive unit and that logs can all use to describe themselves. E.g. a “transport” module, or a “Screen Manager” module.</p> <a href="Classes/SDLLogFileModule.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLogFileModule</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -4626,93 +2862,13 @@ cases the language of the head unit changes or does not match the app language.< SDLLogFilter </h3> - <p>Undocumented</p> + <p>Represents a filter over which SDL logs should be logged</p> <a href="Classes/SDLLogFilter.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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%20Definitions.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%20Definitions.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> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLLogFilter</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -4800,203 +2956,13 @@ cases the language of the head unit changes or does not match the app language.< SDLManager </h3> - <p>Undocumented</p> + <p>The top level manager object for all of SDL’s interactions with the app and the head unit</p> <a href="Classes/SDLManager.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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">nullable</span><span class="p">)</span> <span class="n"><a href="Type%20Definitions.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%20Definitions.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%20Definitions.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 screen manager for sending UI related RPCs. - */</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/SDLScreenManager.html">SDLScreenManager</a></span> <span class="o">*</span><span class="n">screenManager</span><span class="p">;</span> - -<span class="cm">/** - * Centralized manager for retrieving all system capabilities. - */</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/SDLSystemCapabilityManager.html">SDLSystemCapabilityManager</a></span> <span class="o">*</span><span class="n">systemCapabilityManager</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 auth token, if received. This should be used to log into a user account. Primarily used for cloud apps with companion app stores. - */</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">NSString</span> <span class="o">*</span><span class="n">authToken</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">/** - The currently pending RPC request send transactions - */</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">NSArray</span><span class="o"><</span><span class="n">__kindof</span> <span class="n">NSOperation</span> <span class="o">*></span> <span class="o">*</span><span class="n">pendingRPCTransactions</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">SDLProxy</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%20Definitions.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="cm">/** - * Start the encryption lifecycle manager, which will attempt to open a secure service. - * - * Please call this method in the successful callback of startWithReadyHandler. If you do call this method, you must wait for SDLServiceEncryptionDelegate's serviceEncryptionUpdatedOnService delegate method before you send any encrypted RPCs. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">startRPCEncryption</span><span class="p">;</span> - -<span class="cp">#pragma mark Manually Send RPC Requests -</span> -<span class="cm">/** - * Send an RPC of type `Response`, `Notification` or `Request`. Responses and notifications sent to Core do not a response back from Core. Each request sent to Core does get a response, so if you need the response and/or error, call `sendRequest:withResponseHandler:` instead. - * - * @param rpc An RPC of type `SDLRPCResponse`, `SDLRPCNotification` or `SDLRPCRequest` - */</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">__kindof</span> <span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">rpc</span><span class="p">;</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%20Definitions.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="cm">/** - Send all of the requests given as quickly as possible, but in order. Call the completionHandler after all requests have either failed or given a response. - - @param requests The requests to be sent - @param progressHandler A handler called every time a response is received - @param completionHandler A handler to call when all requests have been responded to - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendRequests</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">requests</span> <span class="nf">progressHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleAsyncRequestProgressHandler">SDLMultipleAsyncRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span><span class="p">;</span> - -<span class="cm">/** - Send all of the requests one at a time, with the next one going out only after the previous one has received a response. Call the completionHandler after all requests have either failed or given a response. - - @param requests The requests to be sent - @param progressHandler A handler called every time a response is received. Return NO to cancel any requests that have not yet been sent, YES to continue sending requests. - @param completionHandler A handler to call when all requests have been responded to - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">sendSequentialRequests</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">requests</span> <span class="nf">progressHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleSequentialRequestProgressHandler">SDLMultipleSequentialRequestProgressHandler</a></span><span class="p">)</span><span class="nv">progressHandler</span> <span class="nf">completionHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLMultipleRequestCompletionHandler">SDLMultipleRequestCompletionHandler</a></span><span class="p">)</span><span class="nv">completionHandler</span> <span class="n">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">sendSequential</span><span class="p">(</span><span class="n">requests</span><span class="o">:</span><span class="n">progressHandler</span><span class="o">:</span><span class="n">completionHandler</span><span class="o">:</span><span class="p">));</span> - - -<span class="cp">#pragma mark - RPC Subscriptions -</span> -<span class="k">typedef</span> <span class="nf">void</span> <span class="p">(</span><span class="o">^</span><span class="n"><a href="Type%20Definitions.html#/c:SDLManager.h@T@SDLRPCUpdatedBlock">SDLRPCUpdatedBlock</a></span><span class="p">)</span> <span class="p">(</span><span class="n">__kindof</span> <span class="n"><a href="Classes/SDLRPCMessage.html">SDLRPCMessage</a></span> <span class="o">*</span><span class="n">message</span><span class="p">);</span> - -<span class="cm">/** - * Subscribe to callbacks about a particular RPC request, notification, or response with a block callback. - * - * @param rpcName The name of the RPC request, response, or notification to subscribe to. - * @param block The block that will be called every time an RPC of the name and type specified is received. - * @return An object that can be passed to `unsubscribeFromRPC:ofType:withObserver:` to unsubscribe the block. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">id</span><span class="p">)</span><span class="nf">subscribeToRPC</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="p">)</span><span class="nv">rpcName</span> <span class="nf">withBlock</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLManager.h@T@SDLRPCUpdatedBlock">SDLRPCUpdatedBlock</a></span><span class="p">)</span><span class="nv">block</span> <span class="n">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">subscribe</span><span class="p">(</span><span class="n">to</span><span class="o">:</span><span class="n">block</span><span class="o">:</span><span class="p">));</span> - -<span class="cm">/** - * Subscribe to callbacks about a particular RPC request, notification, or response with a selector callback. - * - * The selector supports the following parameters: - * - * 1. Zero parameters e.g. `- (void)registerAppInterfaceResponse` - * 2. One parameter e.g. `- (void)registerAppInterfaceResponse:(NSNotification *)notification;` - * - * Note that using this method to get a response instead of the `sendRequest:withResponseHandler:` method of getting a response, you will not be notifed of any `SDLGenericResponse` errors where the head unit doesn't understand the request. - * - * @param rpcName The name of the RPC request, response, or notification to subscribe to. - * @param observer The object that will have its selector called every time an RPC of the name and type specified is received. - * @param selector The selector on `observer` that will be called every time an RPC of the name and type specified is received. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">subscribeToRPC</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="p">)</span><span class="nv">rpcName</span> <span class="nf">withObserver</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">observer</span> <span class="nf">selector</span><span class="p">:(</span><span class="n">SEL</span><span class="p">)</span><span class="nv">selector</span> <span class="n">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">subscribe</span><span class="p">(</span><span class="n">to</span><span class="o">:</span><span class="n">observer</span><span class="o">:</span><span class="n">selector</span><span class="o">:</span><span class="p">));</span> - -<span class="cm">/** - * Unsubscribe to callbacks about a particular RPC request, notification, or response. - * - * @param rpcName The name of the RPC request, response, or notification to unsubscribe from. - * @param observer The object representing a block callback or selector callback to be unsubscribed - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">unsubscribeFromRPC</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLNotificationConstants.h@T@SDLNotificationName">SDLNotificationName</a></span><span class="p">)</span><span class="nv">rpcName</span> <span class="nf">withObserver</span><span class="p">:(</span><span class="n">id</span><span class="p">)</span><span class="nv">observer</span> <span class="n">NS_SWIFT_NAME</span><span class="p">(</span><span class="n">unsubscribe</span><span class="p">(</span><span class="n">from</span><span class="o">:</span><span class="n">observer</span><span class="o">:</span><span class="p">));</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -5084,87 +3050,13 @@ cases the language of the head unit changes or does not match the app language.< SDLMenuCell </h3> - <p>Undocumented</p> + <p>A menu cell item for the main menu or sub-menu.</p> <a href="Classes/SDLMenuCell.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLMenuCell</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - The cell's text to be displayed - */</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">title</span><span class="p">;</span> - -<span class="cm">/** - The cell's icon to be displayed - */</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/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">icon</span><span class="p">;</span> - -<span class="cm">/** - The strings the user can say to activate this voice command - */</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">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">voiceCommands</span><span class="p">;</span> - -<span class="cm">/** - The handler that will be called when the command is activated - */</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"><a href="Type%20Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span> <span class="n">handler</span><span class="p">;</span> - -<span class="cm">/** - If this is non-nil, this cell will be a sub-menu button, displaying the subcells in a menu when pressed. - */</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">NSArray</span><span class="o"><</span><span class="n">SDLMenuCell</span> <span class="o">*></span> <span class="o">*</span><span class="n">subCells</span><span class="p">;</span> - -<span class="cm">/** - The layout in which the `subCells` will be displayed. - */</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="Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span> <span class="n">submenuLayout</span><span class="p">;</span> - -<span class="cm">/** - Create a menu cell that has no subcells. - - @param title The cell's primary text - @param icon The cell's image - @param voiceCommands Voice commands that will activate the menu cell - @param handler The code that will be run when the menu cell is selected - @return The menu cell - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">voiceCommands</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLMenuCell.h@T@SDLMenuCellSelectionHandler">SDLMenuCellSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> - -<span class="cm">/** - Create a menu cell that has subcells and when selected will go into a deeper part of the menu - - @param title The cell's primary text - @param subCells The subcells that will appear when the cell is selected - @return The menu cell - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">subCells</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLMenuCell</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">subCells</span> <span class="n">__deprecated_msg</span><span class="p">((</span><span class="s">"Use initWithTitle:icon:subcells: instead"</span><span class="p">));</span> - -<span class="cm">/** - Create a menu cell that has subcells and when selected will go into a deeper part of the menu - - @param title The cell's primary text - @param icon The cell's image - @param subCells The subcells that will appear when the cell is selected - @return The menu cell - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">subCells</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLMenuCell</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">subCells</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithTitle:icon:layout:subcells: instead"</span><span class="p">);</span> - -<span class="cm">/** - Create a menu cell that has subcells and when selected will go into a deeper part of the menu - - @param title The cell's primary text - @param icon The cell's image - @param layout The layout that the subCells will be layed out in if that submenu is entered - @param subCells The subcells that will appear when the cell is selected - @return The menu cell - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span> <span class="nf">submenuLayout</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">)</span><span class="nv">layout</span> <span class="nf">subCells</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">SDLMenuCell</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">subCells</span><span class="p">;</span> - - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLMenuCell</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -5177,34 +3069,13 @@ cases the language of the head unit changes or does not match the app language.< SDLMenuConfiguration </h3> - <p>Undocumented</p> + <p>Defines how the menu is configured</p> <a href="Classes/SDLMenuConfiguration.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLMenuConfiguration</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - * Changes the default main menu layout. Defaults to `SDLMenuLayoutList`. - */</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%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span> <span class="n">mainMenuLayout</span><span class="p">;</span> - -<span class="cm">/** - * Changes the default submenu layout. To change this for an individual submenu, set the `menuLayout` property on the `SDLMenuCell` initializer for creating a cell with sub-cells. Defaults to `SDLMenuLayoutList`. - */</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%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span> <span class="n">defaultSubmenuLayout</span><span class="p">;</span> - -<span class="cm">/** - Initialize a new menu configuration with a main menu layout and a default submenu layout which can be overriden per-submenu if desired. - - @param mainMenuLayout The new main menu layout - @param defaultSubmenuLayout The new default submenu layout - @return The menu configuration - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMainMenuLayout</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">)</span><span class="nv">mainMenuLayout</span> <span class="nf">defaultSubmenuLayout</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLMenuLayout.h@T@SDLMenuLayout">SDLMenuLayout</a></span><span class="p">)</span><span class="nv">defaultSubmenuLayout</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLMenuConfiguration</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -5238,58 +3109,13 @@ cases the language of the head unit changes or does not match the app language.< SDLMetadataTags </h3> - <p>Undocumented</p> + <p>Metadata for Show fields</p> <a href="Classes/SDLMetadataTags.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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">/** - 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%20Definitions.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%20Definitions.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%20Definitions.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%20Definitions.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%20Definitions.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%20Definitions.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">/** - The type of data contained in the "mainField1" text field. - - minsize= 0, maxsize= 5 - - 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="Type%20Definitions.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">/** - The type of data contained in the "mainField2" text field. - - minsize= 0, maxsize= 5 - - 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="Type%20Definitions.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">/** - The type of data contained in the "mainField3" text field. - - minsize= 0, maxsize= 5 - - 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="Type%20Definitions.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">/** - The type of data contained in the "mainField4" text field. - - minsize= 0, maxsize= 5 - - 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="Type%20Definitions.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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -5399,95 +3225,13 @@ cases the language of the head unit changes or does not match the app language.< SDLNavigationInstruction </h3> - <p>Undocumented</p> + <p>A navigation instruction.</p> <a href="Classes/SDLNavigationInstruction.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLNavigationInstruction</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init for required parameters - * - * @param locationDetails The location details - * @param action The navigation action - * @return A SDLNavigationInstruction object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLocationDetails</span><span class="p">:(</span><span class="n"><a href="Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">locationDetails</span> <span class="nf">action</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLNavigationAction.h@T@SDLNavigationAction">SDLNavigationAction</a></span><span class="p">)</span><span class="nv">action</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> - -<span class="cm">/** - * Convenience init for all parameters. - * - * @param locationDetails The location details - * @param action The navigation action - * @param eta The estimated time of arrival - * @param bearing The angle at which this instruction takes place - * @param junctionType The navigation junction type - * @param drivingSide Used to infer which side of the road this instruction takes place - * @param details This is a string representation of this instruction, used to display instructions to the users - * @param image An image representation of this instruction - * @return A SDLNavigationInstruction object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLocationDetails</span><span class="p">:(</span><span class="n"><a href="Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">locationDetails</span> <span class="nf">action</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLNavigationAction.h@T@SDLNavigationAction">SDLNavigationAction</a></span><span class="p">)</span><span class="nv">action</span> <span class="nf">eta</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">eta</span> <span class="nf">bearing</span><span class="p">:(</span><span class="n">UInt16</span><span class="p">)</span><span class="nv">bearing</span> <span class="nf">junctionType</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLNavigationJunction.h@T@SDLNavigationJunction">SDLNavigationJunction</a></span><span class="p">)</span><span class="nv">junctionType</span> <span class="nf">drivingSide</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLDirection.h@T@SDLDirection">SDLDirection</a></span><span class="p">)</span><span class="nv">drivingSide</span> <span class="nf">details</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">details</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="cm">/** - * The location details. - * - * SDLLocationDetails, Required - */</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/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="n">locationDetails</span><span class="p">;</span> - -<span class="cm">/** - * The navigation action. - * - * SDLNavigationAction, Required - */</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%20Definitions.html#/c:SDLNavigationAction.h@T@SDLNavigationAction">SDLNavigationAction</a></span> <span class="n">action</span><span class="p">;</span> - -<span class="cm">/** - * The estimated time of arrival. - * - * SDLDateTime, 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">eta</span><span class="p">;</span> - -<span class="cm">/** - * The angle at which this instruction takes place. For example, 0 would mean straight, <=45 is bearing right, >= 135 is sharp right, between 45 and 135 is a regular right, and 180 is a U-Turn, etc. - * - * Integer, Optional, minValue="0" maxValue="359" - */</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">bearing</span><span class="p">;</span> - -<span class="cm">/** - * The navigation junction type. - * - * SDLNavigationJunction, 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%20Definitions.html#/c:SDLNavigationJunction.h@T@SDLNavigationJunction">SDLNavigationJunction</a></span> <span class="n">junctionType</span><span class="p">;</span> - -<span class="cm">/** - * Used to infer which side of the road this instruction takes place. For a U-Turn (action=TURN, bearing=180) this will determine which direction the turn should take place. - * - * SDLDirection, 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%20Definitions.html#/c:SDLDirection.h@T@SDLDirection">SDLDirection</a></span> <span class="n">drivingSide</span><span class="p">;</span> - -<span class="cm">/** - * This is a string representation of this instruction, used to display instructions to the users. This is not intended to be read aloud to the users, see the param prompt in `NavigationServiceData` for that. - * - * String, 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">NSString</span> <span class="o">*</span><span class="n">details</span><span class="p">;</span> - -<span class="cm">/** - * An image representation of this instruction. - * - * 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">image</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLNavigationInstruction</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -5500,102 +3244,13 @@ cases the language of the head unit changes or does not match the app language.< SDLNavigationServiceData </h3> - <p>Undocumented</p> + <p>This data is related to what a navigation service would provide.</p> <a href="Classes/SDLNavigationServiceData.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLNavigationServiceData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init for required parameters. - * - * @param timestamp Timestamp of when the data was generated - * @return A SDLNavigationServiceData object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTimestamp</span><span class="p">:(</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="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> - -<span class="cm">/** - * Convenience init for all parameters. - * - * @param timestamp Timestamp of when the data was generated - * @param origin The start location - * @param destination The final destination location - * @param destinationETA The estimated time of arrival at the final destination location - * @param instructions Array ordered with all remaining instructions - * @param nextInstructionETA The estimated time of arrival at the next destination - * @param nextInstructionDistance The distance to this instruction from current location - * @param nextInstructionDistanceScale Distance till next maneuver (starting from) from previous maneuver - * @param prompt This is a prompt message that should be conveyed to the user through either display or voice (TTS) - * @return A SDLNavigationServiceData object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTimestamp</span><span class="p">:(</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">origin</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">origin</span> <span class="nf">destination</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">destination</span> <span class="nf">destinationETA</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">destinationETA</span> <span class="nf">instructions</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/SDLNavigationInstruction.html">SDLNavigationInstruction</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">instructions</span> <span class="nf">nextInstructionETA</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">nextInstructionETA</span> <span class="nf">nextInstructionDistance</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">nextInstructionDistance</span> <span class="nf">nextInstructionDistanceScale</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">nextInstructionDistanceScale</span> <span class="nf">prompt</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">prompt</span><span class="p">;</span> - -<span class="cm">/** - * This is the timestamp of when the data was generated. This is to ensure any time or distance given in the data can accurately be adjusted if necessary. - * - * SDLDateTime, Required - */</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/SDLDateTime.html">SDLDateTime</a></span> <span class="o">*</span><span class="n">timestamp</span><span class="p">;</span> - -<span class="cm">/** - * The start location. - * - * SDLLocationDetails, 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/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="n">origin</span><span class="p">;</span> - -<span class="cm">/** - * The final destination location. - * - * SDLLocationDetails, 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/SDLLocationDetails.html">SDLLocationDetails</a></span> <span class="o">*</span><span class="n">destination</span><span class="p">;</span> - -<span class="cm">/** - * The estimated time of arrival at the final destination location. - * - * SDLDateTime, 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">destinationETA</span><span class="p">;</span> - -<span class="cm">/** - * This array should be ordered with all remaining instructions. The start of this array should always contain the next instruction. - * - * Array of SDLNavigationInstruction, 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/SDLNavigationInstruction.html">SDLNavigationInstruction</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">instructions</span><span class="p">;</span> - -<span class="cm">/** - * The estimated time of arrival at the next destination. - * - * SDLDateTime, 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">nextInstructionETA</span><span class="p">;</span> - -<span class="cm">/** - * The distance to this instruction from current location. This should only be updated ever .1 unit of distance. For more accuracy the consumer can use the GPS location of itself and the next instruction. - * - * Float, 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"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">nextInstructionDistance</span><span class="p">;</span> - -<span class="cm">/** - * Distance till next maneuver (starting from) from previous maneuver. - * - * Float, 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"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">nextInstructionDistanceScale</span><span class="p">;</span> - -<span class="cm">/** - * This is a prompt message that should be conveyed to the user through either display or voice (TTS). This param will change often as it should represent the following: approaching instruction, post instruction, alerts that affect the current navigation session, etc. - * - * String, 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">NSString</span> <span class="o">*</span><span class="n">prompt</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLNavigationServiceData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -5608,30 +3263,13 @@ cases the language of the head unit changes or does not match the app language.< SDLNavigationServiceManifest </h3> - <p>Undocumented</p> + <p>A navigation service manifest.</p> <a href="Classes/SDLNavigationServiceManifest.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLNavigationServiceManifest</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init. - * - * @param acceptsWayPoints Informs the subscriber if this service can actually accept way points - * @return A SDLNavigationServiceManifest object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAcceptsWayPoints</span><span class="p">:(</span><span class="n">BOOL</span><span class="p">)</span><span class="nv">acceptsWayPoints</span><span class="p">;</span> - -<span class="cm">/** - * Informs the subscriber if this service can actually accept way points. - * - * 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"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="n">acceptsWayPoints</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLNavigationServiceManifest</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -5644,29 +3282,13 @@ cases the language of the head unit changes or does not match the app language.< SDLNotificationConstants </h3> - <p>Undocumented</p> + <p>This class defines methods for getting groups of notifications</p> <a href="Classes/SDLNotificationConstants.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLNotificationConstants</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - All of the possible SDL RPC Response notification names - - @return All response notification names - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type%20Definitions.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="cm">/** - All of the possible SDL Button event notification names - - @return The names - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Type%20Definitions.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> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLNotificationConstants</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -5792,9 +3414,11 @@ the application has subscribed.</p> </ul> <p>SystemContext:</p> + +<ul> <li><p>MAIN, VR. In MENU, only PRESET buttons.</p></li> <li><p>In VR, pressing any subscribable button will cancel VR.</p></li> -<div class="aside aside-see"> +</ul><div class="aside aside-see"> <p class="aside-title">See</p> <p>SDLSubscribeButton</p> @@ -6298,30 +3922,13 @@ the application has subscribed.</p> SDLPerformAppServiceInteractionResponse </h3> - <p>Undocumented</p> + <p>Response to the request to request an app service.</p> <a href="Classes/SDLPerformAppServiceInteractionResponse.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLPerformAppServiceInteractionResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="cm">/** - * Convenience init for all parameters. - * - * @param serviceSpecificResult The service can provide specific result strings to the consumer through this param. - * @return A SDLPerformAppServiceInteractionResponse object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithServiceSpecificResult</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">serviceSpecificResult</span><span class="p">;</span> - -<span class="cm">/** - * The service can provide specific result strings to the consumer through this param. - * - * String, 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">NSString</span> <span class="o">*</span><span class="n">serviceSpecificResult</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLPerformAppServiceInteractionResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -6439,43 +4046,15 @@ A keyboard can be used for searches. For example, the user could be asked to ent SDLPermissionItem </h3> - <p>Undocumented</p> + <p>Permissions for a given set of RPCs</p> + +<p>@since RPC 2.0</p> <a href="Classes/SDLPermissionItem.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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="cm">/** - Name of the individual RPC in the policy table. - - Required - */</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="cm">/** - HMI Permissions for the individual RPC; i.e. which HMI levels may it be used in - - Required - */</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="cm">/** - RPC parameters for the individual RPC - - Required - */</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="cm">/** - Describes whether or not the RPC needs encryption - - Optional, Boolean, since SDL 6.0 - */</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">requireEncryption</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -6488,92 +4067,13 @@ A keyboard can be used for searches. For example, the user could be asked to ent SDLPermissionManager </h3> - <p>Undocumented</p> + <p>The permission manager monitoring RPC permissions.</p> <a href="Classes/SDLPermissionManager.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLPermissionManager</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - * Flag indicating if the app requires an encryption service to be active. - */</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">requiresEncryption</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 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%20Definitions.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%20Definitions.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%20Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName">SDLPermissionRPCName</a></span><span class="p">,</span> <span class="n">NSNumber</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%20Definitions.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%20Definitions.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%20Definitions.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%20Definitions.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%20Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionObserverIdentifier">SDLPermissionObserverIdentifier</a></span><span class="p">)</span><span class="nv">identifier</span><span class="p">;</span> - - -<span class="cm">/** - * Check whether or not an RPC needs encryption. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">rpcRequiresEncryption</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLPermissionConstants.h@T@SDLPermissionRPCName">SDLPermissionRPCName</a></span><span class="p">)</span><span class="nv">rpcName</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLPermissionManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -6605,58 +4105,13 @@ A keyboard can be used for searches. For example, the user could be asked to ent SDLPinchGesture </h3> - <p>Undocumented</p> + <p>Pinch Gesture information</p> <a href="Classes/SDLPinchGesture.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLPinchGesture</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -6710,31 +4165,13 @@ Subsequent calls with the same service type will update the manifest for that se SDLPublishAppServiceResponse </h3> - <p>Undocumented</p> + <p>Response to the request to register a service offered by this app on the module.</p> <a href="Classes/SDLPublishAppServiceResponse.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLPublishAppServiceResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="cm">/** - * Convenience init. - * - * @param appServiceRecord If the request was successful, this object will be the current status of the service record for the published service. This will include the Core supplied service ID. - * @return A SDLPublishAppServiceResponse object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAppServiceRecord</span><span class="p">:(</span><span class="n"><a href="Classes/SDLAppServiceRecord.html">SDLAppServiceRecord</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">appServiceRecord</span><span class="p">;</span> - -<span class="cm">/** - * If the request was successful, this object will be the current status of the service record for the published service. This will include the Core supplied service ID. - * - * SDLAppServiceRecord, 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/SDLAppServiceRecord.html">SDLAppServiceRecord</a></span> <span class="o">*</span><span class="n">appServiceRecord</span><span class="p">;</span> - - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLPublishAppServiceResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -6813,53 +4250,15 @@ Subsequent calls with the same service type will update the manifest for that se SDLRGBColor </h3> - <p>Undocumented</p> + <p>Represents an RGB color</p> + +<p>@since 5.0</p> <a href="Classes/SDLRGBColor.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLRGBColor</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - Create an SDL color object with red / green / blue values between 0-255 - - @param red The red value of the color - @param green The green value of the color - @param blue The blue value of the color - @return The color - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithRed</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">red</span> <span class="nf">green</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">green</span> <span class="nf">blue</span><span class="p">:(</span><span class="n">UInt8</span><span class="p">)</span><span class="nv">blue</span><span class="p">;</span> - -<span class="cm">/** - Create an SDL color object with a UIColor object. - - @warning The alpha color of the UIColor object will be ignored - - @param color The UIColor object to base this color on - @return The color - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithColor</span><span class="p">:(</span><span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">color</span><span class="p">;</span> - -<span class="cm">/** - * The red value of the RGB color - * Required, Integer, 0-255 - */</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">red</span><span class="p">;</span> - -<span class="cm">/** - * The green value of the RGB color - * Required, Integer, 0-255 - */</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">green</span><span class="p">;</span> - -<span class="cm">/** - * The blue value of the RGB color - * Required, Integer, 0-255 - */</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">blue</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLRGBColor</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -6872,73 +4271,15 @@ Subsequent calls with the same service type will update the manifest for that se SDLRPCMessage </h3> - <p>Undocumented</p> + <p>Parent class of all RPC messages.</p> + +<p>Contains basic information about an RPC message.</p> <a href="Classes/SDLRPCMessage.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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="o"><</span><span class="n">NSCopying</span><span class="o">></span> - -<span class="cm">/** - * Convenience init - * - * @param name The name of the message - * @return A SDLRPCMessage object - */</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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"This is not intended to be a public facing API"</span><span class="p">);</span> - -<span class="cm">/** - * Returns the function name. - * - * @return The function name - */</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="nf">__deprecated_msg</span><span class="p">(</span><span class="s">"Call the .name property instead"</span><span class="p">);</span> - -<span class="cm">/** - * Sets the function name. - * - * @param functionName The function name - */</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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"This is not intended to be a public facing API"</span><span class="p">);</span> - -<span class="cm">/** - * Returns the value associated with the provided key. If the key does not exist, null is returned. - * - * @param functionName The key name - * @return The value associated with the function name - */</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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Call the .parameters property instead"</span><span class="p">);</span> - -<span class="cm">/** - * Sets a key-value pair using the function name as the key. - * - * @param functionName The name for the key - * @param value The value associated with the function name - */</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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"This is not intended to be a public facing API"</span><span class="p">);</span> - -<span class="cm">/** - * The data in the message - */</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="cm">/** - * The name of the message - */</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="cm">/** - The JSON-RPC parameters - */</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">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="cm">/** - * The type of data in the message - */</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> + <pre class="highlight objective_c"><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="o"><</span><span class="n">NSCopying</span><span class="o">></span></code></pre> <h4>Swift</h4> @@ -6988,20 +4329,13 @@ Subsequent calls with the same service type will update the manifest for that se SDLRPCRequest </h3> - <p>Undocumented</p> + <p>Superclass of RPC requests</p> <a href="Classes/SDLRPCRequest.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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="cm">/** - * A unique id assigned to message sent to Core. The Correlation ID is used to map a request to its response. - */</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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -7033,35 +4367,13 @@ Subsequent calls with the same service type will update the manifest for that se SDLRPCResponse </h3> - <p>Undocumented</p> + <p>Superclass of RPC responses</p> <a href="Classes/SDLRPCResponse.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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="cm">/** - * The correlation id of the corresponding SDLRPCRequest. - */</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="cm">/** - * Whether or not the SDLRPCRequest was successful. - */</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="cm">/** - * The result of the SDLRPCRequest. If the request failed, the result code contains the failure reason. - */</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%20Definitions.html#/c:SDLResult.h@T@SDLResult">SDLResult</a></span> <span class="n">resultCode</span><span class="p">;</span> - -<span class="cm">/** - * More detailed success or error message. - */</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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -7093,33 +4405,13 @@ Subsequent calls with the same service type will update the manifest for that se SDLRPCStruct </h3> - <p>Undocumented</p> + <p>Superclass of all RPC-related structs and messages</p> <a href="Classes/SDLRPCStruct.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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="k">@property</span> <span 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">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="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">isPayloadProtected</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">payloadProtected</span><span class="p">;</span> -<span class="cm">/** - * Convenience init - * - * @param dict A dictionary - * @return A SDLRPCStruct object - */</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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"This is not intended for public use"</span><span class="p">);</span> - -<span class="cm">/** - * Converts struct to JSON formatted data - * - * @param version The protocol version - * @return JSON formatted data - */</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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"This is not intended for public use"</span><span class="p">);</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -7291,31 +4583,15 @@ Subsequent calls with the same service type will update the manifest for that se SDLReleaseInteriorVehicleDataModule </h3> - <p>Undocumented</p> + <p>Releases a controlled remote control module so others can take control</p> + +<p>@since 6.0</p> <a href="Classes/SDLReleaseInteriorVehicleDataModule.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLReleaseInteriorVehicleDataModule</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">initWithModuleType</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span><span class="p">)</span><span class="nv">moduleType</span> <span class="nf">moduleId</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">moduleId</span><span class="p">;</span> - -<span class="cm">/** - * The module type that the app requests to control. - * - * Required - */</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%20Definitions.html#/c:SDLModuleType.h@T@SDLModuleType">SDLModuleType</a></span> <span class="n">moduleType</span><span class="p">;</span> - -<span class="cm">/** - * Id of a module, published by System Capability. - * - * Optional - */</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">moduleId</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLReleaseInteriorVehicleDataModule</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> <h4>Swift</h4> @@ -7328,14 +4604,14 @@ Subsequent calls with the same service type will update the manifest for that se SDLReleaseInteriorVehicleDataModuleResponse </h3> - <p>Undocumented</p> + <p>Response to ReleaseInteriorVehicleDataModule</p> + +<p>@since RPC 6.0</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLReleaseInteriorVehicleDataModuleResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLReleaseInteriorVehicleDataModuleResponse</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCResponse.html">SDLRPCResponse</a></span></code></pre> <h4>Swift</h4> @@ -7438,288 +4714,13 @@ Subsequent calls with the same service type will update the manifest for that se SDLScreenManager </h3> - <p>Undocumented</p> + <p>The SDLScreenManager is a manager to control SDL UI features. Use the screen manager for setting up the UI of the template, creating a menu for your users, creating softbuttons, setting textfields, etc..</p> <a href="Classes/SDLScreenManager.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLScreenManager</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cp">#pragma mark Text and Graphics -</span> -<span class="cm">/** - The top text field within a template layout - */</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">NSString</span> <span class="o">*</span><span class="n">textField1</span><span class="p">;</span> - -<span class="cm">/** - The second text field within a template layout - */</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">NSString</span> <span class="o">*</span><span class="n">textField2</span><span class="p">;</span> - -<span class="cm">/** - The third text field within a template layout - */</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">NSString</span> <span class="o">*</span><span class="n">textField3</span><span class="p">;</span> - -<span class="cm">/** - The fourth text field within a template layout - */</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">NSString</span> <span class="o">*</span><span class="n">textField4</span><span class="p">;</span> - -<span class="cm">/** - The media text field available within the media layout. Often less emphasized than textField(1-4) - */</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">NSString</span> <span class="o">*</span><span class="n">mediaTrackTextField</span><span class="p">;</span> - -<span class="cm">/** - The primary graphic within a template layout - */</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/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">primaryGraphic</span><span class="p">;</span> - -<span class="cm">/** - A secondary graphic used in some template layouts - */</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/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">secondaryGraphic</span><span class="p">;</span> - -<span class="cm">/** - What alignment textField(1-4) should use - */</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%20Definitions.html#/c:SDLTextAlignment.h@T@SDLTextAlignment">SDLTextAlignment</a></span> <span class="n">textAlignment</span><span class="p">;</span> - -<span class="cm">/** - The type of data textField1 describes - */</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%20Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField1Type</span><span class="p">;</span> - -<span class="cm">/** - The type of data textField2 describes - */</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%20Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField2Type</span><span class="p">;</span> - -<span class="cm">/** - The type of data textField3 describes - */</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%20Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField3Type</span><span class="p">;</span> - -<span class="cm">/** - The type of data textField4 describes - */</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%20Definitions.html#/c:SDLMetadataType.h@T@SDLMetadataType">SDLMetadataType</a></span> <span class="n">textField4Type</span><span class="p">;</span> - -<span class="cm">/** - The title of the current template layout. - */</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">NSString</span> <span class="o">*</span><span class="n">title</span><span class="p">;</span> - -<span class="cp">#pragma mark Soft Buttons -</span> -<span class="cm">/** - The current list of soft buttons within a template layout. Set this array to change the displayed soft buttons. - */</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/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtonObjects</span><span class="p">;</span> - -<span class="cp">#pragma mark Menu -</span> -<span class="cm">/** - Configures the layout of the menu and sub-menus. If set after a menu already exists, the existing main menu layout will be updated. - - If set menu layouts don't match available menu layouts in WindowCapability, an error log will be emitted and the layout will not be set. - - Setting this parameter will send a message to the remote system. This value will be set immediately, but if that message is rejected, the original value will be re-set and an error log will be emitted. - - This only works on head units supporting RPC spec version 6.0 and newer. If the connected head unit does not support this feature, a warning log will be emitted and nothing will be set. - */</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/SDLMenuConfiguration.html">SDLMenuConfiguration</a></span> <span class="o">*</span><span class="n">menuConfiguration</span><span class="p">;</span> - -<span class="cm">/** - The current list of menu cells displayed in the app's menu. - */</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/SDLMenuCell.html">SDLMenuCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">menu</span><span class="p">;</span> - -<span class="cm">/** -Change the mode of the dynamic menu updater to be enabled, disabled, or enabled on known compatible head units. - -The current status for dynamic menu updates. A dynamic menu update allows for smarter building of menu changes. If this status is set to `SDLDynamicMenuUpdatesModeForceOn`, menu updates will only create add commands for new items and delete commands for items no longer appearing in the menu. This helps reduce possible RPCs failures as there will be significantly less commands sent to the HMI. - -If set to `SDLDynamicMenuUpdatesModeForceOff`, menu updates will work the legacy way. This means when a new menu is set the entire old menu is deleted and add commands are created for every item regarldess if the item appears in both the old and new menu. This method is RPCs heavy and may cause some failures when creating and updating large menus. - - We recommend using either `SDLDynamicMenuUpdatesModeOnWithCompatibility` or `SDLDynamicMenuUpdatesModeForceOn`. `SDLDynamicMenuUpdatesModeOnWithCompatibility` turns dynamic updates off for head units that we know have poor compatibility with dynamic updates (e.g. they have bugs that cause menu items to not be placed correctly). - */</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/SDLDynamicMenuUpdatesMode.html">SDLDynamicMenuUpdatesMode</a></span> <span class="n">dynamicMenuUpdatesMode</span><span class="p">;</span> - -<span class="cm">/** - The current list of voice commands available for the user to speak and be recognized by the IVI's voice recognition engine. - */</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/SDLVoiceCommand.html">SDLVoiceCommand</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">voiceCommands</span><span class="p">;</span> - -<span class="cp">#pragma mark Choice Sets -</span> -<span class="cm">/** - The default keyboard configuration, this can be additionally customized by each SDLKeyboardDelegate. - */</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">null_resettable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLKeyboardProperties.html">SDLKeyboardProperties</a></span> <span class="o">*</span><span class="n">keyboardConfiguration</span><span class="p">;</span> - -<span class="cm">/** - Cells will be hashed by their text, image names, and VR command text. When assembling an SDLChoiceSet, you can pull objects from here, or recreate them. The preloaded versions will be used so long as their text, image names, and VR commands are the same. - */</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"><a href="Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">preloadedChoices</span><span class="p">;</span> - - -<span class="cp">#pragma mark - Methods -</span> -<span class="cp">#pragma mark Lifecycle -</span> -<span class="cm">/** - Initialize a screen manager - - @warning For internal use - - @param connectionManager The connection manager used to send RPCs - @param fileManager The file manager used to upload files - @param systemCapabilityManager The system capability manager object for reading window capabilities - @return The screen 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">fileManager</span><span class="p">:(</span><span class="n"><a href="Classes/SDLFileManager.html">SDLFileManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">fileManager</span> <span class="nf">systemCapabilityManager</span><span class="p">:(</span><span class="n"><a href="Classes/SDLSystemCapabilityManager.html">SDLSystemCapabilityManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">systemCapabilityManager</span><span class="p">;</span> - -<span class="cm">/** - Starts the manager and all sub-managers - - @param handler The handler called when 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">NSError</span> <span class="o">*</span> <span class="n">_Nullable</span> <span class="n">error</span><span class="p">))</span><span class="nv">handler</span><span class="p">;</span> - -<span class="cm">/** - Stops the manager. - - @warning For internal use - */</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 Text and Graphic -</span><span class="cm">/** - Delays all screen updates until endUpdatesWithCompletionHandler: is called. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">beginUpdates</span><span class="p">;</span> - -<span class="cm">/** - Update text fields with new text set into the text field properties. Pass an empty string `\@""` to clear the text field. - - If the system does not support a full 4 fields, this will automatically be concatenated and properly send the field available. - - If 3 lines are available: [field1, field2, field3 - field 4] - - If 2 lines are available: [field1 - field2, field3 - field4] - - If 1 line is available: [field1 - field2 - field3 - field4] - - Also updates the primary and secondary images with new image(s) if new one(s) been set. This method will take care of naming the files (based on a hash). This is assumed to be a non-persistant image. - - If it needs to be uploaded, it will be. Once the upload is complete, the on-screen graphic will be updated. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">endUpdates</span><span class="p">;</span> - -<span class="cm">/** - Update text fields with new text set into the text field properties. Pass an empty string `\@""` to clear the text field. - - If the system does not support a full 4 fields, this will automatically be concatenated and properly send the field available. - - If 3 lines are available: [field1, field2, field3 - field 4] - - If 2 lines are available: [field1 - field2, field3 - field4] - - If 1 line is available: [field1 - field2 - field3 - field4] - - Also updates the primary and secondary images with new image(s) if new one(s) been set. This method will take care of naming the files (based on a hash). This is assumed to be a non-persistant image. - - If it needs to be uploaded, it will be. Once the upload is complete, the on-screen graphic will be updated. - - @param handler A handler run when the fields have finished updating, with an error if the update failed. This handler may be called multiple times when the text update is sent and the image update is sent. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">endUpdatesWithCompletionHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLScreenManager.h@T@SDLScreenManagerUpdateCompletionHandler">SDLScreenManagerUpdateCompletionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> - -<span class="cp">#pragma mark Soft Button -</span> -<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*</span><span class="p">)</span><span class="nf">softButtonObjectNamed</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">name</span><span class="p">;</span> - -<span class="cp">#pragma mark Choice Sets -</span> -<span class="cm">/** - Preload cells to the head unit. This will *greatly* reduce the time taken to present a choice set. Any already matching a choice already on the head unit will be ignored. You *do not* need to wait until the completion handler is called to present a choice set containing choices being loaded. The choice set will wait until the preload completes and then immediately present. - - @param choices The choices to be preloaded. - @param handler The handler to be called when complete. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">preloadChoices</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">choices</span> <span class="nf">withCompletionHandler</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Type%20Definitions.html#/c:SDLScreenManager.h@T@SDLPreloadChoiceCompletionHandler">SDLPreloadChoiceCompletionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> - -<span class="cm">/** - Delete loaded cells from the head unit. If the cells don't exist on the head unit they will be ignored. - - @param choices The choices to be deleted. These will be matched via a hash of the text, image name(s), and VR commands. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">deleteChoices</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLChoiceCell.html">SDLChoiceCell</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">choices</span><span class="p">;</span> - -<span class="cm">/** - Present a choice set on the head unit with a certain interaction mode. You should present in VR only if the user reached this choice set by using their voice, in Manual only if the user used touch to reach this choice set. Use Both if you're lazy...for real though, it's kind of confusing to the user and isn't recommended. - - If the cells in the set are not already preloaded, they will be preloaded before the presentation occurs; this could take a while depending on the contents of the cells. - - If the cells have voice commands and images attached, this could take upwards of 10 seconds. If there are no cells on the set, this will fail, calling `choiceSet:didReceiveError:` on the choice set delegate. - - @param choiceSet The set to be displayed - @param mode If the set should be presented for the user to interact via voice, touch, or both - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">presentChoiceSet</span><span class="p">:(</span><span class="n"><a href="Classes/SDLChoiceSet.html">SDLChoiceSet</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">choiceSet</span> <span class="nf">mode</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLInteractionMode.h@T@SDLInteractionMode">SDLInteractionMode</a></span><span class="p">)</span><span class="nv">mode</span><span class="p">;</span> - -<span class="cm">/** - Present a choice set on the head unit with a certain interaction mode. You should present in VR only if the user reached this choice set by using their voice, in Manual only if the user used touch to reach this choice set. Use Both if you're lazy...for real though, it's kind of confusing to the user and isn't recommended. - - This presents the choice set as searchable when in a touch interaction. The user, when not in a distracted state, will have a keyboard available for searching this set. The user's input in the keyboard will be available in the SDLKeyboardDelegate. - - If the cells in the set are not already preloaded, they will be preloaded before the presentation occurs; this could take a while depending on the contents of the cells. - - If the cells have voice commands and images attached, this could take upwards of 10 seconds. If there are no cells on the set, this will fail, calling `choiceSet:didReceiveError:` on the choice set delegate. - - @param choiceSet The set to be displayed - @param mode If the set should be presented for the user to interact via voice, touch, or both - @param delegate The keyboard delegate called when the user interacts with the search field of the choice set - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">presentSearchableChoiceSet</span><span class="p">:(</span><span class="n"><a href="Classes/SDLChoiceSet.html">SDLChoiceSet</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">choiceSet</span> <span class="nf">mode</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLInteractionMode.h@T@SDLInteractionMode">SDLInteractionMode</a></span><span class="p">)</span><span class="nv">mode</span> <span class="nf">withKeyboardDelegate</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLKeyboardDelegate.html">SDLKeyboardDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span> - -<span class="cm">/** - Present a keyboard-only interface to the user and receive input. The user will be able to input text in the keyboard when in a non-driver distraction situation. - - @param initialText The initial text within the keyboard input field. It will disappear once the user selects the field in order to enter text - @param delegate The keyboard delegate called when the user interacts with the keyboard - @return A unique cancelID that can be used to cancel this keyboard - */</span> -<span class="k">-</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="nf">presentKeyboardWithInitialText</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">initialText</span> <span class="nf">delegate</span><span class="p">:(</span><span class="n">id</span><span class="o"><</span><span class="n"><a href="Protocols/SDLKeyboardDelegate.html">SDLKeyboardDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span><span class="p">;</span> - -<span class="cm">/** - Cancels the keyboard-only interface if it is currently showing. If the keyboard has not yet been sent to Core, it will not be sent. - - This will only dismiss an already presented keyboard if connected to head units running SDL 6.0+. - - @param cancelID The unique ID assigned to the keyboard, passed as the return value from `presentKeyboardWithInitialText:keyboardDelegate:` - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">dismissKeyboardWithCancelID</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="p">)</span><span class="nv">cancelID</span><span class="p">;</span> - -<span class="cp">#pragma mark Menu -</span> -<span class="cm">/** - Present the top-level of your application menu. This method should be called if the menu needs to be opened programmatically because the built in menu button is hidden. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="n">openMenu</span><span class="p">;</span> - -<span class="cm">/** - Present the application menu. This method should be called if the menu needs to be opened programmatically because the built in menu button is hidden. You must update the menu with the proper cells before calling this method. This RPC will fail if the cell does not contain a sub menu, or is not in the menu array. - -@param cell The submenu cell that should be opened as a sub menu, with its sub cells as the options. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">openSubmenu</span><span class="p">:(</span><span class="n"><a href="Classes/SDLMenuCell.html">SDLMenuCell</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">cell</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLScreenManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -7813,7 +4814,7 @@ If set to `SDLDynamicMenuUpdatesModeForceOff`, menu updates will work the legacy SDLSeatControlData </h3> - <p>Seat control data corresponds to <q>SEAT</q> ModuleType.</p> + <p>Seat control data corresponds to “SEAT” ModuleType.</p> <a href="Classes/SDLSeatControlData.html" class="slightly-smaller">See more</a> @@ -7926,131 +4927,15 @@ If set to `SDLDynamicMenuUpdatesModeForceOff`, menu updates will work the legacy SDLSendLocation </h3> - <p>Undocumented</p> + <p>SendLocation is used to send a location to the navigation system for navigation</p> + +<p>@since RPC 3.0</p> <a href="Classes/SDLSendLocation.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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="cm">/** - Create a `SendLocation` request with an address object, without Lat/Long coordinates. - - @param address The address information to be passed to the nav system for determining the route - @param addressLines The user-facing address - @param locationName The user-facing name of the location - @param locationDescription The user-facing description of the location - @param phoneNumber The phone number for the location; the user could use this to call the location - @param image A user-facing image for the location - @param deliveryMode How the location should be sent to the nav system - @param timeStamp The estimated arrival time for the location (this will also likely be calculated by the nav system later, and may be different than your estimate). This is used to show the user approximately how long it would take to navigate here - @return A `SendLocation` object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAddress</span><span class="p">:(</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="nf">addressLines</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">addressLines</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">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%20Definitions.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="p">;</span> - -<span class="cm">/** - Create a `SendLocation` request with Lat/Long coordinate, not an address object - - @param longitude The longitudinal coordinate of the location - @param latitude The latitudinal coordinate of the location - @param locationName The user-facing name of the location - @param locationDescription The user-facing description of the location - @param address The user-facing address - @param phoneNumber The phone number for the location; the user could use this to call the location - @param image A user-facing image for the location - @return A `SendLocation` object - */</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="cm">/** - Create a `SendLocation` request with Lat/Long coordinate and an address object and let the nav system decide how to parse it - - @param longitude The longitudinal coordinate of the location - @param latitude The latitudinal coordinate of the location - @param locationName The user-facing name of the location - @param locationDescription The user-facing description of the location - @param displayAddressLines The user-facing address - @param phoneNumber The phone number for the location; the user could use this to call the location - @param image A user-facing image for the location - @param deliveryMode How the location should be sent to the nav system - @param timeStamp The estimated arrival time for the location (this will also likely be calculated by the nav system later, and may be different than your estimate). This is used to show the user approximately how long it would take to navigate here - @param address The address information to be passed to the nav system for determining the route - @return A `SendLocation` object - */</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%20Definitions.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. Either the latitude / longitude OR the `address` must be provided. - * - * Float, Optional, -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. Either the latitude / longitude OR the `address` must be provided. - * - * Float, Optional, -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%20Definitions.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. Either the latitude / longitude OR the `address` must be provided. - * - * 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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -8594,67 +5479,13 @@ change the settings of a specific remote control module.</p> SDLSoftButtonState </h3> - <p>Undocumented</p> + <p>A soft button state including data such as text, name and artwork</p> <a href="Classes/SDLSoftButtonState.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSoftButtonState</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - The name of this soft button state - */</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 artwork to be used with this button or nil if it is text-only - */</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/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">artwork</span><span class="p">;</span> - -<span class="cm">/** - The text to be used with this button or nil if it is image-only - */</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">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span> - -<span class="cm">/** - Whether or not the button should be highlighted on the UI - */</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">isHighlighted</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">highlighted</span><span class="p">;</span> - -<span class="cm">/** - A special system action - */</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%20Definitions.html#/c:SDLSystemAction.h@T@SDLSystemAction">SDLSystemAction</a></span> <span class="n">systemAction</span><span class="p">;</span> - -<span class="cm">/** - An SDLSoftButton describing this state - */</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/SDLSoftButton.html">SDLSoftButton</a></span> <span class="o">*</span><span class="n">softButton</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 the soft button state. Either the text or artwork or both may be set. - - @param stateName The name of this state for the button - @param text The text to be displayed on the button - @param image The image to be displayed on the button. This is assumed to be a PNG, non-persistant. The name will be the same as the state name. - @return A new soft button state - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithStateName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">stateName</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">UIImage</span> <span class="o">*</span><span class="p">)</span><span class="nv">image</span><span class="p">;</span> - -<span class="cm">/** - Create the soft button state. Either the text or artwork or both may be set. - - @param stateName The name of this state for the button - @param text The text to be displayed on the button - @param artwork The artwork to be displayed on the button - @return A new soft button state - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithStateName</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">stateName</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">artwork</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">artwork</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSoftButtonState</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -8667,7 +5498,7 @@ change the settings of a specific remote control module.</p> SDLSpeak </h3> - <p>Speaks a phrase over the vehicle audio system using SDL’s TTS (text-to-speech) engine. The provided text to be spoken can be simply a text phrase, or it can consist of phoneme specifications to direct SDL’s TTS engine to speak a <q>speech-sculpted</q> phrase.</p> + <p>Speaks a phrase over the vehicle audio system using SDL’s TTS (text-to-speech) engine. The provided text to be spoken can be simply a text phrase, or it can consist of phoneme specifications to direct SDL’s TTS engine to speak a “speech-sculpted” phrase.</p> <p>Receipt of the Response indicates the completion of the Speak operation, regardless of how the Speak operation may have completed (i.e. successfully, interrupted, terminated, etc.).</p> @@ -8687,9 +5518,9 @@ change the settings of a specific remote control module.</p> <li>SystemContext: MAIN, MENU, VR</li></p> <p><b>Notes:</b> - <li>When <i>SDLAlert</i> is issued with MENU in effect, <i>SDLAlert</i> is queued and <q>played</q> when MENU interaction is completed (i.e. SystemContext reverts to MAIN). When <i>SDLAlert - </i> is issued with VR in effect, <i>SDLAlert</i> is queued and <q>played</q> when VR interaction is completed (i.e. SystemContext reverts to MAIN)</li> - <li>When both <i>SDLAlert</i> and Speak are queued during MENU or VR, they are <q>played</q> back in the order in which they were queued, with all existing rules for <q>collisions</q> still in effect</li></p> + <li>When <i>SDLAlert</i> is issued with MENU in effect, <i>SDLAlert</i> is queued and “played” when MENU interaction is completed (i.e. SystemContext reverts to MAIN). When <i>SDLAlert + </i> is issued with VR in effect, <i>SDLAlert</i> is queued and “played” when VR interaction is completed (i.e. SystemContext reverts to MAIN)</li> + <li>When both <i>SDLAlert</i> and Speak are queued during MENU or VR, they are “played” back in the order in which they were queued, with all existing rules for “collisions” still in effect</li></p> <p><b>Additional Notes:</b> <li>Total character limit depends on platform.</li> @@ -8782,152 +5613,13 @@ change the settings of a specific remote control module.</p> SDLStreamingMediaConfiguration </h3> - <p>Undocumented</p> + <p>The streaming media configuration. Use this class to configure streaming media information.</p> <a href="Classes/SDLStreamingMediaConfiguration.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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="nf">__deprecated_msg</span><span class="p">(</span><span class="s">"This is now unused, the security managers are taken in from SDLEncryptionConfiguration"</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 utilize the video encoder for streaming. See VTCompressionProperties.h for more details. For example, you can set kVTCompressionPropertyKey_ExpectedFrameRate to set your framerate. Setting the framerate this way will also set the framerate if you use CarWindow automatic streaming. - * - * Other properties you may want to try adjusting include kVTCompressionPropertyKey_AverageBitRate and kVTCompressionPropertyKey_DataRateLimits. - */</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"><a href="Protocols/SDLStreamingMediaManagerDataSource.html">SDLStreamingMediaManagerDataSource</a></span><span class="o">></span> <span class="n">dataSource</span><span class="p">;</span> - -<span class="cm">/** - Set the initial view controller your video streaming content is within. - - Activates the haptic view parser and CarWindow systems when set. This library will also use that information to attempt to return the touched view to you in `SDLTouchManagerDelegate`. - - @note If you wish to alter this `rootViewController` while streaming via CarWindow, you must set a new `rootViewController` on `SDLStreamingMediaManager` and this will update both the haptic view parser and CarWindow. - - @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 If the `rootViewController` is app UI and is set from the `UIViewController` class, it should only be set after viewDidAppear:animated is called. Setting the `rootViewController` in `viewDidLoad` or `viewWillAppear:animated` can cause weird behavior when setting the new frame. - - @warning If setting the `rootViewController` when the app returns to the foreground, the app should register for the `UIApplicationDidBecomeActive` notification and not the `UIApplicationWillEnterForeground` notification. Setting the frame after a notification from the latter can also cause weird behavior when setting the new frame. - - @warning While `viewDidLoad` will fire, appearance methods will not. - */</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">UIViewController</span> <span class="o">*</span><span class="n">rootViewController</span><span class="p">;</span> - -<span class="cm">/** - Declares if CarWindow will use layer rendering or view rendering. Defaults to layer rendering. - */</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/SDLCarWindowRenderingType.html">SDLCarWindowRenderingType</a></span> <span class="n">carWindowRenderingType</span><span class="p">;</span> - -<span class="cm">/** - When YES, the StreamingMediaManager will run a CADisplayLink with the framerate set to the video encoder settings kVTCompressionPropertyKey_ExpectedFrameRate. This then forces TouchManager (and CarWindow, if used) to sync their callbacks to the framerate. If using CarWindow, this *must* be YES. If NO, `enableSyncedPanning` on SDLTouchManager will be set to NO. 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">BOOL</span> <span class="n">enableForcedFramerateSync</span><span class="p">;</span> - -<span class="cm">/** - When YES, the StreamingMediaManager will disable its internal checks that the `rootViewController` only has one `supportedOrientation`. Having multiple orientations can cause streaming issues. If you wish to disable this check, set it to YES. 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">allowMultipleViewControllerOrientations</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">/** - Create a secure video streaming configuration. Security managers will be provided from SDLEncryptionConfiguration and the encryption flag will be set to SDLStreamingEncryptionFlagAuthenticateAndEncrypt. 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">secureConfiguration</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 rootViewController The UIViewController wih 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"><a href="Protocols/SDLStreamingMediaManagerDataSource.html">SDLStreamingMediaManagerDataSource</a></span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> <span class="nf">rootViewController</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">rootViewController</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithEncryptionFlag:videoSettings:dataSource:rootViewController: instead"</span><span class="p">);</span> - -<span class="cm">/** - Manually set all the properties to the streaming media configuration - - @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 rootViewController The UIViewController wih 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">initWithEncryptionFlag</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"><a href="Protocols/SDLStreamingMediaManagerDataSource.html">SDLStreamingMediaManagerDataSource</a></span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> <span class="nf">rootViewController</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">rootViewController</span><span class="p">;</span> - -<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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use secureConfiguration instead"</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="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use secureConfiguration 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="nf">NS_SWIFT_UNAVAILABLE</span><span class="p">(</span><span class="s">"Use the standard initializer instead"</span><span class="p">);</span> - -<span class="cm">/** - Create a CarWindow insecure configuration with a view controller - - @param initialViewController The initial view controller that will be streamed - @return The configuration - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">autostreamingInsecureConfigurationWithInitialViewController</span><span class="p">:(</span><span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">initialViewController</span><span class="p">;</span> - -<span class="cm">/** - Create a CarWindow secure configuration with a view controller and security managers - - @param securityManagers The security managers available for secure streaming use - @param initialViewController The initial view controller that will be streamed, this can be a basic `UIViewController` if you need to set your actual streaming view controller at a later time on `SDLManager.streamingManager.rootViewController`. - @return The configuration - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">autostreamingSecureConfigurationWithSecurityManagers</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="nf">initialViewController</span><span class="p">:(</span><span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">initialViewController</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use autostreamingSecureConfigurationWithInitialViewController: instead"</span><span class="p">);</span> - -<span class="cm">/** - Create a CarWindow secure configuration with a view controller. - - @param initialViewController The initial view controller that will be streamed, this can be a basic `UIViewController` if you need to set your actual streaming view controller at a later time on `SDLManager.streamingManager.rootViewController`. - @return The configuration - */</span> -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">autostreamingSecureConfigurationWithInitialViewController</span><span class="p">:(</span><span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">initialViewController</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -8940,174 +5632,13 @@ change the settings of a specific remote control module.</p> SDLStreamingMediaManager </h3> - <p>Undocumented</p> + <p>Manager to help control streaming media services.</p> <a href="Classes/SDLStreamingMediaManager.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLStreamingMediaManager</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n"><a href="Protocols/SDLStreamingAudioManagerType.html">SDLStreamingAudioManagerType</a></span><span class="o">></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">/** - * Audio Manager responsible for managing streaming audio. - */</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/SDLAudioStreamManager.html">SDLAudioStreamManager</a></span> <span class="o">*</span><span class="n">audioManager</span><span class="p">;</span> - -<span class="cm">/** - This property is used for SDLCarWindow, the ability to stream any view controller. To start, you must set an initial view controller on `SDLStreamingMediaConfiguration` `rootViewController`. After streaming begins, you can replace that view controller with a new root by placing the new view controller into this property. - */</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">nullable</span><span class="p">)</span> <span class="n">UIViewController</span> <span class="o">*</span><span class="n">rootViewController</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">/** - * The current screen resolution of the connected display in pixels. - */</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="cm">/** - When YES, the StreamingMediaManager will send a black screen with "Video Backgrounded String". 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">BOOL</span> <span class="n">showVideoBackgroundDisplay</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 This session's configuration - @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/SDLConfiguration.html">SDLConfiguration</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">SDLProtocol</span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span> - -<span class="cm">/** - * Start the audio feature of the manager. 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">startAudioWithProtocol</span><span class="p">:(</span><span class="n">SDLProtocol</span> <span class="o">*</span><span class="p">)</span><span class="nv">protocol</span><span class="p">;</span> - -<span class="cm">/** - * Start the video feature of the manager. 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">startVideoWithProtocol</span><span class="p">:(</span><span class="n">SDLProtocol</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">/** - * Stop the audio feature of 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">stopAudio</span><span class="p">;</span> - -<span class="cm">/** - * Stop the video feature of 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">stopVideo</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. - * - * NOTE: See the `.audioManager` (SDLAudioStreamManager) `pushWithData:` method for a more modern API. - * - * @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> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLStreamingMediaManager</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n"><a href="Protocols/SDLStreamingAudioManagerType.html">SDLStreamingAudioManagerType</a></span><span class="o">></span></code></pre> <h4>Swift</h4> @@ -9122,7 +5653,7 @@ change the settings of a specific remote control module.</p> <p>This class consolidates the logic of scaling between the view controller’s coordinate system and the display’s coordinate system.</p> -<p>The main goal of using scaling is to align different screens and use a common range of <q>points per inch</q>. This allows showing assets with a similar size on different screen resolutions.</p> +<p>The main goal of using scaling is to align different screens and use a common range of “points per inch”. This allows showing assets with a similar size on different screen resolutions.</p> <a href="Classes/SDLStreamingVideoScaleManager.html" class="slightly-smaller">See more</a> @@ -9142,7 +5673,7 @@ change the settings of a specific remote control module.</p> </h3> <p>Establishes a subscription to button notifications for HMI buttons. Buttons - are not necessarily physical buttons, but can also be <q>soft</q> buttons on a + are not necessarily physical buttons, but can also be “soft” buttons on a touch screen, depending on the display in the vehicle. Once subscribed to a particular button, an application will receive both SDLOnButtonEvent and SDLOnButtonPress notifications @@ -9341,14 +5872,14 @@ change the settings of a specific remote control module.</p> SDLSyncPData </h3> - <p>Undocumented</p> + <p>Allows binary data in the form of SyncP packets to be sent to the SYNC module. Binary data is in binary part of hybrid msg.</p> + +<p>*** DEPRECATED ***</p> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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> + <pre class="highlight objective_c"><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></code></pre> <h4>Swift</h4> @@ -9381,7 +5912,7 @@ change the settings of a specific remote control module.</p> SDLSystemCapability </h3> - <p>The systemCapabilityType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a <q>navigationCapability</q> should exist.</p> + <p>The systemCapabilityType indicates which type of data should be changed and identifies which data object exists in this struct. For example, if the SystemCapability Type is NAVIGATION then a “navigationCapability” should exist.</p> <p>First implemented in SDL Core v4.4</p> @@ -9421,54 +5952,15 @@ change the settings of a specific remote control module.</p> SDLSystemRequest </h3> - <p>Undocumented</p> + <p>An asynchronous request from the device; binary data can be included in hybrid part of message for some requests (such as HTTP, Proprietary, or Authentication requests)</p> + +<p>@since SmartDeviceLink 3.0</p> <a href="Classes/SDLSystemRequest.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSystemRequest</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span> - -<span class="cm">/** - Create a generic system request with a file name - - @param requestType The request type to use - @param fileName The name of the file to use - @return The request - */</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%20Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span><span class="p">)</span><span class="nv">requestType</span> <span class="nf">fileName</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">fileName</span><span class="p">;</span> - -<span class="cm">/** - Create an OEM_PROPRIETARY system request with a subtype and file name - - @param proprietaryType The proprietary requestSubType to be used - @param fileName The name of the file to use - @return The request - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithProprietaryType</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">proprietaryType</span> <span class="nf">fileName</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">fileName</span><span class="p">;</span> - -<span class="cm">/** - * The type of system request. Note that Proprietary requests should forward the binary data to the known proprietary module on the system. - * - * Required - */</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%20Definitions.html#/c:SDLRequestType.h@T@SDLRequestType">SDLRequestType</a></span> <span class="n">requestType</span><span class="p">;</span> - -<span class="cm">/** - A request subType used when the `requestType` is `OEM_SPECIFIC`. - - Optional, Max length 255 - */</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">requestSubType</span><span class="p">;</span> - -<span class="cm">/** - * Filename of HTTP data to store in predefined system staging area. - * - * Required if requestType is HTTP. PROPRIETARY requestType should ignore this parameter. - */</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">fileName</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSystemRequest</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCRequest.html">SDLRPCRequest</a></span></code></pre> <h4>Swift</h4> @@ -9483,7 +5975,7 @@ change the settings of a specific remote control module.</p> <p>Specifies what is to be spoken. This can be simply a text phrase, which SDL will speak according to its own rules. It can also be phonemes from either the Microsoft SAPI phoneme set, or from the LHPLUS phoneme set. It can also be a pre-recorded sound in WAV format (either developer-defined, or provided by the SDL platform).</p> -<p>In SDL, words, and therefore sentences, can be built up from phonemes and are used to explicitly provide the proper pronounciation to the TTS engine. For example, to have SDL pronounce the word <q>read</q> as <q>red</q>, rather than as when it is pronounced like <q>reed</q>, the developer would use phonemes to express this desired pronounciation.</p> +<p>In SDL, words, and therefore sentences, can be built up from phonemes and are used to explicitly provide the proper pronounciation to the TTS engine. For example, to have SDL pronounce the word “read” as “red”, rather than as when it is pronounced like “reed”, the developer would use phonemes to express this desired pronounciation.</p> <p>For more information about phonemes, see <a href="http://en.wikipedia.org/wiki/Phoneme"><a href="http://en.wikipedia.org/wiki/Phoneme">http://en.wikipedia.org/wiki/Phoneme</a></a>.</p> @@ -9525,33 +6017,13 @@ change the settings of a specific remote control module.</p> SDLTemplateColorScheme </h3> - <p>Undocumented</p> + <p>A color scheme for all display layout templates.</p> <a href="Classes/SDLTemplateColorScheme.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTemplateColorScheme</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">initWithPrimaryRGBColor</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">primaryColor</span> <span class="nf">secondaryRGBColor</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryColor</span> <span class="nf">backgroundRGBColor</span><span class="p">:(</span><span class="n"><a href="Classes/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">backgroundColor</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">initWithPrimaryColor</span><span class="p">:(</span><span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">primaryColor</span> <span class="nf">secondaryColor</span><span class="p">:(</span><span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryColor</span> <span class="nf">backgroundColor</span><span class="p">:(</span><span class="n">UIColor</span> <span class="o">*</span><span class="p">)</span><span class="nv">backgroundColor</span><span class="p">;</span> - -<span class="cm">/** - The "primary" color. This must always be your primary brand color. If the OEM only uses one color, this will be the color. It is recommended to the OEMs that the primaryColor should change the `mediaClockTimer` bar and the highlight color of soft buttons. - */</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/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="n">primaryColor</span><span class="p">;</span> - -<span class="cm">/** - The "secondary" color. This may be an accent or complimentary color to your primary brand color. If the OEM uses this color, they must also use the primary color. It is recommended to the OEMs that the secondaryColor should change the background color of buttons, such as soft buttons. - */</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/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="n">secondaryColor</span><span class="p">;</span> - -<span class="cm">/** - The background color to be used on the template. If the OEM does not support this parameter, assume on "dayColorScheme" that this will be a light color, and on "nightColorScheme" a dark color. You should do the same for your custom schemes. - */</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/SDLRGBColor.html">SDLRGBColor</a></span> <span class="o">*</span><span class="n">backgroundColor</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTemplateColorScheme</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -9625,56 +6097,13 @@ change the settings of a specific remote control module.</p> SDLTouch </h3> - <p>Undocumented</p> + <p>Describes a touch location</p> <a href="Classes/SDLTouch.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTouch</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -9744,103 +6173,13 @@ change the settings of a specific remote control module.</p> SDLTouchManager </h3> - <p>Undocumented</p> + <p>Touch Manager responsible for processing touch event notifications.</p> <a href="Classes/SDLTouchManager.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><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%20Definitions.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">/** - Minimum distance for a pan gesture in the head unit's coordinate system, used for registering pan callbacks. - - @note Defaults to 8 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">panDistanceThreshold</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="nf">__deprecated_msg</span><span class="p">(</span><span class="s">"This is now unused, the movement time threshold is now synced to the framerate automatically"</span><span class="p">);</span> - -<span class="cm">/** - If set to NO, the display link syncing will be ignored and `movementTimeThreshold` will be used. 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">BOOL</span> <span class="n">enableSyncedPanning</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">SDLFocusableItemHitTester</span><span class="o">></span><span class="p">)</span><span class="nv">hitTester</span> <span class="n">__deprecated_msg</span><span class="p">(</span><span class="s">"Use initWithHitTester:hitTester videoScaleManager: instead"</span><span class="p">);</span> - -<span class="cm">/** - Initialize a touch manager with a hit tester and a video scale manager. - - @param hitTester The hit tester to be used to correlate a point with a view - @param videoScaleManager The scale manager that scales from the display screen coordinate system to the app's viewport coordinate system - @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">SDLFocusableItemHitTester</span><span class="o">></span><span class="p">)</span><span class="nv">hitTester</span> <span class="nf">videoScaleManager</span><span class="p">:(</span><span class="n"><a href="Classes/SDLStreamingVideoScaleManager.html">SDLStreamingVideoScaleManager</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">videoScaleManager</span><span class="p">;</span> - -<span class="cm">/** - Called by SDLStreamingMediaManager in sync with the streaming framerate. This helps to moderate panning gestures by allowing the UI to be modified in time with the framerate. - */</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">syncFrame</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLTouchManager</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -10178,40 +6517,13 @@ See SDLSubscribeButton</p> SDLVersion </h3> - <p>Undocumented</p> + <p>Specifies a major / minor / patch version number for semantic versioning purposes and comparisons</p> <a href="Classes/SDLVersion.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVersion</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="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">NSUInteger</span> <span class="n">major</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">assign</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">minor</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">assign</span><span class="p">)</span> <span class="n">NSUInteger</span> <span class="n">patch</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">readonly</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">stringVersion</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">initWithMajor</span><span class="p">:(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="nv">major</span> <span class="nf">minor</span><span class="p">:(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="nv">minor</span> <span class="nf">patch</span><span class="p">:(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="nv">patch</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">versionWithMajor</span><span class="p">:(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="nv">major</span> <span class="nf">minor</span><span class="p">:(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="nv">minor</span> <span class="nf">patch</span><span class="p">:(</span><span class="n">NSUInteger</span><span class="p">)</span><span class="nv">patch</span><span class="p">;</span> -<span class="k">-</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">versionString</span><span class="p">;</span> -<span class="k">+</span> <span class="p">(</span><span class="n">nullable</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">versionWithString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">versionString</span><span class="p">;</span> -<span class="cp">#pragma clang diagnostic push -#pragma clang diagnostic ignored "-Wdeprecated-implementations" -</span><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSyncMsgVersion</span><span class="p">:(</span><span class="n"><a href="Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">syncMsgVersion</span> <span class="n">__deprecated_msg</span><span class="p">((</span><span class="s">"Use initWithSDLMsgVersion:sdlMsgVersion: instead"</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">versionWithSyncMsgVersion</span><span class="p">:(</span><span class="n"><a href="Classes/SDLSyncMsgVersion.html">SDLSyncMsgVersion</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">syncMsgVersion</span> <span class="n">__deprecated_msg</span><span class="p">((</span><span class="s">"Use versionWithSDLMsgVersion:sdlMsgVersion instead"</span><span class="p">));</span> -<span class="cp">#pragma clang diagnostic pop -</span><span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSDLMsgVersion</span><span class="p">:(</span><span class="n"><a href="Classes/SDLMsgVersion.html">SDLMsgVersion</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">sdlMsgVersion</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">versionWithSDLMsgVersion</span><span class="p">:(</span><span class="n"><a href="Classes/SDLMsgVersion.html">SDLMsgVersion</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">sdlMsgVersion</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">NSComparisonResult</span><span class="p">)</span><span class="nf">compare</span><span class="p">:(</span><span class="n">SDLVersion</span> <span class="o">*</span><span class="p">)</span><span class="nv">otherVersion</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">isLessThanVersion</span><span class="p">:(</span><span class="n">SDLVersion</span> <span class="o">*</span><span class="p">)</span><span class="nv">otherVersion</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">isEqualToVersion</span><span class="p">:(</span><span class="n">SDLVersion</span> <span class="o">*</span><span class="p">)</span><span class="nv">otherVersion</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">isGreaterThanVersion</span><span class="p">:(</span><span class="n">SDLVersion</span> <span class="o">*</span><span class="p">)</span><span class="nv">otherVersion</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">isGreaterThanOrEqualToVersion</span><span class="p">:(</span><span class="n">SDLVersion</span> <span class="o">*</span><span class="p">)</span><span class="nv">otherVersion</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">isLessThanOrEqualToVersion</span><span class="p">:(</span><span class="n">SDLVersion</span> <span class="o">*</span><span class="p">)</span><span class="nv">otherVersion</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVersion</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span></code></pre> <h4>Swift</h4> @@ -10262,27 +6574,13 @@ See SDLSubscribeButton</p> SDLVoiceCommand </h3> - <p>Undocumented</p> + <p>Voice commands available for the user to speak and be recognized by the IVI’s voice recognition engine.</p> <a href="Classes/SDLVoiceCommand.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVoiceCommand</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="cm">/** - The strings the user can say to activate this voice command - */</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">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="n">voiceCommands</span><span class="p">;</span> - -<span class="cm">/** - The handler that will be called when the command is activated - */</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"><a href="Type%20Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span> <span class="n">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">initWithVoiceCommands</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">voiceCommands</span> <span class="nf">handler</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLVoiceCommand.h@T@SDLVoiceCommandSelectionHandler">SDLVoiceCommandSelectionHandler</a></span><span class="p">)</span><span class="nv">handler</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVoiceCommand</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -10314,70 +6612,15 @@ See SDLSubscribeButton</p> SDLWeatherAlert </h3> - <p>Undocumented</p> + <p>Contains information about a weather alert</p> + +<p>@since RPC 5.1</p> <a href="Classes/SDLWeatherAlert.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLWeatherAlert</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init for all parameters - * - * @param title The title of the alert - * @param summary A summary for the alert - * @param expires The date the alert expires - * @param regions Regions affected - * @param severity Severity - * @param timeIssued The date the alert was issued - * @return A SDLWeatherAlert alert - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithTitle</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">title</span> <span class="nf">summary</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">summary</span> <span class="nf">expires</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">expires</span> <span class="nf">regions</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">regions</span> <span class="nf">severity</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">severity</span> <span class="nf">timeIssued</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">timeIssued</span><span class="p">;</span> - -<span class="cm">/** - * The title of the alert. - * - * String, 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">NSString</span> <span class="o">*</span><span class="n">title</span><span class="p">;</span> - -<span class="cm">/** - * A summary for the alert. - * - * String, 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">NSString</span> <span class="o">*</span><span class="n">summary</span><span class="p">;</span> - -<span class="cm">/** - * The date the alert expires. - * - * SDLDateTime, 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">expires</span><span class="p">;</span> - -<span class="cm">/** - * Regions affected. - * - * Array of Strings, Optional, minsize="1" maxsize="99" - */</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">regions</span><span class="p">;</span> - -<span class="cm">/** - * Severity of the weather alert. - * - * String, 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">NSString</span> <span class="o">*</span><span class="n">severity</span><span class="p">;</span> - -<span class="cm">/** - * The date the alert was issued. - * - * SDLDateTime, 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">timeIssued</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLWeatherAlert</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> @@ -10390,198 +6633,15 @@ See SDLSubscribeButton</p> SDLWeatherData </h3> - <p>Undocumented</p> + <p>Contains information about the current weather</p> + +<p>@since RPC 5.1</p> <a href="Classes/SDLWeatherData.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLWeatherData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span> - -<span class="cm">/** - * Convenience init for all parameters - * - * @param currentTemperature The current temperature - * @param temperatureHigh The predicted high temperature for the day - * @param temperatureLow The predicted low temperature for the day - * @param apparentTemperature The apparent temperature - * @param apparentTemperatureHigh The predicted high apparent temperature for the day - * @param apparentTemperatureLow The predicted low apparent temperature for the day - * @param weatherSummary A summary of the weather - * @param time The time this data refers to - * @param humidity From 0 to 1, percentage humidity - * @param cloudCover From 0 to 1, percentage cloud cover - * @param moonPhase From 0 to 1, percentage of the moon seen, e.g. 0 = no moon, 0.25 = quarter moon - * @param windBearing In degrees, true north at 0 degrees - * @param windGust In km/hr - * @param windSpeed In km/hr - * @param nearestStormBearing In degrees, true north at 0 degrees - * @param nearestStormDistance In km - * @param precipAccumulation In cm - * @param precipIntensity In cm of water per hour - * @param precipProbability From 0 to 1, percentage chance - * @param precipType A description of the precipitation type (e.g. "rain", "snow", "sleet", "hail") - * @param visibility In km - * @param weatherIcon The weather icon image - * @return A SDLWeatherData object - */</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithCurrentTemperature</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">currentTemperature</span> <span class="nf">temperatureHigh</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">temperatureHigh</span> <span class="nf">temperatureLow</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">temperatureLow</span> <span class="nf">apparentTemperature</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">apparentTemperature</span> <span class="nf">apparentTemperatureHigh</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">apparentTemperatureHigh</span> <span class="nf">apparentTemperatureLow</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">apparentTemperatureLow</span> <span class="nf">weatherSummary</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">weatherSummary</span> <span class="nf">time</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">time</span> <span class="nf">humidity</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">humidity</span> <span class="nf">cloudCover</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">cloudCover</span> <span class="nf">moonPhase</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">moonPhase</span> <span class="nf">windBearing</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">windBearing</span> <span class="nf">windGust</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">windGust</span> <span class="nf">windSpeed</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">windSpeed</span> <span class="nf">nearestStormBearing</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">nearestStormBearing</span> <span class="nf">nearestStormDistance</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">nearestStormDistance</span> <span class="nf">precipAccumulation</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">precipAccumulation</span> <span class="nf">precipIntensity</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">precipIntensity</span> <span class="nf">precipProbability</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">precipProbability</span> <span class="nf">precipType</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">precipType</span> <span class="nf">visibility</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">visibility</span> <span class="nf">weatherIcon</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">weatherIcon</span><span class="p">;</span> - -<span class="cm">/** - * The current temperature. - * - * 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">currentTemperature</span><span class="p">;</span> - -<span class="cm">/** - * The predicted high temperature for the day. - * - * 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">temperatureHigh</span><span class="p">;</span> - -<span class="cm">/** - * The predicted low temperature for the day. - * - * 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">temperatureLow</span><span class="p">;</span> - -<span class="cm">/** - * The apparent temperature. - * - * 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">apparentTemperature</span><span class="p">;</span> - -<span class="cm">/** - * The predicted high apparent temperature for the day. - * - * 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">apparentTemperatureHigh</span><span class="p">;</span> - -<span class="cm">/** - * The predicted low apparent temperature for the day. - * - * 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">apparentTemperatureLow</span><span class="p">;</span> - -<span class="cm">/** - * A summary of the weather. - * - * String, 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">NSString</span> <span class="o">*</span><span class="n">weatherSummary</span><span class="p">;</span> - -<span class="cm">/** - * The time this data refers to. - * - * SDLDateTime, 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">time</span><span class="p">;</span> - -<span class="cm">/** - * From 0 to 1, percentage humidity. - * - * Float, Optional, minvalue="0" maxvalue="1" - */</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">humidity</span><span class="p">;</span> - -<span class="cm">/** - * From 0 to 1, percentage cloud cover. - * - * Float, Optional, minvalue="0" maxvalue="1" - */</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">cloudCover</span><span class="p">;</span> - -<span class="cm">/** - * From 0 to 1, percentage of the moon seen, e.g. 0 = no moon, 0.25 = quarter moon - * - * Float, Optional, minvalue="0" maxvalue="1" - */</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">moonPhase</span><span class="p">;</span> - -<span class="cm">/** - * In degrees, true north at 0 degrees. - * - * Integer, 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"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">windBearing</span><span class="p">;</span> - -<span class="cm">/** - * In km/hr - * - * Float, 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"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">windGust</span><span class="p">;</span> - -<span class="cm">/** - * In km/hr - * - * Float, 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"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">windSpeed</span><span class="p">;</span> - -<span class="cm">/** - * In degrees, true north at 0 degrees. - * - * Integer, 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"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">nearestStormBearing</span><span class="p">;</span> - -<span class="cm">/** - * In km - * - * Integer, 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"><a href="Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">></span> <span class="o">*</span><span class="n">nearestStormDistance</span><span class="p">;</span> - -<span class="cm">/** - * In cm - * - * Float, 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"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">precipAccumulation</span><span class="p">;</span> - -<span class="cm">/** - * In cm of water per hour. - * - * Float, 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"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">precipIntensity</span><span class="p">;</span> - -<span class="cm">/** - * From 0 to 1, percentage chance. - * - * Float, Optional, minvalue="0" maxvalue="1" - */</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)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">precipProbability</span><span class="p">;</span> - -<span class="cm">/** - * A description of the precipitation type (e.g. "rain", "snow", "sleet", "hail") - * - * String, 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">NSString</span> <span class="o">*</span><span class="n">precipType</span><span class="p">;</span> - -<span class="cm">/** - * In km - * - * Float, 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"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="n">visibility</span><span class="p">;</span> - -<span class="cm">/** - * The weather icon image. - * - * 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">weatherIcon</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLWeatherData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLRPCStruct.html">SDLRPCStruct</a></span></code></pre> <h4>Swift</h4> |